Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package picos_aux
Lock-free multi-producer, single-consumer queue.
🏎️ This data structure is optimized for use as the ready queue of a fair (i.e. FIFO) single-threaded scheduler.
API
val create : ?padded:bool -> unit -> 'a tcreate () returns a new empty multi-producer, single-consumer queue.
Interface for producers
ℹ️ The operations in this section can be called by both any number of producers and the single owner / consumer of the queue.
val push : 'a t -> 'a -> unitpush queue value adds the value to the tail of the queue.
val push_head : 'a t -> 'a -> unitpush_head queue value adds the value to the head of the queue.
Interface for the owner / consumer
⚠️ The operations in this section should only be called by the single owner / consumer of the queue.
Raised by pop_exn in case it finds the queue empty.
val pop_exn : 'a t -> 'apop_exn queue tries to remove the value at the head of the queue. Returns the removed value or raises Empty in case the queue was empty.
val pop_all : 'a t -> 'a Stdlib.Seq.tpop_all queue removes all values from the queue and returns them as a sequence.
Examples
An example top-level session:
# let q : int Picos_aux_mpscq.t =
Picos_aux_mpscq.create ()
val q : int Picos_aux_mpscq.t = <abstr>
# Picos_aux_mpscq.push q 42
- : unit = ()
# Picos_aux_mpscq.push_head q 76
- : unit = ()
# Picos_aux_mpscq.push q 101
- : unit = ()
# Picos_aux_mpscq.pop_exn q
- : int = 76
# Picos_aux_mpscq.pop_all q |> List.of_seq
- : int list = [42; 101]