Control.Concurrent.EQueue.Class

This module provides the core abstractions that represent managers for queueable events.

Documentation

class EQueue eq where

An EQueue is a way of managing edge and level triggered events. The choice of EQueue implementation allows late binding of the policy by which the application processes events.

Methods

registerSemi :: (MonadIO m, Semigroup b) => eq a -> (b -> a) -> m (b -> IO (), IO ())

Registers a level triggered event. These are the events that accumulate a combined change or resulting state. Returns a function to enqueue updates and unregister this event.

registerQueued :: MonadIO m => eq a -> m (a -> IO (), IO ())

Registers an edge triggered event. Returns a function to enqueue updates and unregister this event.

Instances

EQueue STMEQueue

Defined in Control.Concurrent.EQueue.STMEQueue

Methods

registerSemi :: (MonadIO m, Semigroup b) => STMEQueue a -> (b -> a) -> m (b -> IO (), IO ())

registerQueued :: MonadIO m => STMEQueue a -> m (a -> IO (), IO ())

EQueue ForceEdge

Defined in Control.Concurrent.EQueue

Methods

registerSemi :: (MonadIO m, Semigroup b) => ForceEdge a -> (b -> a) -> m (b -> IO (), IO ())

registerQueued :: MonadIO m => ForceEdge a -> m (a -> IO (), IO ())

EQueue AnyEQueue

Defined in Control.Concurrent.EQueue

Methods

registerSemi :: (MonadIO m, Semigroup b) => AnyEQueue a -> (b -> a) -> m (b -> IO (), IO ())

registerQueued :: MonadIO m => AnyEQueue a -> m (a -> IO (), IO ())

EQueue IOEQueue

Defined in Control.Concurrent.EQueue.Simple

Methods

registerSemi :: (MonadIO m, Semigroup b) => IOEQueue a -> (b -> a) -> m (b -> IO (), IO ())

registerQueued :: MonadIO m => IOEQueue a -> m (a -> IO (), IO ())

EQueue TQueueEQueue

Can not unregister events

Defined in Control.Concurrent.EQueue.Simple

Methods

registerSemi :: (MonadIO m, Semigroup b) => TQueueEQueue a -> (b -> a) -> m (b -> IO (), IO ())

registerQueued :: MonadIO m => TQueueEQueue a -> m (a -> IO (), IO ())

EQueue TChanEQueue

Can not unregister events

Defined in Control.Concurrent.EQueue.Simple

Methods

registerSemi :: (MonadIO m, Semigroup b) => TChanEQueue a -> (b -> a) -> m (b -> IO (), IO ())

registerQueued :: MonadIO m => TChanEQueue a -> m (a -> IO (), IO ())

EQueue ChanEQueue

Can not unregister events

Defined in Control.Concurrent.EQueue.Simple

Methods

registerSemi :: (MonadIO m, Semigroup b) => ChanEQueue a -> (b -> a) -> m (b -> IO (), IO ())

registerQueued :: MonadIO m => ChanEQueue a -> m (a -> IO (), IO ())

EQueue eq => EQueue (MappedEQueue eq b)

Defined in Control.Concurrent.EQueue

Methods

registerSemi :: (MonadIO m, Semigroup b0) => MappedEQueue eq b a -> (b0 -> a) -> m (b0 -> IO (), IO ())

registerQueued :: MonadIO m => MappedEQueue eq b a -> m (a -> IO (), IO ())

class EQueueW eq where

An EQueueW is the interface for waiting on events in a queue.

Associated Types

type WaitPolicy eq :: *

The WaitPolicy allows control per-call of waitEQ as to which policy is followed. For example, if it should return immediately if there are no events to dequeue or if it should wait for at least one event to be available.

Methods

waitEQ :: MonadIO m => eq a -> WaitPolicy eq -> m [a]

The dequeue operation, collecting some set of available events, depending on the particular policy the given EQueue impliments.

Instances

EQueueW STMEQueue

Defined in Control.Concurrent.EQueue.STMEQueue

Associated Types

type WaitPolicy STMEQueue :: Type

Methods

waitEQ :: MonadIO m => STMEQueue a -> WaitPolicy STMEQueue -> m [a]

EQueueW TQueueEQueue

Defined in Control.Concurrent.EQueue.Simple

Associated Types

type WaitPolicy TQueueEQueue :: Type

Methods

waitEQ :: MonadIO m => TQueueEQueue a -> WaitPolicy TQueueEQueue -> m [a]

EQueueW TChanEQueue

Defined in Control.Concurrent.EQueue.Simple

Associated Types

type WaitPolicy TChanEQueue :: Type

Methods

waitEQ :: MonadIO m => TChanEQueue a -> WaitPolicy TChanEQueue -> m [a]

EQueueW ChanEQueue

Defined in Control.Concurrent.EQueue.Simple

Associated Types

type WaitPolicy ChanEQueue :: Type

Methods

waitEQ :: MonadIO m => ChanEQueue a -> WaitPolicy ChanEQueue -> m [a]