package picos

  1. Overview
  2. Docs

Module Picos_mpsc_queueSource

Multi-producer, single-consumer queue.

🏎️ This data structure is optimized for use as a scheduler's ready queue.

Sourcetype !'a t

A multi-producer, single-consumer queue.

Sourceval create : unit -> 'a t

create () returns a new empty multi-producer, single-consumer queue.

Interface for producers

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

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.

⚠️ This should only be called by the owner / consumer of the queue.

  • raises Empty

    in case the queue was empty.