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-project

Dependency

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

Authors

Maintainers

A

anil@recoil.org

Sources

eio-1.3.tbz

sha256=8ed5c13e6689f31c85dca5f12762d84b8cc0042a7b07d3e464df6eb4b72b3dfc

sha512=46e8f817f32c3316e7f35835a136ad177a295b3306351eb2efa2386482b0169a5b19ed2925b32da2a1f10d40f083fe3d588dd401908f9fec6e4a44cd68535204

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

Module `Eio_utils.Lf_queue`Source

A lock-free multi-producer, single-consumer, thread-safe queue without support for cancellation. This makes a good data structure for a scheduler's run queue.

Sourcetype 'a t

A queue of items of type 'a.

Sourceexception Closed

Sourceval create : unit -> 'a t

create () is a new empty queue.

Sourceval push : 'a t -> 'a -> unit

push t x adds x to the tail of the queue. This can be used safely by multiple producer domains, in parallel with the other operations.

raises Closed
if t is closed.

Sourceval push_head : 'a t -> 'a -> unit

push_head t x inserts x at the head of the queue. This can only be used by the consumer (if run in parallel with pop, the item might be skipped).

raises Closed
if t is closed and empty.

Sourceval pop : 'a t -> 'a option

pop t removes the head item from t and returns it. Returns None if t is currently empty.

raises Closed
if t has been closed and is empty.

Sourceval is_empty : 'a t -> bool

is_empty t is true if calling pop would return None.

raises Closed
if t has been closed and is empty.

Sourceval close : 'a t -> unit

close t marks t as closed, preventing any further items from being pushed.