Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Mux.Trace

Synopsis

data MuxError = MuxError {
- errorType ∷ !MuxErrorType
- errorMsg ∷ !String
}
data MuxErrorType
- = MuxUnknownMiniProtocol
- | MuxDecodeError
- | MuxBearerClosed
- | MuxIngressQueueOverRun
- | MuxInitiatorOnly
- | MuxIOException IOException
- | MuxSDUReadTimeout
- | MuxSDUWriteTimeout
- | MuxShutdown !(Maybe MuxErrorType)
- | MuxCleanShutdown
handleIOException ∷ MonadThrow m ⇒ String → IOException → m a
data MuxTrace
data MuxBearerState
- = Mature
- | Dead
data WithMuxBearer peerid a = WithMuxBearer {
- wmbPeerId ∷ !peerid
- wmbEvent ∷ !a
}
data TraceLabelPeer peerid a = TraceLabelPeer peerid a

Documentation

data MuxError Source #

Error type used in across the mux layer.

Constructors

MuxError
Fields errorType ∷ !MuxErrorType errorMsg ∷ !String

Instances

Instances details

Exception MuxError Source #
Instance details Defined in Network.Mux.Trace Methods toException ∷ MuxError → SomeException Source # fromException ∷ SomeException → Maybe MuxError Source # displayException ∷ MuxError → String Source #
Generic MuxError Source #
Instance details Defined in Network.Mux.Trace Associated Types type Rep MuxError ∷ Type → Type Source # Methods from ∷ MuxError → Rep MuxError x Source # to ∷ Rep MuxError x → MuxError Source #
Show MuxError Source #
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → MuxError → ShowS Source # show ∷ MuxError → String Source # showList ∷ [MuxError] → ShowS Source #
type Rep MuxError Source #
Instance details Defined in Network.Mux.Trace type Rep MuxError = D1 ('MetaData "MuxError" "Network.Mux.Trace" "network-mux-0.4.0.0-inplace" 'False) (C1 ('MetaCons "MuxError" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MuxErrorType) :*: S1 ('MetaSel ('Just "errorMsg") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)))

data MuxErrorType Source #

Enumeration of error conditions.

Constructors

MuxUnknownMiniProtocol	returned by `decodeMuxSDUHeader`, thrown by `MuxBearer`.
MuxDecodeError	return by `decodeMuxSDUHeader`, thrown by `MuxBearer`.
MuxBearerClosed	thrown by `MuxBearer` when received a null byte.
MuxIngressQueueOverRun	thrown by `demux` when violating `maximumIngressQueue` byte limit.
MuxInitiatorOnly	thrown when data arrives on a responder channel when the mux was set up as an `InitiatorApp`.
MuxIOException IOException	`IOException` thrown by
MuxSDUReadTimeout	thrown when reading of a single SDU takes too long
MuxSDUWriteTimeout	thrown when writing a single SDU takes too long
MuxShutdown !(Maybe MuxErrorType)	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.
MuxCleanShutdown	Mux stopped by `stopMux`

Instances

Instances details

Show MuxErrorType Source #
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → MuxErrorType → ShowS Source # show ∷ MuxErrorType → String Source # showList ∷ [MuxErrorType] → ShowS Source #
Eq MuxErrorType Source #
Instance details Defined in Network.Mux.Trace Methods (==) ∷ MuxErrorType → MuxErrorType → Bool Source # (/=) ∷ MuxErrorType → MuxErrorType → Bool Source #

handleIOException ∷ MonadThrow m ⇒ String → IOException → m a Source #

Handler for IOExceptions which wraps them in MuxError.

It is used various MuxBearer implementations: * socketAsMuxBearer * pipeAsMuxBearer

data MuxTrace Source #

Enumeration of Mux events that can be traced.

Constructors

MuxTraceRecvHeaderStart
MuxTraceRecvHeaderEnd MuxSDUHeader
MuxTraceRecvDeltaQObservation MuxSDUHeader Time
MuxTraceRecvDeltaQSample Double Int Int Double Double Double Double String
MuxTraceRecvStart Int
MuxTraceRecvEnd Int
MuxTraceSendStart MuxSDUHeader
MuxTraceSendEnd
MuxTraceState MuxBearerState
MuxTraceCleanExit MiniProtocolNum MiniProtocolDir
MuxTraceExceptionExit MiniProtocolNum MiniProtocolDir SomeException
MuxTraceChannelRecvStart MiniProtocolNum
MuxTraceChannelRecvEnd MiniProtocolNum Int
MuxTraceChannelSendStart MiniProtocolNum Int
MuxTraceChannelSendEnd MiniProtocolNum
MuxTraceHandshakeStart
MuxTraceHandshakeClientEnd DiffTime
MuxTraceHandshakeServerEnd
∀ e.Exception e ⇒ MuxTraceHandshakeClientError e DiffTime
∀ e.Exception e ⇒ MuxTraceHandshakeServerError e
MuxTraceSDUReadTimeoutException
MuxTraceSDUWriteTimeoutException
MuxTraceStartEagerly MiniProtocolNum MiniProtocolDir
MuxTraceStartOnDemand MiniProtocolNum MiniProtocolDir
MuxTraceStartedOnDemand MiniProtocolNum MiniProtocolDir
MuxTraceTerminating MiniProtocolNum MiniProtocolDir
MuxTraceStopping
MuxTraceStopped
MuxTraceTCPInfo StructTCPInfo Word16

Instances

Instances details

Show MuxTrace Source #
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → MuxTrace → ShowS Source # show ∷ MuxTrace → String Source # showList ∷ [MuxTrace] → ShowS Source #

data MuxBearerState Source #

Constructors

Mature	MuxBearer has successfully completed the handshake.
Dead	MuxBearer is dead and the underlying bearer has been closed.

Instances

Instances details

Show MuxBearerState Source #
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → MuxBearerState → ShowS Source # show ∷ MuxBearerState → String Source # showList ∷ [MuxBearerState] → ShowS Source #
Eq MuxBearerState Source #
Instance details Defined in Network.Mux.Trace Methods (==) ∷ MuxBearerState → MuxBearerState → Bool Source # (/=) ∷ MuxBearerState → MuxBearerState → Bool Source #

data WithMuxBearer peerid a Source #

Type used for tracing mux events.

Constructors

WithMuxBearer
Fields wmbPeerId ∷ !peerid A tag that should identify a specific mux bearer. wmbEvent ∷ !a

Instances

Instances details

Generic (WithMuxBearer peerid a) Source #
Instance details Defined in Network.Mux.Trace Associated Types type Rep (WithMuxBearer peerid a) ∷ Type → Type Source # Methods from ∷ WithMuxBearer peerid a → Rep (WithMuxBearer peerid a) x Source # to ∷ Rep (WithMuxBearer peerid a) x → WithMuxBearer peerid a Source #
(Show peerid, Show a) ⇒ Show (WithMuxBearer peerid a) Source #
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → WithMuxBearer peerid a → ShowS Source # show ∷ WithMuxBearer peerid a → String Source # showList ∷ [WithMuxBearer peerid a] → ShowS Source #
type Rep (WithMuxBearer peerid a) Source #
Instance details Defined in Network.Mux.Trace type Rep (WithMuxBearer peerid a) = D1 ('MetaData "WithMuxBearer" "Network.Mux.Trace" "network-mux-0.4.0.0-inplace" 'False) (C1 ('MetaCons "WithMuxBearer" 'PrefixI 'True) (S1 ('MetaSel ('Just "wmbPeerId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 peerid) :*: S1 ('MetaSel ('Just "wmbEvent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))

data TraceLabelPeer peerid a Source #

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

Constructors

TraceLabelPeer peerid a

Instances

Instances details

Bifunctor TraceLabelPeer Source #
Instance details Defined in Network.Mux.Trace Methods bimap ∷ (a → b) → (c → d) → TraceLabelPeer a c → TraceLabelPeer b d Source # first ∷ (a → b) → TraceLabelPeer a c → TraceLabelPeer b c Source # second ∷ (b → c) → TraceLabelPeer a b → TraceLabelPeer a c Source #
Functor (TraceLabelPeer peerid) Source #
Instance details Defined in Network.Mux.Trace Methods fmap ∷ (a → b) → TraceLabelPeer peerid a → TraceLabelPeer peerid b Source # (<$) ∷ a → TraceLabelPeer peerid b → TraceLabelPeer peerid a Source #
(Show peerid, Show a) ⇒ Show (TraceLabelPeer peerid a) Source #
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → TraceLabelPeer peerid a → ShowS Source # show ∷ TraceLabelPeer peerid a → String Source # showList ∷ [TraceLabelPeer peerid a] → ShowS Source #
(Eq peerid, Eq a) ⇒ Eq (TraceLabelPeer peerid a) Source #
Instance details Defined in Network.Mux.Trace Methods (==) ∷ TraceLabelPeer peerid a → TraceLabelPeer peerid a → Bool Source # (/=) ∷ TraceLabelPeer peerid a → TraceLabelPeer peerid a → Bool Source #