package moonpool

You can search for identifiers within the package.

in-package search v0.2.0

moonpool
- Library moonpool
  - Moonpool
    
    Ws_pool
    
    For_runner_implementors
    
    Fifo_pool
    
    For_runner_implementors
    
    Background_thread
    
    For_runner_implementors
    
    Runner
    
    For_runner_implementors
    
    Immediate_runner
    
    Exn_bt
    
    Lock
    
    Fut
    
    Advanced
    
    Infix
    
    Infix_local
    
    Chan
    
    Task_local_storage
    
    Direct
    
    Thread_local_storage
    
    Blocking_queue
    
    Bounded_queue
    
    Atomic
- Library moonpool.dpool
  - Moonpool_dpool
- Library moonpool.fib
  - Moonpool_fib
    
    Fiber
    
    Fls
    
    Direct
    
    Handle
    
    Set
    
    Map
    
    Main
- Library moonpool.forkjoin
  - Moonpool_forkjoin
- Library moonpool.private
  - Moonpool_private
    
    Atomic_
    
    Dla_
    
    Domain_
    
    Thread_local_storage_
    
    Tracing_
    
    Ws_deque_
- Sources
  - moonpool
    
    background_thread.ml
    
    bb_queue.ml
    
    bounded_queue.ml
    
    chan.ml
    
    exn_bt.ml
    
    fifo_pool.ml
    
    fut.ml
    
    lock.ml
    
    moonpool.ml
    
    moonpool__.ml
    
    runner.ml
    
    suspend_.ml
    
    task_local_storage.ml
    
    ws_pool.ml
  - moonpool.dpool
    
    moonpool_dpool.ml
  - moonpool.fib
    
    fiber.ml
    
    fls.ml
    
    handle.ml
    
    main.ml
    
    moonpool_fib.ml
    
    moonpool_fib__.ml
  - moonpool.forkjoin
    
    moonpool_forkjoin.ml
  - moonpool.private
    
    atomic_.ml
    
    dla_.ml
    
    domain_.ml
    
    moonpool_private.ml
    
    thread_local_storage_.ml
    
    tracing_.ml
    
    ws_deque_.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Moonpool.Background_thread`Source

A simple runner with a single background thread.

Because this is guaranteed to have a single worker thread, tasks scheduled in this runner always run asynchronously but in a sequential fashion.

This is similar to Fifo_pool with exactly one thread.

since 0.6

include module type of Runner

Sourcetype task = unit -> unit

Sourcetype t

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).

Sourceval size : t -> int

Number of threads/workers.

Sourceval num_tasks : t -> int

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

Sourceval shutdown : t -> unit

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

Sourceval shutdown_without_waiting : t -> unit

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

Sourceexception Shutdown

Sourceval run_async : ?ls:Task_local_storage.t -> t -> task -> unit

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 ls
if provided, run the task with this initial local storage

raises Shutdown
if the runner was shut down before run_async was called.

Sourceval run_wait_block : ?ls:Task_local_storage.t -> t -> (unit -> 'a) -> 'a

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

Sourceval dummy : t

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

since 0.6

Implementing runners

Sourcemodule For_runner_implementors : sig ... end

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

Sourceval get_current_runner : unit -> t option

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

since 0.5

Sourceval get_current_storage : unit -> Task_local_storage.t option

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

Source

type ('a, 'b) create_args =
  ?on_init_thread:(dom_id:int -> t_id:int -> unit -> unit) ->
  ?on_exit_thread:(dom_id:int -> t_id:int -> unit -> unit) ->
  ?on_exn:(exn -> Printexc.raw_backtrace -> unit) ->
  ?around_task:((t -> 'b) * (t -> 'b -> unit)) ->
  ?name:string ->
  'a

Arguments used in create. See create for explanations.

Sourceval create : (unit -> t, _) create_args

Create the background runner

Sourceval with_ : (unit -> (t -> 'a) -> 'a, _) create_args

package moonpool

Module Moonpool.Background_threadSource

Implementing runners

Module `Moonpool.Background_thread`Source