package async_unix

  1. Overview
  2. Docs
package async_unix
Legend:
Library
Module
Module type
Parameter
Class
Class type

A set of busy-poll functions.

See Scheduler.add_busy_poller for the user-level interface.

type t
include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
include Async_unix.Import.Invariant.S with type t := t
val invariant : t -> unit
val create : unit -> t

create () creates a new empty set.

val is_empty : t -> bool
val add : t -> (unit -> [ `Stop_polling of 'a | `Continue_polling ]) -> 'a Async_unix.Import.Deferred.t

add t f adds function f to the set t. f will run every time poll is called. f runs with the same execution context that was in effect when add was called. When poll is called and f returns `Stop_polling, the result of add becomes determined and f is removed from the set. Also, if f raises, it is removed from the set and the exception is sent to the monitor in effect when add was called,

val poll : t -> unit

poll t runs every function in the set t.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct