-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Concurrent bouded blocking queues optimized for flushing. Both IO and STM implementations.
--   
--   Please see the README on GitHub at
--   <a>https://github.com/fpco/flush-queue#readme</a>
@package flush-queue
@version 1.0.0


-- | 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.
module Control.Concurrent.BFQueue

-- | 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..
data BFQueue a

-- | Create new empty BFQueue
newBFQueue :: Natural -> IO (BFQueue a)

-- | <i>O(1)</i> - Push an element onto the queue. Will block if maximum
--   bound has been reached.
writeBFQueue :: BFQueue a -> a -> IO ()

-- | <i>O(1)</i> - Try to push an element onto the queue without blocking.
--   Will return <a>True</a> if element was pushed successfully, and
--   <a>False</a> in case when the queue is full.
tryWriteBFQueue :: BFQueue a -> a -> IO Bool

-- | <i>O(i)</i> - Take <tt>i</tt> elements from the queue, unblock all the
--   possible writers and return all the elements from the queue in FIFO
--   order.
takeBFQueue :: Natural -> BFQueue a -> IO [a]

-- | <i>O(n)</i> - Flush the queue, unblock all the possible writers and
--   return all the elements from the queue in FIFO order.
flushBFQueue :: BFQueue a -> IO [a]

-- | <i>O(1)</i> - Extract number of elements that is currently on the
--   queue
lengthBFQueue :: BFQueue a -> IO Natural

-- | <i>O(1)</i> - Check if queue is empty
isEmptyBFQueue :: BFQueue a -> IO Bool


-- | Transactional Bouded Flush Queue is a very similar to <a>BFQueue</a>,
--   with an exception that it runs in <a>STM</a> and is also less
--   efficient, but is still faster than <a>TBQueue</a>.
module Control.Concurrent.STM.TBFQueue

-- | Bounded Flush Queue. It's a queue that allows pushing elements onto,
--   popping elements from it, but is mostly optimizied for flushing the
--   queue or taking in bulk.
data TBFQueue a

-- | Construct a new empty Flush Bounded Queue
newTBFQueue :: Natural -> STM (TBFQueue a)

-- | Construct a new empty Flush Bounded Queue inside IO monad.
newTBFQueueIO :: Natural -> IO (TBFQueue a)

-- | <i>O(1)</i> - Push an element onto the queue. Will block if maximum
--   bound has been reached.
writeTBFQueue :: TBFQueue a -> a -> STM ()

-- | <i>O(1)</i> - Try to push an element onto the queue without blocking.
--   Will return <a>True</a> if element was pushed successfully, and
--   <a>False</a> in case when the queue is full.
tryWriteTBFQueue :: TBFQueue a -> a -> STM Bool

-- | <i>Amortized O(1)</i> - Pop an element from the queue. Will block if
--   queue is empty.
readTBFQueue :: TBFQueue a -> STM a

-- | <i>O(i)</i> - Take <tt>i</tt> elements from the queue, unblock all the
--   possible writers and return all the elements from the queue in FIFO
--   order.
takeTBFQueue :: Natural -> TBFQueue a -> STM [a]

-- | <i>O(n)</i> - Flush the queue, unblock all the possible writers and
--   return all the elements from the queue in FIFO order.
flushTBFQueue :: TBFQueue a -> STM [a]

-- | <i>O(1)</i> - Extract number of elements that is currently on the
--   queue
lengthTBFQueue :: TBFQueue a -> STM Natural

-- | <i>O(1)</i> - Check if queue is empty
isEmptyTBFQueue :: TBFQueue a -> STM Bool