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
newtype 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 :: Type -> Type) = StrictTVar m ByteString
data MiniProtocolIx
data MiniProtocolDir
- = InitiatorDir
- | ResponderDir
protocolDirEnum :: forall (mode :: MuxMode). MiniProtocolDirection mode -> MiniProtocolDir
data MiniProtocolState (mode :: MuxMode) (m :: Type -> Type) = MiniProtocolState {
- miniProtocolInfo :: MiniProtocolInfo mode
- miniProtocolIngressQueue :: IngressQueue m
- miniProtocolStatusVar :: StrictTVar m MiniProtocolStatus
}
data MiniProtocolStatus
- = StatusIdle
- | StatusStartOnDemand
- | StatusRunning
data MuxBearer (m :: Type -> Type) = MuxBearer {
- write :: TimeoutFn m -> MuxSDU -> m Time
- read :: TimeoutFn m -> m (MuxSDU, Time)
- sduSize :: SDUSize
}
muxBearerAsChannel :: forall (m :: Type -> Type). 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 # 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] #
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 #
Show MiniProtocolNum Source #
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> MiniProtocolNum -> ShowS # show :: MiniProtocolNum -> String # showList :: [MiniProtocolNum] -> ShowS #
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 #

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 # (/=) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool #
Ord (MiniProtocolDirection mode) Source #
Instance details Defined in Network.Mux.Types Methods compare :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Ordering # (<) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool # (<=) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool # (>) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool # (>=) :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> Bool # max :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> MiniProtocolDirection mode # min :: MiniProtocolDirection mode -> MiniProtocolDirection mode -> MiniProtocolDirection mode #

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

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] #
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 #
Show MiniProtocolDir Source #
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> MiniProtocolDir -> ShowS # show :: MiniProtocolDir -> String # showList :: [MiniProtocolDir] -> ShowS #
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 #

protocolDirEnum :: forall (mode :: MuxMode). MiniProtocolDirection mode -> MiniProtocolDir Source #

data MiniProtocolState (mode :: MuxMode) (m :: Type -> Type) Source #

Constructors

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

data MiniProtocolStatus Source #

Constructors

StatusIdle
StatusStartOnDemand
StatusRunning

Instances

Instances details

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

data MuxBearer (m :: Type -> Type) 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 :: Type -> Type). 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

Generic SDUSize Source #

Instance details

Defined in Network.Mux.Types

Associated Types

type Rep SDUSize
Instance details Defined in Network.Mux.Types type Rep SDUSize = D1 ('MetaData "SDUSize" "Network.Mux.Types" "network-mux-0.4.5.3-inplace" 'True) (C1 ('MetaCons "SDUSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSDUSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))

Methods

from :: SDUSize -> Rep SDUSize x #

to :: Rep SDUSize x -> SDUSize #

Show SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

showsPrec :: Int -> SDUSize -> ShowS #

show :: SDUSize -> String #

showList :: [SDUSize] -> ShowS #

type Rep SDUSize Source #

Instance details

Defined in Network.Mux.Types

type Rep SDUSize = D1 ('MetaData "SDUSize" "Network.Mux.Types" "network-mux-0.4.5.3-inplace" '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 # maxBound :: RemoteClockModel #
Eq RemoteClockModel Source #
Instance details Defined in Network.Mux.Types Methods (==) :: RemoteClockModel -> RemoteClockModel -> Bool # (/=) :: RemoteClockModel -> RemoteClockModel -> Bool #

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

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