package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (13)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

batteries-3.11.0.tar.gz
md5=096be9e83e347b4c7b5b6e5b2af22992
sha512=621dca842c4a7adf0ac1e907bf44c1405e0b66a088987a138a4f4e98ca744815913bf87fd780619151cb049a07d7fdb1e8adb7b65698ab46b8c2dfe46cd7119d

doc/batteries/BatMutex/index.html

Module BatMutexSource

Locks for mutual exclusion.

Mutexes (mutual-exclusion locks) are used to implement critical sections and protect shared mutable data structures against concurrent accesses. The typical use is (if m is the mutex associated with the data structure D):

  Mutex.synchronize ~lock:m (fun () ->
    (* Critical section that operates over D *);
  ) ()

This module implements Control.Concurrency.Common

  • author Xavier Leroy (Base module)
  • author Damien Doligez (Base module)
  • author David Teller
Sourceval synchronize : ?lock:Mutex.t -> ('a -> 'b) -> 'a -> 'b

Protect a function.

synchronize f returns a new function f' with the same behavior as f but such that concurrent calls to f' are queued if necessary to avoid races.

synchronize ~lock:l f behaves as synchronize f but uses a user-specified lock l, which may be useful to share a lock between several function. This is necessary in particular when the lock is specific to a data structure rather than to a function.

In either case, the lock is acquired when entering the function and released when the function call ends, whether this is due to normal termination or to some exception being raised.

Sourceval make : unit -> BatConcurrent.lock

Create a new abstract lock based on Mutexes.