package moonpool

  1. Overview
  2. Docs
Pools of threads supported by a pool of domains

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (11)

Authors

  1. S
    Simon Cruanes

Maintainers

  1. S
    Simon Cruanes

Sources

moonpool-0.7.tbz
sha256=c4a1f974200530ab7f6014de3a369fdbb260ff454183640f32e51ba3fec51b15
sha512=865daabb96e3d60f88ecee9fc9030dad8b257fff4121b404e882d8a8d6687b737beb6e22366f52eb14e770dfab28b326853a1d3d883fa19bbd791d8450b40f8b

doc/moonpool.sync/Moonpool_sync/Lock/index.html

Module Moonpool_sync.LockSource

Mutex-protected resource.

This lock is a synchronous concurrency primitive, as a thin wrapper around Mutex that encourages proper management of the critical section in RAII style:

  let (let@) = (@@)


  …
  let compute_foo =
    (* enter critical section *)
    let@ x = Lock.with_ protected_resource in
    use_x;
    return_foo ()
    (* exit critical section *)
  in
  …

This lock is based on Picos_sync.Mutex so it is await-safe.

  • since 0.7
Sourcetype 'a t

A value protected by a cooperative mutex

Sourceval create : 'a -> 'a t

Create a new protected value.

Sourceval with_ : 'a t -> ('a -> 'b) -> 'b

with_ l f runs f x where x is the value protected with the lock l, in a critical section. If f x fails, with_lock l f fails too but the lock is released.

Sourceval update : 'a t -> ('a -> 'a) -> unit

update l f replaces the content x of l with f x, while protected by the mutex.

Sourceval update_map : 'a t -> ('a -> 'a * 'b) -> 'b

update_map l f computes x', y = f (get l), then puts x' in l and returns y, while protected by the mutex.

Underlying mutex.

Sourceval get : 'a t -> 'a

Atomically get the value in the lock. The value that is returned isn't protected!

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

Atomically set the value.

NOTE caution: using get and set as if this were a ref is an anti pattern and will not protect data against some race conditions.