Modulenetwork-mux-0.11.0.0Haskell2010

Network.Mux.Types

Types used by the multiplexer.

20 types
9 values

Packagenetwork-mux-0.11.0.0
Exports31
LanguageHaskell2010
LicenceApache-2.0
SourceTypes.hs

datadata MiniProtocolInfo (mode :: Mode)

A static description of a mini-protocol.

Constructors

MiniProtocolInfo
- miniProtocolNum :: !MiniProtocolNum
  Unique mini-protocol number.
- miniProtocolDir :: !MiniProtocolDirection mode
  Mini-protocol direction.
- miniProtocolLimits :: !MiniProtocolLimits
  ingress queue limits for the protocol
- miniProtocolCapability :: !Maybe Int
  capability on which the mini-protocol should run

Instances1Show

Show (MiniProtocolInfo mode)Defined in network-mux-0.11.0.0 · Network.Mux.Types

newtypenewtype MiniProtocolNum

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

Instances5Enum, Eq, Ord, Show, Ix

Enum MiniProtocolNumDefined in network-mux-0.11.0.0 · Network.Mux.Types
Eq MiniProtocolNumDefined in network-mux-0.11.0.0 · Network.Mux.Types
Ord MiniProtocolNumDefined in network-mux-0.11.0.0 · Network.Mux.Types
Show MiniProtocolNumDefined in network-mux-0.11.0.0 · Network.Mux.Types
Ix MiniProtocolNumDefined in network-mux-0.11.0.0 · Network.Mux.Types

datadata MiniProtocolDirection (mode :: Mode) where

Constructors

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

Instances3Eq, Ord, Show

Eq (MiniProtocolDirection mode)Defined in network-mux-0.11.0.0 · Network.Mux.Types
Ord (MiniProtocolDirection mode)Defined in network-mux-0.11.0.0 · Network.Mux.Types
Show (MiniProtocolDirection mode)Defined in network-mux-0.11.0.0 · Network.Mux.Types

datadata StartOnDemandOrEagerly

Strategy how to start a mini-protocol.

Constructors

StartEagerly
Start a mini-protocol promptly.
StartOnDemand
Start a mini-protocol when data is received for the given mini-protocol. Must be used only when initial message is sent by the remote side.
StartOnDemandAny
Like StartOnDemand, but start a mini-protocol if data is received for any mini-protocol set to StartOnDemand.

Instances2Eq, Show

Eq StartOnDemandOrEagerlyDefined in network-mux-0.11.0.0 · Network.Mux.Types
Show StartOnDemandOrEagerlyDefined in network-mux-0.11.0.0 · Network.Mux.Types

newtypenewtype MiniProtocolLimits

Per Miniprotocol limits

Constructors

MiniProtocolLimits
- maximumIngressQueue :: Int
  Limit on the maximum number of bytes that can be queued in the miniprotocol's ingress queue.

Instances1Show

Show MiniProtocolLimitsDefined in network-mux-0.11.0.0 · Network.Mux.Types

datadata Mode where

Statically configured multiplexer mode.

Constructors

InitiatorMode :: Mode
Only execute initiator protocols. In this mode the multiplexer will only run its egress side.
ResponderMode :: Mode
Only execute responder protocols. It this mode the multiplexer will only run its ingress side.
InitiatorResponderMode :: Mode
Execute initiator and responder protocols. In this mode the multiplexer will run both ingress and egress sides.

familytype family HasInitiator (mode :: Mode) :: Bool where

Equations

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

familytype family HasResponder (mode :: Mode) :: Bool where

Equations

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

datadata Status

Constructors

Ready
Initial mux state, mux is ready to accept requests. It does not indicate weather mux thread was started or not.
Failed SomeException
Mux failed with SomeException
Stopping
Mux is being stopped; mux will not accept any new mini-protocols to start.
Stopped
Mux stopped.

Instances1Show

Show StatusDefined in network-mux-0.11.0.0 · Network.Mux.Types

typetype IngressQueue (m :: Type -> Type) = StrictTVar m (Pair Int64 Builder)

newtypenewtype MiniProtocolIx

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

Instances6Enum, Eq, Num, Ord, Show, Ix

Enum MiniProtocolIxDefined in network-mux-0.11.0.0 · Network.Mux.Types
Eq MiniProtocolIxDefined in network-mux-0.11.0.0 · Network.Mux.Types
Num MiniProtocolIxDefined in network-mux-0.11.0.0 · Network.Mux.Types
Ord MiniProtocolIxDefined in network-mux-0.11.0.0 · Network.Mux.Types
Show MiniProtocolIxDefined in network-mux-0.11.0.0 · Network.Mux.Types
Ix MiniProtocolIxDefined in network-mux-0.11.0.0 · Network.Mux.Types

datadata MiniProtocolDir

InitiatorDir ResponderDir

Instances6Bounded, Enum, Eq, Ord, Show, Ix

