network-mux-0.1.0.1: Multiplexing library
Safe Haskell None
Language Haskell2010

Network.Mux.Compat

Synopsis

Documentation

muxStart :: forall m mode a b. ( MonadAsync m, MonadFork m, MonadLabelledSTM m, MonadThrow ( STM m), MonadTime m, MonadTimer m, MonadMask m) => Tracer m MuxTrace -> MuxApplication mode m a b -> MuxBearer m -> m () Source #

Mux bearers

data MuxBearer m Source #

Low level access to underlying socket or pipe. There are three smart constructors:

Defining MuxApplication s

data MuxMode where Source #

Constructors

InitiatorMode :: MuxMode
ResponderMode :: MuxMode
InitiatorResponderMode :: MuxMode

type family HasInitiator (mode :: MuxMode ) :: Bool where ... Source #

Equations

HasInitiator InitiatorMode = True
HasInitiator ResponderMode = False
HasInitiator InitiatorResponderMode = True

type family HasResponder (mode :: MuxMode ) :: Bool where ... Source #

Equations

HasResponder InitiatorMode = False
HasResponder ResponderMode = True
HasResponder InitiatorResponderMode = True

newtype MuxApplication (mode :: MuxMode ) m a b Source #

Constructors

MuxApplication [ MuxMiniProtocol mode m a b]

data MuxMiniProtocol (mode :: MuxMode ) m a b Source #

Constructors

MuxMiniProtocol

Fields

data RunMiniProtocol (mode :: MuxMode ) m a b where Source #

Constructors

InitiatorProtocolOnly :: ( Channel m -> m (a, Maybe ByteString )) -> RunMiniProtocol InitiatorMode m a Void
ResponderProtocolOnly :: ( Channel m -> m (b, Maybe ByteString )) -> RunMiniProtocol ResponderMode m Void b
InitiatorAndResponderProtocol :: ( Channel m -> m (a, Maybe ByteString )) -> ( Channel m -> m (b, Maybe ByteString )) -> RunMiniProtocol InitiatorResponderMode m a b

newtype MiniProtocolNum Source #

The wire format includes the protocol numbers, and it's vital that these are stable. They are not necessarily dense however, as new ones are added and some old ones retired. So we use a dedicated class for this rather than reusing Enum . This also covers unrecognised protocol numbers on the decoding side.

Constructors

MiniProtocolNum Word16

Instances

Instances details
Enum MiniProtocolNum Source #
Instance details

Defined in Network.Mux.Types

Methods

succ :: MiniProtocolNum -> MiniProtocolNum Source #

pred :: MiniProtocolNum -> MiniProtocolNum Source #

toEnum :: Int -> MiniProtocolNum Source #

fromEnum :: MiniProtocolNum -> Int Source #

enumFrom :: MiniProtocolNum -> [ MiniProtocolNum ] Source #

enumFromThen :: MiniProtocolNum -> MiniProtocolNum -> [ MiniProtocolNum ] Source #

enumFromTo :: MiniProtocolNum -> MiniProtocolNum -> [ MiniProtocolNum ] Source #

enumFromThenTo :: MiniProtocolNum -> MiniProtocolNum -> MiniProtocolNum -> [ MiniProtocolNum ] Source #

Eq MiniProtocolNum Source #
Instance details

Defined in Network.Mux.Types

Methods

(==) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source #

(/=) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source #

Ord MiniProtocolNum Source #
Instance details

Defined in Network.Mux.Types

Methods

compare :: MiniProtocolNum -> MiniProtocolNum -> Ordering Source #

(<) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source #

(<=) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source #

(>) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source #

(>=) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source #

max :: MiniProtocolNum -> MiniProtocolNum -> MiniProtocolNum Source #

min :: MiniProtocolNum -> MiniProtocolNum -> MiniProtocolNum Source #

Show MiniProtocolNum Source #
Instance details

Defined in Network.Mux.Types

Methods

showsPrec :: Int -> MiniProtocolNum -> ShowS Source #

show :: MiniProtocolNum -> String Source #

showList :: [ MiniProtocolNum ] -> ShowS Source #

Ix MiniProtocolNum Source #
Instance details

Defined in Network.Mux.Types

Methods

range :: ( MiniProtocolNum , MiniProtocolNum ) -> [ MiniProtocolNum ] Source #

index :: ( MiniProtocolNum , MiniProtocolNum ) -> MiniProtocolNum -> Int Source #

unsafeIndex :: ( MiniProtocolNum , MiniProtocolNum ) -> MiniProtocolNum -> Int Source #

inRange :: ( MiniProtocolNum , MiniProtocolNum ) -> MiniProtocolNum -> Bool Source #

rangeSize :: ( MiniProtocolNum , MiniProtocolNum ) -> Int Source #

unsafeRangeSize :: ( MiniProtocolNum , MiniProtocolNum ) -> Int Source #

data MiniProtocolLimits Source #

Per Miniprotocol limits

Constructors

MiniProtocolLimits

Fields

data MiniProtocolDir Source #

Constructors

InitiatorDir
ResponderDir

Instances

Instances details
Bounded MiniProtocolDir Source #
Instance details

Defined in Network.Mux.Types

Methods

minBound :: MiniProtocolDir Source #

maxBound :: MiniProtocolDir Source #

Enum MiniProtocolDir Source #
Instance details

Defined in Network.Mux.Types

Methods

succ :: MiniProtocolDir -> MiniProtocolDir Source #

