package miou

  1. Overview
  2. Docs
Composable concurrency primitives for OCaml

Install

dune-project
 Dependency

Authors

Maintainers

Sources

miou-0.4.0.tbz
sha256=d9ae52113d923f2425a1375c594f4accf61171780af1ef211dbbba38ff51dacf
sha512=f114d1d4b1ff0c7bbe74adbb2fa65a7343064a14ea252b8ae5dbd98c209b3c1d56f2e360422ea8e5cd2656a6f50cb10ae262b0c4e6681724803dd6e8eb1d1653

doc/miou/Miou/Mutex/index.html

Module Miou.MutexSource

Sourcetype t

The type of mutexes.

Sourceval create : unit -> t

Return a new mutex.

Sourceval unlock : t -> unit

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

  • raises Sys_error

    was not raised when unlocking an unlocked mutex or when unlocking a mutex from a different task.

Sourceval lock : t -> unit

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

Sourceval try_lock : t -> bool

Same as 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 protect : t -> (unit -> 'a) -> 'a

protect t fn runs fn in a critical section where t is locked (atomically); it then takes care of releasing t whether fn returned a value or raised an exception.

The unlocking operation is guaranteed to always takes place, even in the event a cancellation is ordered by the parent task.

OCaml

Innovation. Community. Security.