Bounded MiniProtocolDirDefined in network-mux-0.11.0.0 · Network.Mux.Types
Enum MiniProtocolDirDefined in network-mux-0.11.0.0 · Network.Mux.Types
Eq MiniProtocolDirDefined in network-mux-0.11.0.0 · Network.Mux.Types
Ord MiniProtocolDirDefined in network-mux-0.11.0.0 · Network.Mux.Types
Show MiniProtocolDirDefined in network-mux-0.11.0.0 · Network.Mux.Types
Ix MiniProtocolDirDefined in network-mux-0.11.0.0 · Network.Mux.Types

valueprotocolDirEnum :: MiniProtocolDirection mode -> MiniProtocolDir

datadata MiniProtocolState (mode :: Mode) (m :: Type -> Type)

Constructors

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

datadata MiniProtocolStatus

StatusIdle StatusStartOnDemand StatusRunning StatusStartOnDemandAny

Instances2Eq, Show

Eq MiniProtocolStatusDefined in network-mux-0.11.0.0 · Network.Mux.Types
Show MiniProtocolStatusDefined in network-mux-0.11.0.0 · Network.Mux.Types

datadata Bearer (m :: Type -> Type)

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

Network.Socket.socketAsBearer
Network.Pipe.pipeAsBearer
```
Test.Mux.queuesAsBearer
```

Constructors

Bearer
- write :: Tracer m BearerTrace -> TimeoutFn m -> SDU -> m Time
  Timestamp and send SDU.
- writeMany :: Tracer m BearerTrace -> TimeoutFn m -> [SDU] -> m Time
  Timestamp and send many SDUs.
- read :: Tracer m BearerTrace -> TimeoutFn m -> m (SDU, Time)
  Read a SDU
- sduSize :: SDUSize
  Return a suitable SDU payload size.
- batchSize :: Int
  Return a suitable batch size
- name :: String
  Name of the bearer
- egressInterval :: DiffTime
  Egress poll interval

valuebearerAsChannel

:: Functor m
=> Tracer m BearerTrace
-> Bearer m
-> MiniProtocolNum
-> MiniProtocolDir
-> ByteChannel m

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

datadata SDU

Constructors

SDU
- msHeader :: !SDUHeader
- msBlob :: !ByteString

datadata SDUHeader

Constructors

SDUHeader
- mhTimestamp :: !RemoteClockModel
- mhNum :: !MiniProtocolNum
- mhDir :: !MiniProtocolDir
- mhLength :: !Word16

newtypenewtype SDUSize

Constructors

SDUSize
- getSDUSize :: Word16

Instances9Enum, Eq, Integral, Num, Ord, Real, …

Enum SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
Eq SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
Integral SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
Num SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
Ord SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
Real SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
Show SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
Generic SDUSizeDefined in network-mux-0.11.0.0 · Network.Mux.Types
type Rep SDUSize = D1 ('MetaData "SDUSize" "Network.Mux.Types" "network-mux-0.11.0.0-HTPTgbnoxBEJogkIsdugRg" 'True) (C1 ('MetaCons "SDUSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSDUSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))Defined in network-mux-0.11.0.0 · Network.Mux.Types

valuemsTimestamp :: SDU -> RemoteClockModel

valuesetTimestamp :: SDU -> RemoteClockModel -> SDU

valuemsNum :: SDU -> MiniProtocolNum

valuemsDir :: SDU -> MiniProtocolDir

valuemsLength :: SDU -> Word16

valuemsHeaderLength :: Int64

Size of a MuxHeader in Bytes

newtypenewtype RemoteClockModel

Constructors

RemoteClockModel
- unRemoteClockModel :: Word32

Instances2Bounded, Eq

Bounded RemoteClockModelDefined in network-mux-0.11.0.0 · Network.Mux.Types
Eq RemoteClockModelDefined in network-mux-0.11.0.0 · Network.Mux.Types

valueremoteClockPrecision :: DiffTime

The DiffTime represented by a tick in the RemoteClockModel

datadata RuntimeError

Constructors

ProtocolAlreadyRunning !MiniProtocolNum !MiniProtocolDir !MiniProtocolStatus
UnknownProtocolInternalError !MiniProtocolNum !MiniProtocolDir
BlockedOnCompletionVar !MiniProtocolNum

Instances2Show, Exception

Show RuntimeErrorDefined in network-mux-0.11.0.0 · Network.Mux.Types
Exception RuntimeErrorDefined in network-mux-0.11.0.0 · Network.Mux.Types

datadata ReadBuffer (m :: Type -> Type)

ReadBuffer for Mux Bearers

This is used to read more data than whats currently needed in one syscall. Any extra data read is cached in rbVar until the next read request.

Constructors

ReadBuffer
- rbVar :: StrictTVar m ByteString
  Read cache
- rbBuf :: Ptr Word8
  Buffer, used by the kernel to write the received data into.
- rbSize :: Int
  Size of rbBuf.

datadata BearerTrace

Low-level bearer trace tags (these are not traced by the tracer which is passed to Mux).

Instances1Show

Show BearerTraceDefined in network-mux-0.11.0.0 · Network.Mux.Types