pred :: MiniProtocolDir -> MiniProtocolDir Source #

toEnum :: Int -> MiniProtocolDir Source #

fromEnum :: MiniProtocolDir -> Int Source #

enumFrom :: MiniProtocolDir -> [ MiniProtocolDir ] Source #

enumFromThen :: MiniProtocolDir -> MiniProtocolDir -> [ MiniProtocolDir ] Source #

enumFromTo :: MiniProtocolDir -> MiniProtocolDir -> [ MiniProtocolDir ] Source #

enumFromThenTo :: MiniProtocolDir -> MiniProtocolDir -> MiniProtocolDir -> [ MiniProtocolDir ] Source #

Eq MiniProtocolDir Source #
Instance details

Defined in Network.Mux.Types

Methods

(==) :: MiniProtocolDir -> MiniProtocolDir -> Bool Source #

(/=) :: MiniProtocolDir -> MiniProtocolDir -> Bool Source #

Ord MiniProtocolDir Source #
Instance details

Defined in Network.Mux.Types

Methods

compare :: MiniProtocolDir -> MiniProtocolDir -> Ordering Source #

(<) :: MiniProtocolDir -> MiniProtocolDir -> Bool Source #

(<=) :: MiniProtocolDir -> MiniProtocolDir -> Bool Source #

(>) :: MiniProtocolDir -> MiniProtocolDir -> Bool Source #

(>=) :: MiniProtocolDir -> MiniProtocolDir -> Bool Source #

max :: MiniProtocolDir -> MiniProtocolDir -> MiniProtocolDir Source #

min :: MiniProtocolDir -> MiniProtocolDir -> MiniProtocolDir Source #

Show MiniProtocolDir Source #
Instance details

Defined in Network.Mux.Types

Methods

showsPrec :: Int -> MiniProtocolDir -> ShowS Source #

show :: MiniProtocolDir -> String Source #

showList :: [ MiniProtocolDir ] -> ShowS Source #

Ix MiniProtocolDir Source #
Instance details

Defined in Network.Mux.Types

Methods

range :: ( MiniProtocolDir , MiniProtocolDir ) -> [ MiniProtocolDir ] Source #

index :: ( MiniProtocolDir , MiniProtocolDir ) -> MiniProtocolDir -> Int Source #

unsafeIndex :: ( MiniProtocolDir , MiniProtocolDir ) -> MiniProtocolDir -> Int Source #

inRange :: ( MiniProtocolDir , MiniProtocolDir ) -> MiniProtocolDir -> Bool Source #

rangeSize :: ( MiniProtocolDir , MiniProtocolDir ) -> Int Source #

unsafeRangeSize :: ( MiniProtocolDir , MiniProtocolDir ) -> Int Source #

Errors

data MuxError Source #

Error type used in across the mux layer.

Constructors

MuxError

Fields

Instances

Instances details
Show MuxError Source #
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> MuxError -> ShowS Source #

show :: MuxError -> String Source #

showList :: [ MuxError ] -> ShowS 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 #

Exception MuxError Source #
Instance details

Defined in Network.Mux.Trace

Methods

toException :: MuxError -> SomeException Source #

fromException :: SomeException -> Maybe MuxError Source #

displayException :: MuxError -> String Source #

type Rep MuxError Source #
Instance details

Defined in Network.Mux.Trace

type Rep MuxError = D1 (' MetaData "MuxError" "Network.Mux.Trace" "network-mux-0.1.0.1-7ZKx91o48G8EWFMuCmTsQc" ' 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
Eq MuxErrorType Source #
Instance details

Defined in Network.Mux.Trace

Methods

(==) :: MuxErrorType -> MuxErrorType -> Bool Source #

(/=) :: MuxErrorType -> MuxErrorType -> Bool Source #

Show MuxErrorType Source #
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> MuxErrorType -> ShowS Source #

show :: MuxErrorType -> String Source #

showList :: [ MuxErrorType ] -> ShowS Source #

Tracing

traceMuxBearerState :: Tracer m MuxTrace -> MuxBearerState -> m () 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
Eq MuxBearerState Source #
Instance details

Defined in Network.Mux.Trace

Methods

(==) :: MuxBearerState -> MuxBearerState -> Bool Source #

(/=) :: MuxBearerState -> MuxBearerState -> Bool Source #

Show MuxBearerState Source #
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> MuxBearerState -> ShowS Source #

show :: MuxBearerState -> String Source #

showList :: [ MuxBearerState ] -> ShowS Source #

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
forall e. Exception e => MuxTraceHandshakeClientError e DiffTime
forall e. Exception e => MuxTraceHandshakeServerError e
MuxTraceSDUReadTimeoutException
MuxTraceSDUWriteTimeoutException
MuxTraceStartEagerly MiniProtocolNum MiniProtocolDir
MuxTraceStartOnDemand MiniProtocolNum MiniProtocolDir
MuxTraceStartedOnDemand MiniProtocolNum MiniProtocolDir
MuxTraceTerminating MiniProtocolNum MiniProtocolDir
MuxTraceShutdown
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 WithMuxBearer peerid a Source #

Type used for tracing mux events.

Constructors

WithMuxBearer

Fields

Instances

Instances details
( 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 #

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 #

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.1.0.1-7ZKx91o48G8EWFMuCmTsQc" ' False ) ( C1 (' MetaCons "WithMuxBearer" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "wmbPeerId") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 peerid) :*: S1 (' MetaSel (' Just "wmbEvent") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a)))