package ocaml-base-compiler

  1. Overview
  2. Docs
Official release 5.0.0

Install

Dune Dependency

Authors

Maintainers

Sources

5.0.0.tar.gz
sha256=72fa3d0ba19b82fcb9e6c62e0090b9d22e5905c4be0f94faf56904a9377a9e5b

doc/stdlib/Stdlib/Atomic/index.html

Module Stdlib.AtomicSource

Atomic references.

See 'Memory model: The hard bits' chapter in the manual.

  • since 4.12
Sourcetype !'a t

An atomic (mutable) reference to a value of type 'a.

Sourceval make : 'a -> 'a t

Create an atomic reference.

Sourceval get : 'a t -> 'a

Get the current value of the atomic reference.

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

Set a new value for the atomic reference.

Sourceval exchange : 'a t -> 'a -> 'a

Set a new value for the atomic reference, and return the current value.

Sourceval compare_and_set : 'a t -> 'a -> 'a -> bool

compare_and_set r seen v sets the new value of r to v only if its current value is physically equal to seen -- the comparison and the set occur atomically. Returns true if the comparison succeeded (so the set happened) and false otherwise.

Sourceval fetch_and_add : int t -> int -> int

fetch_and_add r n atomically increments the value of r by n, and returns the current value (before the increment).

Sourceval incr : int t -> unit

incr r atomically increments the value of r by 1.

Sourceval decr : int t -> unit

decr r atomically decrements the value of r by 1.

OCaml

Innovation. Community. Security.