UnliftIO.MessageBox.Limited

Thread safe queues for uni directional message passing between threads.

This message box has an upper limit, that means that sometimes delivery either fails or is blocked until the receiving thread has consumed more messages.

Use this module if the producer(s) outperform the consumer, but you want the extra safety that the queue blocks the Input after a certain message limit is reached.

If you are sure that the producers fire at a slower rate then the rate at which the consumer consumes messages, use this module.

Documentation

data MessageLimit

Message Limit

The message limit must be a reasonable small positive integer that is also a power of two. This stems from the fact that Unagi is used under the hood.

The limit is a lower bound.

Constructors

MessageLimit_1

MessageLimit_2

MessageLimit_4

MessageLimit_8

MessageLimit_16

MessageLimit_32

MessageLimit_64

MessageLimit_128

MessageLimit_256

MessageLimit_512

MessageLimit_1024

MessageLimit_2048

MessageLimit_4096

Instances

Bounded MessageLimit

Defined in UnliftIO.MessageBox.Limited

Methods

minBound :: MessageLimit

maxBound :: MessageLimit

Enum MessageLimit

Defined in UnliftIO.MessageBox.Limited

Methods

succ :: MessageLimit -> MessageLimit

pred :: MessageLimit -> MessageLimit

toEnum :: Int -> MessageLimit

fromEnum :: MessageLimit -> Int

enumFrom :: MessageLimit -> [MessageLimit]

enumFromThen :: MessageLimit -> MessageLimit -> [MessageLimit]

enumFromTo :: MessageLimit -> MessageLimit -> [MessageLimit]

enumFromThenTo :: MessageLimit -> MessageLimit -> MessageLimit -> [MessageLimit]

Eq MessageLimit

Defined in UnliftIO.MessageBox.Limited

Methods

(==) :: MessageLimit -> MessageLimit -> Bool

(/=) :: MessageLimit -> MessageLimit -> Bool

Ord MessageLimit

Defined in UnliftIO.MessageBox.Limited

Methods

compare :: MessageLimit -> MessageLimit -> Ordering

(<) :: MessageLimit -> MessageLimit -> Bool

(<=) :: MessageLimit -> MessageLimit -> Bool

(>) :: MessageLimit -> MessageLimit -> Bool

(>=) :: MessageLimit -> MessageLimit -> Bool

max :: MessageLimit -> MessageLimit -> MessageLimit

min :: MessageLimit -> MessageLimit -> MessageLimit

Show MessageLimit

Defined in UnliftIO.MessageBox.Limited

Methods

showsPrec :: Int -> MessageLimit -> ShowS

show :: MessageLimit -> String

showList :: [MessageLimit] -> ShowS

messageLimitToInt :: MessageLimit -> Int

Convert a MessageLimit to the Int representation.

newtype BlockingBoxLimit

Contains the (vague) limit of messages that a BlockingBox can buffer, i.e. that deliver can put into a BlockingInput of a BlockingBox.

Constructors

BlockingBoxLimit MessageLimit

Instances

Eq BlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

(==) :: BlockingBoxLimit -> BlockingBoxLimit -> Bool

(/=) :: BlockingBoxLimit -> BlockingBoxLimit -> Bool

Ord BlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

compare :: BlockingBoxLimit -> BlockingBoxLimit -> Ordering

(<) :: BlockingBoxLimit -> BlockingBoxLimit -> Bool

(<=) :: BlockingBoxLimit -> BlockingBoxLimit -> Bool

(>) :: BlockingBoxLimit -> BlockingBoxLimit -> Bool

(>=) :: BlockingBoxLimit -> BlockingBoxLimit -> Bool

max :: BlockingBoxLimit -> BlockingBoxLimit -> BlockingBoxLimit

min :: BlockingBoxLimit -> BlockingBoxLimit -> BlockingBoxLimit

Show BlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

showsPrec :: Int -> BlockingBoxLimit -> ShowS

show :: BlockingBoxLimit -> String

showList :: [BlockingBoxLimit] -> ShowS

IsMessageBoxArg BlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Associated Types

type MessageBox BlockingBoxLimit :: Type -> Type

Methods

getConfiguredMessageLimit :: BlockingBoxLimit -> Maybe Int

newMessageBox :: MonadUnliftIO m => BlockingBoxLimit -> m (MessageBox BlockingBoxLimit a)

type MessageBox BlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

type MessageBox BlockingBoxLimit = BlockingBox

data BlockingBox a

A message queue out of which messages can by received.

This is the counter part of Input. Can be used for reading messages.

Messages can be received by receive or tryReceive.

Instances

IsMessageBox BlockingBox

A blocking instance that invokes receive.

Defined in UnliftIO.MessageBox.Limited

Associated Types

type Input BlockingBox :: Type -> Type

Methods

receive :: MonadUnliftIO m => BlockingBox a -> m (Maybe a)

tryReceive :: MonadUnliftIO m => BlockingBox a -> m (Future a)

receiveAfter :: MonadUnliftIO m => BlockingBox a -> Int -> m (Maybe a)

newInput :: MonadUnliftIO m => BlockingBox a -> m (Input BlockingBox a)

type Input BlockingBox

Defined in UnliftIO.MessageBox.Limited

type Input BlockingBox = BlockingInput

data BlockingInput a

A message queue into which messages can be enqued by, e.g. tryToDeliver. Messages can be received from an BlockingBox.

The Input is the counter part of a BlockingBox.

Instances

IsInput BlockingInput

A blocking instance that invokes deliver.

Defined in UnliftIO.MessageBox.Limited

Methods

deliver :: MonadUnliftIO m => BlockingInput a -> a -> m Bool

deliver_ :: MonadUnliftIO m => BlockingInput a -> a -> m ()

newtype NonBlockingBoxLimit

