Work-stealing thread pool.

A simple thread pool in FIFO order.

A simple runner with a single background thread.

Interface for runners.

Triggers from picos

Main thread.

Runner that runs tasks in the caller thread.

Exception with backtrace.

Exception raised when trying to run tasks on runners that have been shut down.

• since 0.6

Similar to Thread.create, but it picks a background domain at random to run the thread. This ensures that we don't always pick the same domain to run all the various threads needed in an application (timers, event loops, etc.)

run_async runner task schedules the task to run on the given runner. This means task() will be executed at some point in the future, possibly in another thread.

• parameter fiber

  optional initial (picos) fiber state

• since 0.5

run_wait_block runner f schedules f for later execution on the runner, like run_async. It then blocks the current thread until f() is done executing, and returns its result. If f() raises an exception, then run_wait_block pool f will raise it as well.

See run_async for more details.

NOTE be careful with deadlocks (see notes in Fut.wait_block about the required discipline to avoid deadlocks).

• raises Shutdown

  if the runner was already shut down

• since 0.6

Number of threads recommended to saturate the CPU. For IO pools this makes little sense (you might want more threads than this because many of them will be blocked most of the time).

• since 0.5

spawn ~on f runs f() on the runner (a thread pool typically) and returns a future result for it. See Fut.spawn.

• since 0.5

See Fut.spawn_on_current_runner.

• since 0.5

See Runner.get_current_runner

• since 0.7

Await a future, must be run on a moonpool runner. See Await. Only on OCaml >= 5.0.

• since 0.5

Yield from the current task, must be run on a moonpool runner. Only on OCaml >= 5.0.

• since 0.9

Mutex-protected resource.

Futures.

Channels.

Task-local storage.

A simple blocking queue.

Atomic values.