A value surrounded with a lock

Create a new protected value.

with_lock l f runs f x where x is the value protected with the lock l, in a critical section. If f x fails, with_lock l f fails too but the lock is released.

try_with_lock l f runs f x in a critical section if l is not locked. x is the value protected by the lock l. If f x fails, try_with_lock l f fails too but the lock is released.

• since 0.22

Type allowing to manipulate the lock as a reference.

with_lock_as_ref l f calls f with a reference-like object that allows to manipulate the value of l safely. The object passed to f must not escape the function call.

• since 0.13

update l f replaces the content x of l with f x, atomically.

update_map l f computes x', y = f (get l), then puts x' in l and returns y.

• since 0.16

Underlying mutex.

Atomically get the value in the lock. The value that is returned isn't protected!

Atomically set the value.

• since 0.13

Atomically increment the value.

• since 0.13

Atomically decrement the value.

• since 0.13

incr_then_get x increments x, and returns its new value.

• since 0.16

get_then_incr x increments x, and returns its previous value.

• since 0.16

decr_then_get x decrements x, and returns its new value.

• since 0.16

get_then_decr x decrements x, and returns its previous value.

• since 0.16

get_then_set b sets b to true, and returns the old value.

• since 0.16

get_then_clear b sets b to false, and returns the old value.

• since 0.16