package picos_std

  1. Overview
  2. Docs
Sample libraries for Picos

Install 

dune-project
 Dependency

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

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.6.0.tbz
sha256=3f5a08199cf65c2dae2f7d68f3877178f1da8eabf5376e15114e5a8958087dfa
sha512=ad24910c47ce614268c4268874bb918da7f8b5f03b3ad706bbf30323635262e94ddab6be24eaebbca706bfa82c0a517d4272b396459e020c185942125c9bdb7b

doc/picos_std.awaitable/Picos_std_awaitable/Awaitable/Awaiter/index.html

Module Awaitable.AwaiterSource

Low level interface for more flexible waiting.

Sourcetype 'a awaitable := 'a t

An erased type alias for Awaitable.t.

Sourcetype t

Represents a single use awaiter of a signal to an awaitable.

Sourceval add : 'a awaitable -> Picos.Trigger.t -> t

add awaitable trigger creates a single use awaiter, adds it to the FIFO associated with the awaitable, and returns the awaiter.

Sourceval remove : t -> unit

remove awaiter marks the awaiter as having been signaled and removes it from the FIFO associated with the awaitable.

ℹ️ If the associated trigger is used with only one awaiter and the Trigger.awaitawait on the trigger returns None, there is no need to explicitly remove the awaiter, because it has already been removed.