package eio

You can search for identifiers within the package.

in-package search v0.2.0

Effect-based direct-style IO API for OCaml

Install

Dune Dependency

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

Authors

Maintainers

A

anil@recoil.org

Sources

eio-0.14.tbz

sha256=52f85b947d3e0de70940b5bbaac0d3e78841fea5648e73af7d8a754ab51c871b

sha512=944095b1131d2dcc1f0d415fe46fd78b883733e0f95985e3a0feafe73b1703606ec60560abf36c16c364cc60164b7330f236e39569e264c702bb5647e28bfd3c

doc/eio.utils/Eio_utils/Zzz/index.html

Module `Eio_utils.Zzz`Source

A set of timers.

Sourcemodule Key : sig ... end

A handle to a registered timer.

Sourcetype t

A set of timers (implemented as a priority queue).

Sourceval create : unit -> t

create () is a fresh empty queue.

Sourceval add : t -> Mtime.t -> unit Suspended.t -> Key.t

add t time thread adds a new event, due at time, and returns its ID. You must use Eio.Private.Fiber_context.set_cancel_fn on thread before calling pop. Your cancel function should call remove (in addition to resuming thread).

Sourceval remove : t -> Key.t -> unit

remove t key removes an event previously added with add.

Source

val pop : 
  t ->
  now:Mtime.t ->
  [ `Due of unit Suspended.t | `Wait_until of Mtime.t | `Nothing ]

pop ~now t removes and returns the earliest thread due by now. It also clears the thread's cancel function. If no thread is due yet, it returns the time the earliest thread becomes due.