package moonpool

You can search for identifiers within the package.

in-package search v0.2.0

package moonpool

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_fib.Fls`Source

Fiber-local storage.

This storage is associated to the current fiber, just like thread-local storage is associated with the current thread.

See Moonpool.Task_local_storage for more general information, as this is based on it.

NOTE: it's important to note that, while each fiber has its own storage, spawning a sub-fiber f2 from a fiber f1 will only do a shallow copy of the storage. Values inside f1's storage will be physically shared with f2. It is thus recommended to store only persistent values in the local storage.

include module type of struct include Moonpool.Task_local_storage end

Sourcetype t = Moonpool__.Types_.local_storage

Underlying storage for a task. This is mutable and not thread-safe.

Sourceval dummy : t

Sourcetype 'a key = 'a Moonpool.Task_local_storage.key

A key used to access a particular (typed) storage slot on every task.

Sourceval new_key : init:(unit -> 'a) -> unit -> 'a key

new_key ~init () makes a new key. Keys are expensive and should never be allocated dynamically or in a loop. The correct pattern is, at toplevel:

  let k_foo : foo Task_ocal_storage.key =
    Task_local_storage.new_key ~init:(fun () -> make_foo ()) ()

(* … *)

(* use it: *)
let … = Task_local_storage.get k_foo

Sourceval get : 'a key -> 'a

get k gets the value for the current task for key k. Must be run from inside a task running on a runner.

raises Failure
otherwise

Sourceval get_opt : 'a key -> 'a option

get_opt k gets the current task's value for key k, or None if not run from inside the task.

Sourceval set : 'a key -> 'a -> unit

set k v sets the storage for k to v. Must be run from inside a task running on a runner.

raises Failure
otherwise

Sourceval with_value : 'a key -> 'a -> (unit -> 'b) -> 'b

with_value k v f sets k to v for the duration of the call to f(). When f() returns (or fails), k is restored to its old value.

Sourceval get_current : unit -> t option

Access the current storage, or None if not run from within a task.

Sourcemodule Direct = Moonpool.Task_local_storage.Direct

Direct access to values from a storage handle

package moonpool

Module Moonpool_fib.FlsSource

Module `Moonpool_fib.Fls`Source