package picos

You can search for identifiers within the package.

in-package search v0.2.0

Pico scheduler interface

Install

Dune Dependency

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

Authors

V

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

Maintainers

V

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

Sources

picos-0.4.0.tbz

sha256=343a8b4759239ca0c107145b8e2cc94c14625fecc0b0887d3c40a9ab7537b8da

sha512=db22b0a5b3adc603c0e815c9011c779f892b9ace76be018b2198d3e24a7d96727c999701025fe5a5fd07d0b452cb7286fc50c939aba0e4dce809941e9ebc12a6

doc/picos.structured/Picos_structured/Promise/index.html

Module `Picos_structured.Promise`Source

A cancelable promise.

ℹ️ In addition to using a promise to concurrently compute and return a value, a cancelable promise can also represent a concurrent fiber that will continue until it is explicitly canceled.

Sourcetype !'a t

Represents a promise to return value of type 'a.

Sourceval of_value : 'a -> 'a t

of_value value returns a constant completed promise that returns the given value.

ℹ️ Promises can also be created in the scope of a Bundle.

Sourceval await : 'a t -> 'a

await promise awaits until the promise has completed and either returns the value that the evaluation of the promise returned, raises the exception that the evaluation of the promise raised, or raises the Terminate exception in case the promise has been canceled.

Sourceval is_running : 'a t -> bool

is_running promise determines whether the completion of the promise is still pending.

Sourceval try_terminate : ?callstack:int -> 'a t -> bool

try_terminate promise tries to terminate the promise by canceling it with the Terminate exception and returns true in case of success and false in case the promise had already completed, i.e. either returned, raised, or canceled.

Sourceval terminate : ?callstack:int -> 'a t -> unit

terminate promise is equivalent to try_terminate promise |> ignore.