package eio

  1. Overview
  2. Docs
package eio
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Private.Single_waiterSource

Allows a single fiber to wait to be notified by another fiber in the same domain. If multiple fibers need to wait at once, or the notification comes from another domain, this can't be used.

Sourcetype 'a t

A handle representing a fiber that might be sleeping. It is either in the Running or Sleeping state.

Sourceval create : unit -> 'a t

create () is a new waiter, initially in the Running state.

Sourceval wake : 'a t -> ('a, exn) result -> bool

wake t v resumes t's fiber with value v and returns true if it was sleeping. If t is Running then this just returns false.

Sourceval wake_if_sleeping : unit t -> unit

wake_if_sleeping is ignore (wake t (Ok ())).

Sourceval await : 'a t -> string -> int -> 'a

await t op id suspends the calling fiber, changing t's state to Sleeping. If the fiber is cancelled, a cancel exception is raised. op and id are used for tracing.

Sourceval await_protect : 'a t -> string -> int -> 'a

await_protect is like await, but the sleep cannot be cancelled.

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