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

Network.Mux

Synopsis

Defining Mux protocol bundles

newMux :: MonadSTM m => MiniProtocolBundle mode -> m ( Mux mode m) Source #

data Mux (mode :: MuxMode ) m Source #

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 MiniProtocolBundle (mode :: MuxMode ) Source #

Application run by mux layer.

  • enumeration of client application, e.g. a wallet application communicating with a node using ChainSync and TxSubmission protocols; this only requires to run client side of each protocol.
  • enumeration of server applications: this application type is mostly useful tests.
  • enumeration of both client and server applications, e.g. a full node serving downstream peers using server side of each protocol and getting updates from upstream peers using client side of each of the protocols.

Constructors

MiniProtocolBundle [ MiniProtocolInfo mode]

data MiniProtocolInfo (mode :: MuxMode ) Source #

Constructors

MiniProtocolInfo

Fields

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 MiniProtocolDirection (mode :: MuxMode ) where Source #

Constructors

InitiatorDirectionOnly :: MiniProtocolDirection InitiatorMode
ResponderDirectionOnly :: MiniProtocolDirection ResponderMode
InitiatorDirection :: MiniProtocolDirection InitiatorResponderMode
ResponderDirection :: MiniProtocolDirection InitiatorResponderMode

Instances

Instances details
Eq ( MiniProtocolDirection mode) Source #
Instance details

Defined in Network.Mux.Types

Methods

(==) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool Source #

(/=) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool Source #

Ord ( MiniProtocolDirection mode) Source #
Instance details

Defined in Network.Mux.Types

Methods

compare :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Ordering Source #

(<) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool Source #

(<=) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool Source #

(>) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool Source #

(>=) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool Source #

max :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> MiniProtocolDirection mode Source #

min :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> MiniProtocolDirection mode Source #

data MiniProtocolLimits Source #

Per Miniprotocol limits

Constructors

MiniProtocolLimits

Fields

Running the Mux

runMux :: forall m mode. ( MonadAsync m, MonadCatch m, MonadFork m, MonadLabelledSTM m, MonadThrow ( STM m), MonadTime m, MonadTimer m, MonadMask m) => Tracer m MuxTrace -> Mux mode m -> MuxBearer m -> m () Source #

runMux starts a mux bearer for the specified protocols corresponding to one of the provided Versions.

Isometric flow control: analysis of head-of-line blocking of the ingress side of the multiplexer

For each mini-protocol (enumerated by ptcl ), mux will create two channels. One for initiator and one for the responder. Each channel will use a single Wanton . When it is filled, it is put in a common queue tsrQueue . This means that the queue is bound by 2 * |ptcl| . Every side of a mini-protocol is served by a single Wanton : when an application sends data, the channel will try to put it into the Wanton (which might block). Wanton s are taken from the tsrQueue queue by one of mux threads. This eliminates head of line blocking: each mini-protocol thread can block on putting more bytes into its Wanton , but it cannot block the other mini-protocols or the thread that is reading the tsrQueue queue. This is ensured since the muxChannel will put only a non-empty Wanton to the tsrQueue queue, and on such wantons the queue is never blocked. This means that the only way the queue can block is when its empty, which means that none of the mini-protocols wanted to send. The egress part will read a Wanton , take a fixed amount of bytes encode them in as an MuxSDU ; if there are leftovers it will put them back in the Wanton and place it at the end of the queue (reading and writing to it will happen in a single STM transaction which assures that the order of requests from a mini-protocol is preserved.

Properties:

  • at any given time the tsrQueue contains at most one TranslocationServiceRequest from a given mini-protocol of the given MiniProtocolDir , thus the queue contains at most 2 * |ptcl| translocation requests.
  • at any given time each TranslocationServiceRequest contains a non-empty Wanton

data MuxBearer m Source #

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

runMiniProtocol :: forall mode m a. ( MonadSTM m, MonadThrow m, MonadThrow ( STM m)) => Mux mode m -> MiniProtocolNum -> MiniProtocolDirection mode -> StartOnDemandOrEagerly -> ( Channel m -> m (a, Maybe ByteString )) -> m ( STM m ( Either SomeException a)) Source #

Arrange to run a protocol thread (for a particular MiniProtocolNum and MiniProtocolDirection ) to interact on this protocol's Channel .

The protocol thread can either be started eagerly or on-demand:

  • With StartEagerly , the thread is started promptly. This is appropriate for mini-protocols where the opening message may be sent by this thread.
  • With StartOnDemand , the thread is not started until the first data is received for this mini-protocol. This is appropriate for mini-protocols where the opening message is sent by the remote peer.

The result is a STM action to block and wait on the protocol completion. It is safe to call this completion action multiple times: it will always return the same result once the protocol thread completes. In case the Mux has stopped, either due to an exception or because of a call to muxStop a `Left MuxError` will be returned from the STM action.

It is an error to start a new protocol thread while one is still running, for the same MiniProtocolNum and MiniProtocolDirection . This can easily be avoided by using the STM completion action to wait for the previous one to finish.

It is safe to ask to start a protocol thread before runMux . In this case the protocol thread will not actually start until runMux is called, irrespective of the StartOnDemandOrEagerly value.

data StartOnDemandOrEagerly Source #

Constructors

StartOnDemand
StartEagerly

Instances

Instances details
Eq StartOnDemandOrEagerly Source #
Instance details

Defined in Network.Mux

Methods

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

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

stopMux :: MonadSTM m => Mux mode m -> m () Source #

Shut down the mux. This will cause runMux to return. It does not wait for any protocol threads to finish, so you should do that first if necessary.

Monitoring

miniProtocolStateMap :: MonadSTM m => Mux mode m -> Map ( MiniProtocolNum , MiniProtocolDir ) ( STM m MiniProtocolStatus ) Source #

muxStopped :: MonadSTM m => Mux mode m -> STM m ( Maybe SomeException ) Source #

Await until mux stopped.

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)))