Module

Concurrent.BoundedQueue

A concurrent FIFO data structure with bounded capacity.

This datastructure is useful in various consumer/producer situations.

newtype BoundedQueue a

new :: forall eff a. Int -> Aff (avar :: AVAR | eff) (BoundedQueue a)

Creates a new BoundedQueue with the given capacity,

write :: forall eff a. BoundedQueue a -> a -> Aff (avar :: AVAR | eff) Unit

Writes an element to the given queue. Will block if the queue is full until someone reads from it.

read :: forall eff a. BoundedQueue a -> Aff (avar :: AVAR | eff) a

Reads an element from the given queue, will block if the queue is empty, until someone writes to it.

isEmpty :: forall eff a. BoundedQueue a -> Aff (avar :: AVAR | eff) Boolean

Checks whether the given queue is empty. Never blocks.

tryRead :: forall eff a. BoundedQueue a -> Aff (avar :: AVAR | eff) (Maybe a)

Attempts to read an element from the given queue. If the queue is empty, returns Nothing.

Careful! If other readers are blocked on the queue tryRead will also block.

tryWrite :: forall eff a. BoundedQueue a -> a -> Aff (avar :: AVAR | eff) Boolean

Attempts to write an element into the given queue. If the queue is full, returns false otherwise true.

Careful! If other writers are blocked on the queue tryWrite will also block.