On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package containers-thread
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Blocking Queue
This queue has a limited size. Pushing a value on the queue when it is full will block.
val create : int -> 'a tCreate a new queue of size n. Using n=max_int amounts to using an infinite queue (2^61 items is a lot to fit in memory); using n=1 amounts to using a box with 0 or 1 elements inside.
val push : 'a t -> 'a -> unitpush q x pushes x into q, blocking if the queue is full.
val take : 'a t -> 'aTake the first element, blocking if needed.
val push_list : 'a t -> 'a list -> unitPush items of the list, one by one.
val take_list : 'a t -> int -> 'a listtake_list n q takes n elements out of q.
val try_take : 'a t -> 'a optionTake the first element if the queue is not empty, return None otherwise.
val try_push : 'a t -> 'a -> booltry_push q x pushes x into q if q is not full, in which case it returns true. If it fails because q is full, it returns false.
val peek : 'a t -> 'a optionpeek q returns Some x if x is the first element of q, otherwise it returns None.
val size : _ t -> intNumber of elements currently in the queue.
val capacity : _ t -> intNumber of values the queue can hold.
On This Page