UnliftIO.MessageBox.Unlimited

Thread safe queues for message passing between many concurrent processes.

This message box is UNLIMITED.

Good single producer/single consumer performance

If you are sure that the producer(s) send messages at a lower rate than the rate at which the consumer consumes messages, use this module.

Otherwise use the more conservative UnliftIO.MessageBox.Limited module.

Documentation

data BlockingUnlimited

The (empty) configuration for creating UnlimitedBoxes using the IsMessageBoxArg methods.

Constructors

BlockingUnlimited

Instances

Show BlockingUnlimited

Defined in UnliftIO.MessageBox.Unlimited

Methods

showsPrec :: Int -> BlockingUnlimited -> ShowS

show :: BlockingUnlimited -> String

showList :: [BlockingUnlimited] -> ShowS

IsMessageBoxArg BlockingUnlimited

Defined in UnliftIO.MessageBox.Unlimited

Associated Types

type MessageBox BlockingUnlimited :: Type -> Type

Methods

getConfiguredMessageLimit :: BlockingUnlimited -> Maybe Int

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

type MessageBox BlockingUnlimited

Defined in UnliftIO.MessageBox.Unlimited

type MessageBox BlockingUnlimited = UnlimitedBox

data UnlimitedBox 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 UnlimitedBox

A blocking instance that invokes receive.

Defined in UnliftIO.MessageBox.Unlimited

Associated Types

type Input UnlimitedBox :: Type -> Type

Methods

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

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

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

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

type Input UnlimitedBox

Defined in UnliftIO.MessageBox.Unlimited

type Input UnlimitedBox = UnlimitedBoxInput

data UnlimitedBoxInput a

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

The UnlimitedBoxInput is the counter part of a UnlimitedBox.

Instances

IsInput UnlimitedBoxInput

A blocking instance that invokes deliver.

Defined in UnliftIO.MessageBox.Unlimited

Methods

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

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