Aws.Kinesis.Client.Internal.Queue

Documentation

class BoundedCloseableQueue q α | q -> α where

A signature for bounded, closeable queues.

Minimal complete definition

newQueue, closeQueue, writeQueue, tryWriteQueue, readQueue, takeQueueTimeout, isEmptyQueue, isClosedQueue

Methods

newQueue

Arguments

:: Natural

the size n of the queue

-> IO q

closeQueue :: q -> IO ()

writeQueue :: q -> α -> IO Bool

Returns False if and only if the queue is closed. If the queue is full this function shall block.

tryWriteQueue :: q -> α -> IO (Maybe Bool)

Non-blocking version of writeQueue. Returns Nothing if the queue was full. Otherwise it returns 'Just True' if the value was successfully written and 'Just False' if the queue was closed.

readQueue :: q -> IO (Maybe α)

Returns Nothing if and only if the queue is closed. If this queue is empty this function blocks.

takeQueueTimeout

Arguments

:: q

-> Natural

the number of items n to take

-> Natural

the timeout t in microseconds

-> IO [α]

Take up to n items from the queue with a timeout of t.

isEmptyQueue :: q -> IO Bool

Whether the queue is empty.

isClosedQueue :: q -> IO Bool

Whether the queue is closed.

isClosedAndEmptyQueue :: q -> IO Bool

Whether the queue is empty and closed. The trivial default implementation may be overridden with one which provides transactional guarantees.

Instances

BoundedCloseableQueue (TBMChan a) a

BoundedCloseableQueue (TBMQueue a) a