network-mux

Safe Haskell	None
Language	Haskell2010

Network.Mux.Bearer.AttenuatedChannel

Contents

Trace
Utils

Synopsis

data AttenuatedChannel (m :: Type -> Type) = AttenuatedChannel {
- acRead :: m ByteString
- acWrite :: ByteString -> m ()
- acClose :: m ()
}
type Size = Int64
data SuccessOrFailure
- = Success
- | Failure IOError
data Attenuation = Attenuation {
- aReadAttenuation :: Time -> Size -> (DiffTime, SuccessOrFailure)
- aWriteAttenuation :: Maybe Int
}
newConnectedAttenuatedChannelPair :: forall (m :: Type -> Type). (MonadDelay m, MonadLabelledSTM m, MonadTimer m, MonadThrow m, MonadThrow (STM m)) => Tracer m AttenuatedChannelTrace -> Tracer m AttenuatedChannelTrace -> Attenuation -> Attenuation -> STM m (AttenuatedChannel m, AttenuatedChannel m)
attenuationChannelAsBearer :: forall (m :: Type -> Type). (MonadThrow m, MonadMonotonicTime m) => SDUSize -> DiffTime -> Tracer m Trace -> AttenuatedChannel m -> Bearer m
data AttenuatedChannelTrace
- = AttChannLocalClose Bool
- | AttChannRemoteClose
resourceVanishedIOError :: String -> String -> IOError

Documentation

data AttenuatedChannel (m :: Type -> Type) Source #

An AttenuatedChannel supports:

attenuation applied after reading a message from QueueChannel;
two-way close handshake with 120s timeout. Read side is closed as soon as an internal MsgClose is received, write side has to be closed explicitly.

Constructors

AttenuatedChannel
Fields acRead :: m ByteString acWrite :: ByteString -> m () acClose :: m ()

type Size = Int64 Source #

data SuccessOrFailure Source #

Constructors

Success
Failure IOError

data Attenuation Source #

Attenuation of a channel.

Constructors

Attenuation
Fields aReadAttenuation :: Time -> Size -> (DiffTime, SuccessOrFailure) aWriteAttenuation :: Maybe Int

newConnectedAttenuatedChannelPair :: forall (m :: Type -> Type). (MonadDelay m, MonadLabelledSTM m, MonadTimer m, MonadThrow m, MonadThrow (STM m)) => Tracer m AttenuatedChannelTrace -> Tracer m AttenuatedChannelTrace -> Attenuation -> Attenuation -> STM m (AttenuatedChannel m, AttenuatedChannel m) Source #

Create a pair of connected AttenuatedChannels.

attenuationChannelAsBearer :: forall (m :: Type -> Type). (MonadThrow m, MonadMonotonicTime m) => SDUSize -> DiffTime -> Tracer m Trace -> AttenuatedChannel m -> Bearer m Source #

Trace

data AttenuatedChannelTrace Source #

Constructors

AttChannLocalClose Bool
AttChannRemoteClose

Instances

Instances details

Show AttenuatedChannelTrace Source #
Instance details Defined in Network.Mux.Bearer.AttenuatedChannel Methods showsPrec :: Int -> AttenuatedChannelTrace -> ShowS # show :: AttenuatedChannelTrace -> String # showList :: [AttenuatedChannelTrace] -> ShowS #

Utils

resourceVanishedIOError :: String -> String -> IOError Source #