Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package moonpool
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Abstract runner.
This provides an abstraction for running tasks in the background.
type t = private {run_async : task -> unit;shutdown : wait:bool -> unit -> unit;size : unit -> int;num_tasks : unit -> int;
}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).
val size : t -> intNumber of threads/workers.
val num_tasks : t -> intCurrent number of tasks. This is at best a snapshot, useful for metrics and debugging.
val shutdown : t -> unitShutdown the runner and wait for it to terminate. Idempotent.
val shutdown_without_waiting : t -> unitShutdown 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.
val run_wait_block : t -> (unit -> 'a) -> 'arun_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).
module For_runner_implementors : sig ... end