Network.Mux.Trace · network-mux-0.11.0.0

Exceptions

2 declarations

datadata Error

#

Enumeration of error conditions.

Constructors

UnknownMiniProtocol MiniProtocolNum
returned by decodeSDUHeader, thrown by Bearer.
BearerClosed String
thrown by Bearer when received a null byte.
IngressQueueOverRun MiniProtocolNum MiniProtocolDir
thrown by demux when violating maximumIngressQueue byte limit.
InitiatorOnly MiniProtocolNum
thrown when data arrives on a responder channel when the mux was set up as an InitiatorApp.
IOException IOException String
IOException thrown by
SDUDecodeError String
return by decodeSDUHeader, thrown by Bearer.
SDUReadTimeout
thrown when reading of a single SDU takes too long
SDUWriteTimeout
thrown when writing a single SDU takes too long
Shutdown (Maybe SomeException) Status
Result of runMiniProtocol's completionAction in case of an error or mux being closed while a mini-protocol was still running, this is not a clean exit.

Instances2Show, Exception

Show ErrorDefined in network-mux-0.11.0.0 · Network.Mux.Trace
Exception ErrorDefined in network-mux-0.11.0.0 · Network.Mux.Trace

valuehandleIOException :: MonadThrow m => String -> IOException -> m a

#

Handler for IOExceptions which wraps them in Error.

It is used various Bearer implementations: * socketAsBearer * pipeAsBearer

Trace events

3 declarations

datadata Trace

#

High-level mux events.

Instances1Show

Show TraceDefined in network-mux-0.11.0.0 · Network.Mux.Trace

datadata ChannelTrace

#

Mid-level channel events traced independently by each mini protocol job.

Constructors

Instances1Show

Show ChannelTraceDefined in network-mux-0.11.0.0 · Network.Mux.Trace

datadata BearerTrace

#

Low-level bearer trace tags (these are not traced by the tracer which is passed to Mux).

Instances1Show

Show BearerTraceDefined in network-mux-0.11.0.0 · Network.Mux.Types

Tracers

11 declarations

datadata Tracers' (m :: Type -> Type) (f :: Type -> Type)

#

Bundle of tracers used directly by mux.

Constructors

Tracers
- tracer :: Tracer m (f Trace)
  high-level tracer of mux state events
- channelTracer :: Tracer m (f ChannelTrace)
  channel tracer
- bearerTracer :: Tracer m (f BearerTrace)
  high-frequency tracer

patternpattern TracersI :: Monad m => Tracer m Trace -> Tracer m ChannelTrace -> Tracer m BearerTrace -> Tracers m

#

A convenient bidirectional pattern synonym which (un)wraps the Identity functor in the Tracer type.

valuetracer_ :: Monad m => Tracers m -> Tracer m Trace

#

valuechannelTracer_ :: Monad m => Tracers m -> Tracer m ChannelTrace

#

valuebearerTracer_ :: Monad m => Tracers m -> Tracer m BearerTrace

#

valuecontramapTracers'

:: Monad m
=> forall x. f' x -> f x
-> Tracers' m f
-> Tracers' m f'

#

Contravariant natural transformation of Tracers m`.

typetype Tracers (m :: Type -> Type) = Tracers' m Identity

#

valuenullTracers :: Monad m => Tracers' m f

#

valuetracersWith :: (forall x. Tracer m x) -> Tracers' m f

#

Trace all events through one polymorphic tracer.

typetype TracersWithBearer connId (m :: Type -> Type) = Tracers' m (WithBearer connId)

#

valuetracersWithBearer

:: Monad m
=> peerId
-> TracersWithBearer peerId m
-> Tracers m

#

Tracing wrappers

2 declarations

datadata WithBearer peerid a

#

Type used for tracing mux events.

Constructors

WithBearer
- wbPeerId :: !peerid
  A tag that should identify a specific mux bearer.
- wbEvent :: !a

Instances3Show, Generic, Rep

(Show peerid, Show a) => Show (WithBearer peerid a)Defined in network-mux-0.11.0.0 · Network.Mux.Trace
Generic (WithBearer peerid a)Defined in network-mux-0.11.0.0 · Network.Mux.Trace
type Rep (WithBearer peerid a) = D1 ('MetaData "WithBearer" "Network.Mux.Trace" "network-mux-0.11.0.0-HTPTgbnoxBEJogkIsdugRg" 'False) (C1 ('MetaCons "WithBearer" 'PrefixI 'True) (S1 ('MetaSel ('Just "wbPeerId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 peerid) :*: S1 ('MetaSel ('Just "wbEvent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))Defined in network-mux-0.11.0.0 · Network.Mux.Trace

datadata TraceLabelPeer peerid a

#

A peer label for use in Tracers. This annotates tracer output as being associated with a given peer identifier.

Constructors

TraceLabelPeer peerid a

Instances4Bifunctor, Functor, Eq, Show

Bifunctor TraceLabelPeerDefined in network-mux-0.11.0.0 · Network.Mux.Trace
Functor (TraceLabelPeer peerid)Defined in network-mux-0.11.0.0 · Network.Mux.Trace
(Eq peerid, Eq a) => Eq (TraceLabelPeer peerid a)Defined in network-mux-0.11.0.0 · Network.Mux.Trace
(Show peerid, Show a) => Show (TraceLabelPeer peerid a)Defined in network-mux-0.11.0.0 · Network.Mux.Trace

State

1 declaration

datadata State

#

Constructors

Mature
`Mux started ingress, and egress threads
Dead
Mux is being shutdown.

Instances2Eq, Show

Eq StateDefined in network-mux-0.11.0.0 · Network.Mux.Trace
Show StateDefined in network-mux-0.11.0.0 · Network.Mux.Trace