package algaeff

  1. Overview
  2. Docs

Module Mutex.MakeSource

The implementation of mutex effects. Make is generative so that one can use multiple mutexes at the same time.

The signature of mutex effects.

Parameters

Signature

Sourceexception Locked

The exception raised by exclusively if the mutex was locked.

Sourceval exclusively : (unit -> 'a) -> 'a

exclusively f locks the mutex, run the thunk f, and then unlock the mutex. If the mutex was already locked, exclusively f immediately raises Locked without waiting. Note that calling exclusively inside f is an instance of attempting to lock an already locked mutex.

  • raises Locked

    The mutex was already locked.

Sourceval run : (unit -> 'a) -> 'a

run f executes the thunk f which may perform mutex effects. Each call of run creates a fresh mutex; in particular, calling run inside the thunk f will start a new scope that does not interfere with the outer scope.