package core_extended

  1. Overview
  2. Docs
package core_extended
Legend:
Library
Module
Module type
Parameter
Class
Class type

Semaphores

  • author Markus Mottl <mmottl\@janestreet.com>
type 'a t

Type of semaphores

val init : 'a option -> 'a t

init v initializes a semaphore with an optional value v. If it is Some x, then Semaphore.wait will return immediately with x, otherwise it will block until Semaphore.signal is called.

val signal : 'a t -> 'a -> unit

signal sem v allows one thread blocked in Semaphore.wait on semaphore sem to continue. The semaphore will then block again further threads.

val wait : 'a t -> 'a

wait sem blocks the calling thread on semaphore sem if it was not initialized with Some x or not signalled before. The semaphore is reset to None, i.e. calling wait again will block unless the semaphore was signalled inbetween.

val get : 'a t -> 'a option

get sem

  • returns

    None if semaphore is not set, Some value otherwise. The semaphore is reset to None, and a subsequent wait will block again.

val look : 'a t -> 'a option

look sem

  • returns

    None if semaphore is not set, Some value otherwise. The state of the semaphore remains unchanged.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct