Safe Haskell	None
Language	Haskell2010

Network.Mux.Types

Synopsis

newtype MiniProtocolBundle (mode :: MuxMode ) = MiniProtocolBundle [ MiniProtocolInfo mode]
data MiniProtocolInfo (mode :: MuxMode ) = MiniProtocolInfo {
- miniProtocolNum :: ! MiniProtocolNum
- miniProtocolDir :: !( MiniProtocolDirection mode)
- miniProtocolLimits :: ! MiniProtocolLimits
}
newtype MiniProtocolNum = MiniProtocolNum Word16
data MiniProtocolDirection (mode :: MuxMode ) where
- InitiatorDirectionOnly :: MiniProtocolDirection InitiatorMode
- ResponderDirectionOnly :: MiniProtocolDirection ResponderMode
- InitiatorDirection :: MiniProtocolDirection InitiatorResponderMode
- ResponderDirection :: MiniProtocolDirection InitiatorResponderMode
data MiniProtocolLimits = MiniProtocolLimits {
- maximumIngressQueue :: ! Int
}
data MuxMode where
- InitiatorMode :: MuxMode
- ResponderMode :: MuxMode
- InitiatorResponderMode :: MuxMode
type family HasInitiator (mode :: MuxMode ) :: Bool where ...
type family HasResponder (mode :: MuxMode ) :: Bool where ...
type IngressQueue m = StrictTVar m ByteString
data MiniProtocolIx
data MiniProtocolDir
- = InitiatorDir
- | ResponderDir
protocolDirEnum :: MiniProtocolDirection mode -> MiniProtocolDir
data MiniProtocolState mode m = MiniProtocolState {
- miniProtocolInfo :: MiniProtocolInfo mode
- miniProtocolIngressQueue :: IngressQueue m
- miniProtocolStatusVar :: StrictTVar m MiniProtocolStatus
}
data MiniProtocolStatus
- = StatusIdle
- | StatusStartOnDemand
- | StatusRunning
data MuxBearer m = MuxBearer {
- write :: TimeoutFn m -> MuxSDU -> m Time
- read :: TimeoutFn m -> m ( MuxSDU , Time )
- sduSize :: SDUSize
}
muxBearerAsChannel :: forall m. Functor m => MuxBearer m -> MiniProtocolNum -> MiniProtocolDir -> Channel m
data MuxSDU = MuxSDU {
- msHeader :: ! MuxSDUHeader
- msBlob :: ! ByteString
}
data MuxSDUHeader = MuxSDUHeader {
- mhTimestamp :: ! RemoteClockModel
- mhNum :: ! MiniProtocolNum
- mhDir :: ! MiniProtocolDir
- mhLength :: ! Word16
}
newtype SDUSize = SDUSize {
- getSDUSize :: Word16
}
msTimestamp :: MuxSDU -> RemoteClockModel
setTimestamp :: MuxSDU -> RemoteClockModel -> MuxSDU
msNum :: MuxSDU -> MiniProtocolNum
msDir :: MuxSDU -> MiniProtocolDir
msLength :: MuxSDU -> Word16
newtype RemoteClockModel = RemoteClockModel {
- unRemoteClockModel :: Word32
}
remoteClockPrecision :: DiffTime
data MuxRuntimeError
- = ProtocolAlreadyRunning ! MiniProtocolNum ! MiniProtocolDir ! MiniProtocolStatus
- | UnknownProtocolInternalError ! MiniProtocolNum ! MiniProtocolDir
- | MuxBlockedOnCompletionVar ! MiniProtocolNum

Documentation

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 miniProtocolNum :: ! MiniProtocolNum miniProtocolDir :: !( MiniProtocolDirection mode) miniProtocolLimits :: ! MiniProtocolLimits

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 maximumIngressQueue :: ! Int Limit on the maximum number of bytes that can be queued in the miniprotocol's ingress queue.

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

type IngressQueue m = StrictTVar m ByteString Source #

data MiniProtocolIx Source #

The index of a protocol in a MuxApplication, used for array indices

Instances

Instances details

Enum MiniProtocolIx Source #
Instance details Defined in Network.Mux.Types Methods succ :: MiniProtocolIx -> MiniProtocolIx Source # pred :: MiniProtocolIx -> MiniProtocolIx Source # toEnum :: Int -> MiniProtocolIx Source # fromEnum :: MiniProtocolIx -> Int Source # enumFrom :: MiniProtocolIx -> [ MiniProtocolIx ] Source # enumFromThen :: MiniProtocolIx -> MiniProtocolIx -> [ MiniProtocolIx ] Source # enumFromTo :: MiniProtocolIx -> MiniProtocolIx -> [ MiniProtocolIx ] Source # enumFromThenTo :: MiniProtocolIx -> MiniProtocolIx -> MiniProtocolIx -> [ MiniProtocolIx ] Source #
Eq MiniProtocolIx Source #
Instance details Defined in Network.Mux.Types Methods (==) :: MiniProtocolIx -> MiniProtocolIx -> Bool Source # (/=) :: MiniProtocolIx -> MiniProtocolIx -> Bool Source #
Num MiniProtocolIx Source #
Instance details Defined in Network.Mux.Types Methods (+) :: MiniProtocolIx -> MiniProtocolIx -> MiniProtocolIx Source # (-) :: MiniProtocolIx -> MiniProtocolIx -> MiniProtocolIx Source # (*) :: MiniProtocolIx -> MiniProtocolIx -> MiniProtocolIx Source # negate :: MiniProtocolIx -> MiniProtocolIx Source # abs :: MiniProtocolIx -> MiniProtocolIx Source # signum :: MiniProtocolIx -> MiniProtocolIx Source # fromInteger :: Integer -> MiniProtocolIx Source #
Ord MiniProtocolIx Source #
Instance details Defined in Network.Mux.Types Methods compare :: MiniProtocolIx -> MiniProtocolIx -> Ordering Source # (<) :: MiniProtocolIx -> MiniProtocolIx -> Bool Source # (<=) :: MiniProtocolIx -> MiniProtocolIx -> Bool Source # (>) :: MiniProtocolIx -> MiniProtocolIx -> Bool Source # (>=) :: MiniProtocolIx -> MiniProtocolIx -> Bool Source # max :: MiniProtocolIx -> MiniProtocolIx -> MiniProtocolIx Source # min :: MiniProtocolIx -> MiniProtocolIx -> MiniProtocolIx Source #
Show MiniProtocolIx Source #
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> MiniProtocolIx -> ShowS Source # show :: MiniProtocolIx -> String Source # showList :: [ MiniProtocolIx ] -> ShowS Source #
Ix MiniProtocolIx Source #
Instance details Defined in Network.Mux.Types Methods range :: ( MiniProtocolIx , MiniProtocolIx ) -> [ MiniProtocolIx ] Source # index :: ( MiniProtocolIx , MiniProtocolIx ) -> MiniProtocolIx -> Int Source # unsafeIndex :: ( MiniProtocolIx , MiniProtocolIx ) -> MiniProtocolIx -> Int Source # inRange :: ( MiniProtocolIx , MiniProtocolIx ) -> MiniProtocolIx -> Bool Source # rangeSize :: ( MiniProtocolIx , MiniProtocolIx ) -> Int Source # unsafeRangeSize :: ( MiniProtocolIx , MiniProtocolIx ) -> Int Source #

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 #

protocolDirEnum :: MiniProtocolDirection mode -> MiniProtocolDir Source #

data MiniProtocolState mode m Source #

Constructors

MiniProtocolState
Fields miniProtocolInfo :: MiniProtocolInfo mode miniProtocolIngressQueue :: IngressQueue m miniProtocolStatusVar :: StrictTVar m MiniProtocolStatus

data MiniProtocolStatus Source #

Constructors

StatusIdle
StatusStartOnDemand
StatusRunning

Instances

Instances details

