network-mux-0.1.0.0: Multiplexing library
Safe HaskellNone
LanguageHaskell2010

Network.Mux.Compat

Synopsis

Documentation

muxStart :: forall m mode a b. (MonadAsync m, MonadFork 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 MuxApplications

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 #

pred :: MiniProtocolNum -> MiniProtocolNum #

toEnum :: Int -> MiniProtocolNum #

fromEnum :: MiniProtocolNum -> Int #

enumFrom :: MiniProtocolNum -> [MiniProtocolNum] #

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

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

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

Eq MiniProtocolNum Source # 
Instance details

Defined in Network.Mux.Types

Methods

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

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

Ord MiniProtocolNum Source # 
Instance details

Defined in Network.Mux.Types

Methods

compare :: MiniProtocolNum -> MiniProtocolNum -> Ordering #

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

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

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

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

max :: MiniProtocolNum -> MiniProtocolNum -> MiniProtocolNum #

min :: MiniProtocolNum -> MiniProtocolNum -> MiniProtocolNum #

Show MiniProtocolNum Source # 
Instance details

Defined in Network.Mux.Types

Methods

showsPrec :: Int -> MiniProtocolNum -> ShowS #

show :: MiniProtocolNum -> String #

showList :: [MiniProtocolNum] -> ShowS #

Ix MiniProtocolNum Source # 
Instance details

Defined in Network.Mux.Types

Methods

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

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

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

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

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

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

data MiniProtocolLimits Source #

Per Miniprotocol limits

Constructors

MiniProtocolLimits 

Fields

  • maximumIngressQueue :: !Int

    Limit on the maximum number of bytes that can be queued in the miniprotocol's ingress queue.

data MiniProtocolDir Source #

Constructors

InitiatorDir 
ResponderDir 

Instances

Instances details
Bounded MiniProtocolDir Source # 
Instance details

Defined in Network.Mux.Types

Methods

minBound :: MiniProtocolDir #

maxBound :: MiniProtocolDir #

Enum MiniProtocolDir Source # 
Instance details

Defined in Network.Mux.Types

Methods

succ :: MiniProtocolDir -> MiniProtocolDir #

pred :: MiniProtocolDir -> MiniProtocolDir #

toEnum :: Int -> MiniProtocolDir #

fromEnum :: MiniProtocolDir -> Int #

enumFrom :: MiniProtocolDir -> [MiniProtocolDir] #

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

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

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

Eq MiniProtocolDir Source # 
Instance details

Defined in Network.Mux.Types

Methods

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

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

Ord MiniProtocolDir Source # 
Instance details

Defined in Network.Mux.Types

Methods

compare :: MiniProtocolDir -> MiniProtocolDir -> Ordering #

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

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

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

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

max :: MiniProtocolDir -> MiniProtocolDir -> MiniProtocolDir #

min :: MiniProtocolDir -> MiniProtocolDir -> MiniProtocolDir #

Show MiniProtocolDir Source # 
Instance details

Defined in Network.Mux.Types

Methods

showsPrec :: Int -> MiniProtocolDir -> ShowS #

show :: MiniProtocolDir -> String #

showList :: [MiniProtocolDir] -> ShowS #

Ix MiniProtocolDir Source # 
Instance details

Defined in Network.Mux.Types

Methods

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

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

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

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

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

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

Errors

data MuxError Source #

Error type used in accross the mux layer.

Constructors

MuxError 

Fields

Instances

Instances details
Show MuxError Source # 
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> MuxError -> ShowS #

show :: MuxError -> String #

showList :: [MuxError] -> ShowS #

Generic MuxError Source # 
Instance details

Defined in Network.Mux.Trace

Associated Types

type Rep MuxError :: Type -> Type #

Methods

from :: MuxError -> Rep MuxError x #

to :: Rep MuxError x -> MuxError #

Exception MuxError Source # 
Instance details

Defined in Network.Mux.Trace

Methods

toException :: MuxError -> SomeException #

fromException :: SomeException -> Maybe MuxError #

displayException :: MuxError -> String #

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.0-9qnrCYRZ9LiHKrvxV6Ik09" '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.

MuxCleanShutdown

Mux stopped by stopMux

MuxBlockedOnCompletionVar !MiniProtocolNum

Mux blocked on completionVar.

Instances

Instances details
Eq MuxErrorType Source # 
Instance details

Defined in Network.Mux.Trace

Methods

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

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

Show MuxErrorType Source # 
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> MuxErrorType -> ShowS #

show :: MuxErrorType -> String #

showList :: [MuxErrorType] -> ShowS #

Tracing

traceMuxBearerState :: Tracer m MuxTrace -> MuxBearerState -> m () Source #

data MuxBearerState Source #

Constructors

Mature

MuxBearer has successufully 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 #

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

Show MuxBearerState Source # 
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> MuxBearerState -> ShowS #

show :: MuxBearerState -> String #

showList :: [MuxBearerState] -> ShowS #

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 

Instances

Instances details
Show MuxTrace Source # 
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> MuxTrace -> ShowS #

show :: MuxTrace -> String #

showList :: [MuxTrace] -> ShowS #

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
(Show peerid, Show a) => Show (WithMuxBearer peerid a) Source # 
Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> WithMuxBearer peerid a -> ShowS #

show :: WithMuxBearer peerid a -> String #

showList :: [WithMuxBearer peerid a] -> ShowS #

Generic (WithMuxBearer peerid a) Source # 
Instance details

Defined in Network.Mux.Trace

Associated Types

type Rep (WithMuxBearer peerid a) :: Type -> Type #

Methods

from :: WithMuxBearer peerid a -> Rep (WithMuxBearer peerid a) x #

to :: Rep (WithMuxBearer peerid a) x -> WithMuxBearer peerid a #

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