package picos

  1. Overview
  2. Docs
Pico scheduler interface

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (5)

Authors

  1. V
    Vesa Karvonen <vesa.a.j.k@gmail.com>

Maintainers

  1. V
    Vesa Karvonen <vesa.a.j.k@gmail.com>

Sources

picos-0.4.0.tbz
sha256=343a8b4759239ca0c107145b8e2cc94c14625fecc0b0887d3c40a9ab7537b8da
sha512=db22b0a5b3adc603c0e815c9011c779f892b9ace76be018b2198d3e24a7d96727c999701025fe5a5fd07d0b452cb7286fc50c939aba0e4dce809941e9ebc12a6

doc/picos.sync/Picos_sync/Condition/index.html

Module Picos_sync.ConditionSource

A condition implementation for Picos.

ℹ️ This intentionally mimics the interface of Stdlib.Condition. Unlike with the standard library condition variable, blocking on this condition variable allows an effects based scheduler to run other fibers on the thread.

Sourcetype t

Represents a condition variable.

Sourceval create : ?padded:bool -> unit -> t

create () return a new condition variable.

Sourceval wait : t -> Mutex.t -> unit

wait condition unlocks the mutex, waits for the condition, and locks the mutex before returning or raising due to the operation being canceled.

ℹ️ If the fiber has been canceled and propagation of cancelation is allowed, this may raise the cancelation exception.

Sourceval signal : t -> unit

signal condition wakes up one fiber waiting on the condition variable unless there are no such fibers.

Sourceval broadcast : t -> unit

broadcast condition wakes up all the fibers waiting on the condition variable.