Eq MiniProtocolStatus Source #
Instance details Defined in Network.Mux.Types Methods (==) :: MiniProtocolStatus -> MiniProtocolStatus -> Bool Source # (/=) :: MiniProtocolStatus -> MiniProtocolStatus -> Bool Source #
Show MiniProtocolStatus Source #
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> MiniProtocolStatus -> ShowS Source # show :: MiniProtocolStatus -> String Source # showList :: [ MiniProtocolStatus ] -> ShowS Source #

data MuxBearer m Source #

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

socketAsMuxBearer
pipeAsMuxBearer
```
Test.Mux.queuesAsMuxBearer
```

Constructors

MuxBearer
Fields write :: TimeoutFn m -> MuxSDU -> m Time Timestamp and send MuxSDU. read :: TimeoutFn m -> m ( MuxSDU , Time ) Read a MuxSDU sduSize :: SDUSize Return a suitable MuxSDU payload size.

muxBearerAsChannel :: forall m. Functor m => MuxBearer m -> MiniProtocolNum -> MiniProtocolDir -> Channel m Source #

A channel which wraps each message as an MuxSDU using giving MiniProtocolNum and MiniProtocolDir .

data MuxSDU Source #

Constructors

MuxSDU
Fields msHeader :: ! MuxSDUHeader msBlob :: ! ByteString

data MuxSDUHeader Source #

Constructors

MuxSDUHeader
Fields mhTimestamp :: ! RemoteClockModel mhNum :: ! MiniProtocolNum mhDir :: ! MiniProtocolDir mhLength :: ! Word16

newtype SDUSize Source #

Constructors

SDUSize
Fields getSDUSize :: Word16

Instances

Instances details

Show SDUSize Source #
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> SDUSize -> ShowS Source # show :: SDUSize -> String Source # showList :: [ SDUSize ] -> ShowS Source #
Generic SDUSize Source #
Instance details Defined in Network.Mux.Types Associated Types type Rep SDUSize :: Type -> Type Source # Methods from :: SDUSize -> Rep SDUSize x Source # to :: Rep SDUSize x -> SDUSize Source #
type Rep SDUSize Source #
Instance details Defined in Network.Mux.Types type Rep SDUSize = D1 (' MetaData "SDUSize" "Network.Mux.Types" "network-mux-0.1.0.1-7ZKx91o48G8EWFMuCmTsQc" ' True ) ( C1 (' MetaCons "SDUSize" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getSDUSize") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word16 )))

msTimestamp :: MuxSDU -> RemoteClockModel Source #

setTimestamp :: MuxSDU -> RemoteClockModel -> MuxSDU Source #

msNum :: MuxSDU -> MiniProtocolNum Source #

msDir :: MuxSDU -> MiniProtocolDir Source #

msLength :: MuxSDU -> Word16 Source #

newtype RemoteClockModel Source #

Constructors

RemoteClockModel
Fields unRemoteClockModel :: Word32

Instances

Instances details

Bounded RemoteClockModel Source #
Instance details Defined in Network.Mux.Types Methods minBound :: RemoteClockModel Source # maxBound :: RemoteClockModel Source #
Eq RemoteClockModel Source #
Instance details Defined in Network.Mux.Types Methods (==) :: RemoteClockModel -> RemoteClockModel -> Bool Source # (/=) :: RemoteClockModel -> RemoteClockModel -> Bool Source #

remoteClockPrecision :: DiffTime Source #

The DiffTime represented by a tick in the RemoteClockModel

data MuxRuntimeError Source #

Constructors

ProtocolAlreadyRunning ! MiniProtocolNum ! MiniProtocolDir ! MiniProtocolStatus
UnknownProtocolInternalError ! MiniProtocolNum ! MiniProtocolDir
MuxBlockedOnCompletionVar ! MiniProtocolNum

Instances

Instances details

Show MuxRuntimeError Source #
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> MuxRuntimeError -> ShowS Source # show :: MuxRuntimeError -> String Source # showList :: [ MuxRuntimeError ] -> ShowS Source #
Exception MuxRuntimeError Source #
Instance details Defined in Network.Mux.Types Methods toException :: MuxRuntimeError -> SomeException Source # fromException :: SomeException -> Maybe MuxRuntimeError Source # displayException :: MuxRuntimeError -> String Source #