package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-18.0.tar.gz
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

doc/octez-libs.stdlib/Tezos_stdlib/Lwt_idle_waiter/index.html

Module Tezos_stdlib.Lwt_idle_waiterSource

Sourcetype t

A lightweight scheduler to run tasks concurrently as well as special callbacks that must be run in mutual exclusion with the tasks (and each other).

Sourceval create : unit -> t

Creates a new task / idle callback scheduler

Sourceval task : t -> (unit -> 'a Lwt.t) -> 'a Lwt.t

Schedule a task to be run as soon as no idle callback is running, or as soon as the next idle callback has been run if it was scheduled by force_idle.

Sourceval when_idle : t -> (unit -> 'a Lwt.t) -> 'a Lwt.t

Runs a callback as soon as no task is running. Does not prevent new tasks from being scheduled, the calling code should ensure that some idle time will eventually come. Calling this function from inside the callback will result in a dead lock.

Sourceval force_idle : t -> (unit -> 'a Lwt.t) -> 'a Lwt.t

Runs a callback as soon as possible. Lets all current tasks finish, but postpones all new tasks until the end of the callback. Calling this function from inside the callback will result in a dead lock.

OCaml

Innovation. Community. Security.