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.8.1.tbz

sha256=c4222f9b081465486a1c1a8dde6aa00178936d7c7b3a8565e0883a421e0e3547

sha512=d63d8b9500b492be93df4f29159aa6955588ca1e35e6a5817856e32ee4fec3395604dc7b64fc5a973ee8bd436bd65831e7b08fca9bf909f41afec4a65c4443b8

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.