package moonpool

A runner.

If a runner is no longer needed, shutdown can be used to signal all worker threads in it to stop (after they finish their work), and wait for them to stop.

The threads are distributed across a fixed domain pool (whose size is determined by Domain.recommended_domain_count on OCaml 5, and simple the single runtime on OCaml 4).

Number of threads/workers.

Current number of tasks. This is at best a snapshot, useful for metrics and debugging.

Shutdown the runner and wait for it to terminate. Idempotent.

Shutdown the pool, and do not wait for it to terminate. Idempotent.

run_async pool f schedules f for later execution on the runner in one of the threads. f() will run on one of the runner's worker threads/domains.

• parameter fiber

  if provided, run the task with this initial fiber data

• raises Shutdown

  if the runner was shut down before run_async was called.

run_wait_block pool f schedules f for later execution on the pool, 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.

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

Runner that fails when scheduling tasks on it. Calling run_async on it will raise Failure.

• since 0.6

This module is specifically intended for users who implement their own runners. Regular users of Moonpool should not need to look at it.

Access the current runner. This returns Some r if the call happens on a thread that belongs in a runner.

• since 0.5

get_current_storage runner gets the local storage for the currently running task.