package ocaml-base-compiler

You can search for identifiers within the package.

in-package search v0.2.0

Official release 5.0.0

Install

Dune Dependency

ocaml.org Edit opam file Versions (66)

Authors

Xavier Leroy

Maintainers

Sources

5.0.0.tar.gz

sha256=72fa3d0ba19b82fcb9e6c62e0090b9d22e5905c4be0f94faf56904a9377a9e5b

doc/stdlib/Stdlib/Mutex/index.html

Module `Stdlib.Mutex`Source

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.lock m;
  (* Critical section that operates over D *);
  Mutex.unlock m

Sourcetype t

The type of mutexes.

Sourceval create : unit -> t

Return a new mutex.

Sourceval lock : t -> unit

Lock the given mutex. Only one thread can have the mutex locked at any time. A thread that attempts to lock a mutex already locked by another thread will suspend until the other thread unlocks the mutex.

raises Sys_error
if the mutex is already locked by the thread calling Mutex.lock.

before 4.12
Sys_error was not raised for recursive locking (platform-dependent behaviour)

Sourceval try_lock : t -> bool

Same as Mutex.lock, but does not suspend the calling thread if the mutex is already locked: just return false immediately in that case. If the mutex is unlocked, lock it and return true.

Sourceval unlock : t -> unit

Unlock the given mutex. Other threads suspended trying to lock the mutex will restart. The mutex must have been previously locked by the thread that calls Mutex.unlock.

raises Sys_error
if the mutex is unlocked or was locked by another thread.

before 4.12
Sys_error was not raised when unlocking an unlocked mutex or when unlocking a mutex from a different thread.