Control.Concurrent.BFQueue

Bouded Flush Queue is a very efficient queue that supports pushing elements concurrently, but has no support for popping elements from the queue. The only way to get elements from the queue is to flush it and get all the elements in FIFO order.

Documentation

data BFQueue a

Bounded Flush Queue. It's a queue that allows pushing elements onto, but popping elements is not an option. Only flushing or non-blocking taking from the queue will make space for new elements and unlbock any concurrent writers..

newBFQueue :: Natural -> IO (BFQueue a)

Create new empty BFQueue

writeBFQueue :: BFQueue a -> a -> IO ()

O(1) - Push an element onto the queue. Will block if maximum bound has been reached.

tryWriteBFQueue :: BFQueue a -> a -> IO Bool

O(1) - Try to push an element onto the queue without blocking. Will return True if element was pushed successfully, and False in case when the queue is full.

takeBFQueue :: Natural -> BFQueue a -> IO [a]

O(i) - Take i elements from the queue, unblock all the possible writers and return all the elements from the queue in FIFO order.

flushBFQueue :: BFQueue a -> IO [a]

O(n) - Flush the queue, unblock all the possible writers and return all the elements from the queue in FIFO order.

lengthBFQueue :: BFQueue a -> IO Natural

O(1) - Extract number of elements that is currently on the queue

isEmptyBFQueue :: BFQueue a -> IO Bool

O(1) - Check if queue is empty