Safe Haskell	None
Language	Haskell2010

Network.Mux.Types

Description

Types used by the multiplexer.

Synopsis

data MiniProtocolInfo (mode :: Mode) = MiniProtocolInfo {
- miniProtocolNum :: !MiniProtocolNum
- miniProtocolDir :: !(MiniProtocolDirection mode)
- miniProtocolLimits :: !MiniProtocolLimits
- miniProtocolCapability :: !(Maybe Int)
}
newtype MiniProtocolNum = MiniProtocolNum Word16
data MiniProtocolDirection (mode :: Mode) where
- InitiatorDirectionOnly :: MiniProtocolDirection 'InitiatorMode
- ResponderDirectionOnly :: MiniProtocolDirection 'ResponderMode
- InitiatorDirection :: MiniProtocolDirection 'InitiatorResponderMode
- ResponderDirection :: MiniProtocolDirection 'InitiatorResponderMode
newtype MiniProtocolLimits = MiniProtocolLimits {
- maximumIngressQueue :: Int
}
data Mode where
- InitiatorMode :: Mode
- ResponderMode :: Mode
- InitiatorResponderMode :: Mode
type family HasInitiator (mode :: Mode) :: Bool where ...
type family HasResponder (mode :: Mode) :: Bool where ...
data Status
- = Ready
- | Failed SomeException
- | Stopping
- | Stopped
type IngressQueue (m :: Type -> Type) = StrictTVar m ByteString
data MiniProtocolIx
data MiniProtocolDir
- = InitiatorDir
- | ResponderDir
protocolDirEnum :: forall (mode :: Mode). MiniProtocolDirection mode -> MiniProtocolDir
data MiniProtocolState (mode :: Mode) (m :: Type -> Type) = MiniProtocolState {
- miniProtocolInfo :: MiniProtocolInfo mode
- miniProtocolIngressQueue :: IngressQueue m
- miniProtocolStatusVar :: StrictTVar m MiniProtocolStatus
}
data MiniProtocolStatus
- = StatusIdle
- | StatusStartOnDemand
- | StatusRunning
- | StatusStartOnDemandAny
data Bearer (m :: Type -> Type) = Bearer {
- write :: TimeoutFn m -> SDU -> m Time
- read :: TimeoutFn m -> m (SDU, Time)
- sduSize :: SDUSize
- name :: String
}
bearerAsChannel :: forall (m :: Type -> Type). Functor m => Bearer m -> MiniProtocolNum -> MiniProtocolDir -> ByteChannel m
data SDU = SDU {
- msHeader :: !SDUHeader
- msBlob :: !ByteString
}
data SDUHeader = SDUHeader {
- mhTimestamp :: !RemoteClockModel
- mhNum :: !MiniProtocolNum
- mhDir :: !MiniProtocolDir
- mhLength :: !Word16
}
newtype SDUSize = SDUSize {
- getSDUSize :: Word16
}
msTimestamp :: SDU -> RemoteClockModel
setTimestamp :: SDU -> RemoteClockModel -> SDU
msNum :: SDU -> MiniProtocolNum
msDir :: SDU -> MiniProtocolDir
msLength :: SDU -> Word16
newtype RemoteClockModel = RemoteClockModel {
- unRemoteClockModel :: Word32
}
remoteClockPrecision :: DiffTime
data RuntimeError
- = ProtocolAlreadyRunning !MiniProtocolNum !MiniProtocolDir !MiniProtocolStatus
- | UnknownProtocolInternalError !MiniProtocolNum !MiniProtocolDir
- | BlockedOnCompletionVar !MiniProtocolNum

Documentation

data MiniProtocolInfo (mode :: Mode) Source #

A static description of a mini-protocol.

Constructors

MiniProtocolInfo
Fields 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

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 :: Mode) 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 Mode where Source #

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.

type family HasInitiator (mode :: Mode) :: Bool where ... Source #

Equations

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

type family HasResponder (mode :: Mode) :: Bool where ... Source #

Equations

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

data Status Source #

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.

Instances

Instances details

Show Status Source #
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #

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 :: Mode). MiniProtocolDirection mode -> MiniProtocolDir Source #

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

Constructors

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

data MiniProtocolStatus Source #

Constructors

StatusIdle
StatusStartOnDemand
StatusRunning
StatusStartOnDemandAny

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 Bearer (m :: Type -> Type) Source #

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

socketAsBearer
pipeAsBearer
```
Test.Mux.queuesAsBearer
```

Constructors

Bearer
Fields write :: TimeoutFn m -> SDU -> m Time Timestamp and send SDU. read :: TimeoutFn m -> m (SDU, Time) Read a SDU sduSize :: SDUSize Return a suitable SDU payload size. name :: String Name of the bearer

bearerAsChannel :: forall (m :: Type -> Type). Functor m => Bearer m -> MiniProtocolNum -> MiniProtocolDir -> ByteChannel m Source #

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

data SDU Source #

Constructors

SDU
Fields msHeader :: !SDUHeader msBlob :: !ByteString

data SDUHeader Source #

Constructors

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

newtype SDUSize Source #

Constructors

SDUSize
Fields getSDUSize :: Word16

Instances

Instances details

Enum SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

succ :: SDUSize -> SDUSize #

pred :: SDUSize -> SDUSize #

toEnum :: Int -> SDUSize #

fromEnum :: SDUSize -> Int #

enumFrom :: SDUSize -> [SDUSize] #

enumFromThen :: SDUSize -> SDUSize -> [SDUSize] #

enumFromTo :: SDUSize -> SDUSize -> [SDUSize] #

enumFromThenTo :: SDUSize -> SDUSize -> SDUSize -> [SDUSize] #

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.7-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 #

Num SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

(+) :: SDUSize -> SDUSize -> SDUSize #

(-) :: SDUSize -> SDUSize -> SDUSize #

(*) :: SDUSize -> SDUSize -> SDUSize #

negate :: SDUSize -> SDUSize #

abs :: SDUSize -> SDUSize #

signum :: SDUSize -> SDUSize #

fromInteger :: Integer -> SDUSize #

Integral SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

quot :: SDUSize -> SDUSize -> SDUSize #

rem :: SDUSize -> SDUSize -> SDUSize #

div :: SDUSize -> SDUSize -> SDUSize #

mod :: SDUSize -> SDUSize -> SDUSize #

quotRem :: SDUSize -> SDUSize -> (SDUSize, SDUSize) #

divMod :: SDUSize -> SDUSize -> (SDUSize, SDUSize) #

toInteger :: SDUSize -> Integer #

Real SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

toRational :: SDUSize -> Rational #

Show SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

showsPrec :: Int -> SDUSize -> ShowS #

show :: SDUSize -> String #

showList :: [SDUSize] -> ShowS #

Eq SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

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

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

Ord SDUSize Source #

Instance details

Defined in Network.Mux.Types

Methods

compare :: SDUSize -> SDUSize -> Ordering #

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

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

(>) :: SDUSize -> SDUSize -> Bool #

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

max :: SDUSize -> SDUSize -> SDUSize #

min :: SDUSize -> SDUSize -> SDUSize #

type Rep SDUSize Source #

Instance details

Defined in Network.Mux.Types

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

msTimestamp :: SDU -> RemoteClockModel Source #

setTimestamp :: SDU -> RemoteClockModel -> SDU Source #

msNum :: SDU -> MiniProtocolNum Source #

msDir :: SDU -> MiniProtocolDir Source #

msLength :: SDU -> 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 RuntimeError Source #

Constructors

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

Instances

Instances details

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