A BlockingBoxLimit wrapper for non-blocking IsMessageBoxArg instances.

Constructors

NonBlockingBoxLimit MessageLimit

Instances

Eq NonBlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

(==) :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> Bool

(/=) :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> Bool

Ord NonBlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

compare :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> Ordering

(<) :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> Bool

(<=) :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> Bool

(>) :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> Bool

(>=) :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> Bool

max :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> NonBlockingBoxLimit

min :: NonBlockingBoxLimit -> NonBlockingBoxLimit -> NonBlockingBoxLimit

Show NonBlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

showsPrec :: Int -> NonBlockingBoxLimit -> ShowS

show :: NonBlockingBoxLimit -> String

showList :: [NonBlockingBoxLimit] -> ShowS

IsMessageBoxArg NonBlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Associated Types

type MessageBox NonBlockingBoxLimit :: Type -> Type

Methods

getConfiguredMessageLimit :: NonBlockingBoxLimit -> Maybe Int

newMessageBox :: MonadUnliftIO m => NonBlockingBoxLimit -> m (MessageBox NonBlockingBoxLimit a)

type MessageBox NonBlockingBoxLimit

Defined in UnliftIO.MessageBox.Limited

type MessageBox NonBlockingBoxLimit = NonBlockingBox

data NonBlockingBox a

A BlockingBox wrapper for non-blocking IsMessageBox instances.

The difference to the BlockingBox instance is that deliver immediately returns if the message box limit is surpassed.

Instances

IsMessageBox NonBlockingBox

Defined in UnliftIO.MessageBox.Limited

Associated Types

type Input NonBlockingBox :: Type -> Type

Methods

receive :: MonadUnliftIO m => NonBlockingBox a -> m (Maybe a)

tryReceive :: MonadUnliftIO m => NonBlockingBox a -> m (Future a)

receiveAfter :: MonadUnliftIO m => NonBlockingBox a -> Int -> m (Maybe a)

newInput :: MonadUnliftIO m => NonBlockingBox a -> m (Input NonBlockingBox a)

type Input NonBlockingBox

Defined in UnliftIO.MessageBox.Limited

type Input NonBlockingBox = NonBlockingInput

newtype NonBlockingInput a

A wrapper around BlockingInput with a non-blocking IsInput instance.

deliver will enqueue the message or return False immediately, if the message box already contains more messages than it's limit allows.

Constructors

NonBlockingInput (BlockingInput a)

Instances

IsInput NonBlockingInput

Defined in UnliftIO.MessageBox.Limited

Methods

deliver :: MonadUnliftIO m => NonBlockingInput a -> a -> m Bool

deliver_ :: MonadUnliftIO m => NonBlockingInput a -> a -> m ()

data WaitingBoxLimit

A IsMessageBoxArg instance wrapping the BlockingBox with independently configurable timeouts for receive and deliver.

Constructors

WaitingBoxLimit !(Maybe Int) !Int !MessageLimit

Instances

Eq WaitingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

(==) :: WaitingBoxLimit -> WaitingBoxLimit -> Bool

(/=) :: WaitingBoxLimit -> WaitingBoxLimit -> Bool

Ord WaitingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

compare :: WaitingBoxLimit -> WaitingBoxLimit -> Ordering

(<) :: WaitingBoxLimit -> WaitingBoxLimit -> Bool

(<=) :: WaitingBoxLimit -> WaitingBoxLimit -> Bool

(>) :: WaitingBoxLimit -> WaitingBoxLimit -> Bool

(>=) :: WaitingBoxLimit -> WaitingBoxLimit -> Bool

max :: WaitingBoxLimit -> WaitingBoxLimit -> WaitingBoxLimit

min :: WaitingBoxLimit -> WaitingBoxLimit -> WaitingBoxLimit

Show WaitingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Methods

showsPrec :: Int -> WaitingBoxLimit -> ShowS

show :: WaitingBoxLimit -> String

showList :: [WaitingBoxLimit] -> ShowS

IsMessageBoxArg WaitingBoxLimit

Defined in UnliftIO.MessageBox.Limited

Associated Types

type MessageBox WaitingBoxLimit :: Type -> Type

Methods

getConfiguredMessageLimit :: WaitingBoxLimit -> Maybe Int

newMessageBox :: MonadUnliftIO m => WaitingBoxLimit -> m (MessageBox WaitingBoxLimit a)

type MessageBox WaitingBoxLimit

Defined in UnliftIO.MessageBox.Limited

type MessageBox WaitingBoxLimit = WaitingBox

data WaitingBox a

A BlockingBox an a WaitingBoxLimit for the IsMessageBox instance.

Constructors

WaitingBox WaitingBoxLimit (BlockingBox a)

Instances

IsMessageBox WaitingBox

Defined in UnliftIO.MessageBox.Limited

Associated Types

type Input WaitingBox :: Type -> Type

Methods

receive :: MonadUnliftIO m => WaitingBox a -> m (Maybe a)

tryReceive :: MonadUnliftIO m => WaitingBox a -> m (Future a)

receiveAfter :: MonadUnliftIO m => WaitingBox a -> Int -> m (Maybe a)

newInput :: MonadUnliftIO m => WaitingBox a -> m (Input WaitingBox a)

type Input WaitingBox

Defined in UnliftIO.MessageBox.Limited

type Input WaitingBox = WaitingInput

data WaitingInput a

An input for a BlockingBox that will block for not much more than the given timeout when the message box is full.

Constructors

WaitingInput !Int !(BlockingInput a)

Instances

IsInput WaitingInput

Defined in UnliftIO.MessageBox.Limited

Methods

deliver :: MonadUnliftIO m => WaitingInput a -> a -> m Bool

deliver_ :: MonadUnliftIO m => WaitingInput a -> a -> m ()