package picos_aux

  1. Overview
  2. Docs

Module Picos_aux_mpscqSource

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

Sourcetype !'a t

A multi-producer, single-consumer queue.

Sourceval create : ?padded:bool -> unit -> 'a t

create () 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.

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

push queue value adds the value to the tail of the queue.

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

push_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.

Sourceexception Empty

Raised by pop_exn in case it finds the queue empty.

Sourceval pop_exn : 'a t -> 'a

pop_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.

  • raises Empty

    in case the queue was empty.

Sourceval pop_all : 'a t -> 'a Seq.t

pop_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]