Streamly.Internal.Data.Fold.Concurrent.Channel.Type

Documentation

data Channel m a b

Constructors

Channel

Fields

• outputQueue :: IORef ([ChildEvent a], Int)
• maxBufferLimit :: Limit
• outputDoorBell :: MVar ()
• readOutputQ :: m [ChildEvent a]
• outputQueueFromConsumer :: IORef ([ChildEvent b], Int)
• outputDoorBellFromConsumer :: MVar ()
• bufferSpaceDoorBell :: MVar ()
• svarRef :: Maybe (IORef ())
• svarStats :: SVarStats
• svarInspectMode :: Bool
• svarCreator :: ThreadId

newChannel :: MonadRunInIO m => (Config -> Config) -> Fold m a b -> m (Channel m a b)

data Config

An abstract type for specifying the configuration parameters of a Channel. Use Config -> Config modifier functions to modify the default configuration. See the individual modifier documentation for default values.

sendToWorker :: MonadAsync m => Channel m a b -> a -> m (Maybe b)

Push values from a driver to a fold worker via a Channel. Before pushing a value to the Channel it polls for events received from the fold worker. If a stop event is received then it returns True otherwise false. Propagates exceptions received from the fold wroker.

checkFoldStatus :: MonadAsync m => Channel m a b -> m (Maybe b)

Poll for events sent by the fold worker to the fold driver. The fold consumer can send a Stop event or an exception. When a Stop is received this function returns True. If an exception is recieved then it throws the exception.

dumpSVar :: Channel m a b -> IO String