package picos

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

Multi-producer, single-consumer queue.

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

type !'a t

A multi-producer, single-consumer queue.

val create : unit -> 'a t

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

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

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

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

push_head queue value adds the value to the head of the queue.

exception Empty

Raised by pop_exn in case it finds the queue empty.

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