package picos

  1. Overview
  2. Docs
Pico scheduler framework

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.1.0.tbz
sha256=0f2dcc67ddd127c68f388f2c36a8725a15723e6aeba7d1ddfcf4e016b54a4674
sha512=bee2a99458a451be285e2f13cc3a9deda8eed4e118bcdfc51c256d2da5bae92eec3386c318fe42dcf451421543b519dc064967158b3f417c9b7b44ce97c5fb75

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.