package eio

  1. Overview
  2. Docs
Effect-based direct-style IO API for OCaml

Install 

dune-project
 Dependency

github.com Edit opam file Versions (20)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.4.tbz
sha256=ba11ad486f492130dbb486f2b3bdc4905643f10016806ddf86e9a34e4346aaa5
sha512=57ef2c137ccdc26d8029e636b6a4ee92da7c6b2f35954946bd56ca595d6947a8ec42f6f83f8552f73d6719e6ce2314cae2e2fad1686a387522935e6f90e9a8d9

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

Module Eio_utils.Lf_queueSource

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.

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.