Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Mux

Contents

Re-exports

Synopsis

data MuxMode where
- InitiatorMode :: MuxMode
- ResponderMode :: MuxMode
- InitiatorResponderMode :: MuxMode
newtype OuroborosApplication (mode :: MuxMode ) addr bytes m a b = OuroborosApplication ( ConnectionId addr -> ControlMessageSTM m -> [ MiniProtocol mode bytes m a b])
type MuxProtocolBundle (mode :: MuxMode ) addr bytes m a b = ConnectionId addr -> ControlMessageSTM m -> [ MiniProtocol mode bytes m a b]
data ProtocolTemperature
- = Established
- | Warm
- | Hot
data TokProtocolTemperature (pt :: ProtocolTemperature ) where
- TokHot :: TokProtocolTemperature Hot
- TokWarm :: TokProtocolTemperature Warm
- TokEstablished :: TokProtocolTemperature Established
data SomeTokProtocolTemperature where
- SomeTokProtocolTemperature :: TokProtocolTemperature pt -> SomeTokProtocolTemperature
data WithProtocolTemperature (pt :: ProtocolTemperature ) a where
- WithHot :: !a -> WithProtocolTemperature Hot a
- WithWarm :: !a -> WithProtocolTemperature Warm a
- WithEstablished :: !a -> WithProtocolTemperature Established a
withoutProtocolTemperature :: WithProtocolTemperature pt a -> a
data WithSomeProtocolTemperature a where
- WithSomeProtocolTemperature :: WithProtocolTemperature pt a -> WithSomeProtocolTemperature a
withoutSomeProtocolTemperature :: WithSomeProtocolTemperature a -> a
data Bundle a = Bundle {
- withHot :: !( WithProtocolTemperature Hot a)
- withWarm :: !( WithProtocolTemperature Warm a)
- withEstablished :: !( WithProtocolTemperature Established a)
}
projectBundle :: TokProtocolTemperature pt -> Bundle a -> a
type OuroborosBundle (mode :: MuxMode ) addr bytes m a b = Bundle ( MuxProtocolBundle mode addr bytes m a b)
type MuxBundle (mode :: MuxMode ) bytes m a b = Bundle [ MiniProtocol mode bytes m a b]
data MiniProtocol (mode :: MuxMode ) bytes m a b = MiniProtocol {
- miniProtocolNum :: ! MiniProtocolNum
- miniProtocolLimits :: ! MiniProtocolLimits
- miniProtocolRun :: !( RunMiniProtocol mode bytes m a b)
}
newtype MiniProtocolNum = MiniProtocolNum Word16
data MiniProtocolLimits = MiniProtocolLimits {
- maximumIngressQueue :: ! Int
}
data RunMiniProtocol (mode :: MuxMode ) bytes m a b where
- InitiatorProtocolOnly :: MuxPeer bytes m a -> RunMiniProtocol InitiatorMode bytes m a Void
- ResponderProtocolOnly :: MuxPeer bytes m b -> RunMiniProtocol ResponderMode bytes m Void b
- InitiatorAndResponderProtocol :: MuxPeer bytes m a -> MuxPeer bytes m b -> RunMiniProtocol InitiatorResponderMode bytes m a b
data MuxPeer bytes m a where
- MuxPeer :: forall (pr :: PeerRole ) ps (st :: ps) failure bytes m a. ( Show failure, forall (st' :: ps). Show ( ClientHasAgency st'), forall (st' :: ps). Show ( ServerHasAgency st'), ShowProxy ps) => Tracer m ( TraceSendRecv ps) -> Codec ps failure m bytes -> Peer ps pr st m a -> MuxPeer bytes m a
- MuxPeerPipelined :: forall (pr :: PeerRole ) ps (st :: ps) failure bytes m a. ( Show failure, forall (st' :: ps). Show ( ClientHasAgency st'), forall (st' :: ps). Show ( ServerHasAgency st'), ShowProxy ps) => Tracer m ( TraceSendRecv ps) -> Codec ps failure m bytes -> PeerPipelined ps pr st m a -> MuxPeer bytes m a
- MuxPeerRaw :: ( Channel m bytes -> m (a, Maybe bytes)) -> MuxPeer bytes m a
runMuxPeer :: ( MonadCatch m, MonadAsync m) => MuxPeer bytes m a -> Channel m bytes -> m (a, Maybe bytes)
toApplication :: ( MonadCatch m, MonadAsync m) => ConnectionId addr -> ControlMessageSTM m -> OuroborosApplication mode addr ByteString m a b -> MuxApplication mode m a b
mkMuxApplicationBundle :: forall mode addr bytes m a b. ConnectionId addr -> Bundle ( ControlMessageSTM m) -> OuroborosBundle mode addr bytes m a b -> MuxBundle mode bytes m a b
mkMiniProtocolBundle :: MuxBundle mode bytes m a b -> MiniProtocolBundle mode
data ControlMessage
- = Continue
- | Quiesce
- | Terminate
type ControlMessageSTM m = STM m ControlMessage
continueForever :: Applicative ( STM m) => proxy m -> ControlMessageSTM m
timeoutWithControlMessage :: MonadSTM m => ControlMessageSTM m -> STM m a -> m ( Maybe a)
data MuxError = MuxError {
- errorType :: ! MuxErrorType
- errorMsg :: ! String
}
data MuxErrorType
- = MuxUnknownMiniProtocol
- | MuxDecodeError
- | MuxBearerClosed
- | MuxIngressQueueOverRun
- | MuxInitiatorOnly
- | MuxIOException IOException
- | MuxSDUReadTimeout
- | MuxSDUWriteTimeout
- | MuxShutdown !( Maybe MuxErrorType )
- | MuxCleanShutdown
type family HasInitiator (mode :: MuxMode ) :: Bool where ...
type family HasResponder (mode :: MuxMode ) :: Bool where ...

Documentation

data MuxMode where Source #

Constructors

InitiatorMode :: MuxMode
ResponderMode :: MuxMode
InitiatorResponderMode :: MuxMode

newtype OuroborosApplication (mode :: MuxMode ) addr bytes m a b Source #

Like MuxApplication but using a MuxPeer rather than a raw Channel -> m a action.

Constructors

OuroborosApplication ( ConnectionId addr -> ControlMessageSTM m -> [ MiniProtocol mode bytes m a b])

type MuxProtocolBundle (mode :: MuxMode ) addr bytes m a b = ConnectionId addr -> ControlMessageSTM m -> [ MiniProtocol mode bytes m a b] Source #

data ProtocolTemperature Source #

There are three kinds of applications: warm, hot and established (ones that run in for both warm and hot peers).

Constructors

Established
Warm
Hot

Instances

Instances details

Eq ProtocolTemperature Source #
Instance details Defined in Ouroboros.Network.Mux Methods (==) :: ProtocolTemperature -> ProtocolTemperature -> Bool Source # (/=) :: ProtocolTemperature -> ProtocolTemperature -> Bool Source #
Ord ProtocolTemperature Source #
Instance details Defined in Ouroboros.Network.Mux Methods compare :: ProtocolTemperature -> ProtocolTemperature -> Ordering Source # (<) :: ProtocolTemperature -> ProtocolTemperature -> Bool Source # (<=) :: ProtocolTemperature -> ProtocolTemperature -> Bool Source # (>) :: ProtocolTemperature -> ProtocolTemperature -> Bool Source # (>=) :: ProtocolTemperature -> ProtocolTemperature -> Bool Source # max :: ProtocolTemperature -> ProtocolTemperature -> ProtocolTemperature Source # min :: ProtocolTemperature -> ProtocolTemperature -> ProtocolTemperature Source #
Show ProtocolTemperature Source #
Instance details Defined in Ouroboros.Network.Mux Methods showsPrec :: Int -> ProtocolTemperature -> ShowS Source # show :: ProtocolTemperature -> String Source # showList :: [ ProtocolTemperature ] -> ShowS Source #

data TokProtocolTemperature (pt :: ProtocolTemperature ) where Source #

Singletons for AppKind

Constructors

TokHot :: TokProtocolTemperature Hot
TokWarm :: TokProtocolTemperature Warm
TokEstablished :: TokProtocolTemperature Established

data SomeTokProtocolTemperature where Source #

Constructors

SomeTokProtocolTemperature :: TokProtocolTemperature pt -> SomeTokProtocolTemperature

data WithProtocolTemperature (pt :: ProtocolTemperature ) a where Source #

We keep hot, warm and established application (or their context) distinct. It's only needed for a handly projectBundle map.

Constructors

WithHot :: !a -> WithProtocolTemperature Hot a
WithWarm :: !a -> WithProtocolTemperature Warm a
WithEstablished :: !a -> WithProtocolTemperature Established a

Instances

Instances details

Functor ( WithProtocolTemperature pt) Source #
Instance details Defined in Ouroboros.Network.Mux Methods fmap :: (a -> b) -> WithProtocolTemperature pt a -> WithProtocolTemperature pt b Source # (<$) :: a -> WithProtocolTemperature pt b -> WithProtocolTemperature pt a Source #
Applicative ( WithProtocolTemperature ' Established ) Source #
Instance details Defined in Ouroboros.Network.Mux Methods pure :: a -> WithProtocolTemperature ' Established a Source # (<>) :: WithProtocolTemperature ' Established (a -> b) -> WithProtocolTemperature ' Established a -> WithProtocolTemperature ' Established b Source # liftA2 :: (a -> b -> c) -> WithProtocolTemperature ' Established a -> WithProtocolTemperature ' Established b -> WithProtocolTemperature ' Established c Source # (>) :: WithProtocolTemperature ' Established a -> WithProtocolTemperature ' Established b -> WithProtocolTemperature ' Established b Source # (<*) :: WithProtocolTemperature ' Established a -> WithProtocolTemperature ' Established b -> WithProtocolTemperature ' Established a Source #
Applicative ( WithProtocolTemperature ' Warm ) Source #
Instance details Defined in Ouroboros.Network.Mux Methods pure :: a -> WithProtocolTemperature ' Warm a Source # (<>) :: WithProtocolTemperature ' Warm (a -> b) -> WithProtocolTemperature ' Warm a -> WithProtocolTemperature ' Warm b Source # liftA2 :: (a -> b -> c) -> WithProtocolTemperature ' Warm a -> WithProtocolTemperature ' Warm b -> WithProtocolTemperature ' Warm c Source # (>) :: WithProtocolTemperature ' Warm a -> WithProtocolTemperature ' Warm b -> WithProtocolTemperature ' Warm b Source # (<*) :: WithProtocolTemperature ' Warm a -> WithProtocolTemperature ' Warm b -> WithProtocolTemperature ' Warm a Source #
Applicative ( WithProtocolTemperature ' Hot ) Source #
Instance details Defined in Ouroboros.Network.Mux Methods pure :: a -> WithProtocolTemperature ' Hot a Source # (<>) :: WithProtocolTemperature ' Hot (a -> b) -> WithProtocolTemperature ' Hot a -> WithProtocolTemperature ' Hot b Source # liftA2 :: (a -> b -> c) -> WithProtocolTemperature ' Hot a -> WithProtocolTemperature ' Hot b -> WithProtocolTemperature ' Hot c Source # (>) :: WithProtocolTemperature ' Hot a -> WithProtocolTemperature ' Hot b -> WithProtocolTemperature ' Hot b Source # (<*) :: WithProtocolTemperature ' Hot a -> WithProtocolTemperature ' Hot b -> WithProtocolTemperature ' Hot a Source #
Foldable ( WithProtocolTemperature pt) Source #
Instance details Defined in Ouroboros.Network.Mux Methods fold :: Monoid m => WithProtocolTemperature pt m -> m Source # foldMap :: Monoid m => (a -> m) -> WithProtocolTemperature pt a -> m Source # foldMap' :: Monoid m => (a -> m) -> WithProtocolTemperature pt a -> m Source # foldr :: (a -> b -> b) -> b -> WithProtocolTemperature pt a -> b Source # foldr' :: (a -> b -> b) -> b -> WithProtocolTemperature pt a -> b Source # foldl :: (b -> a -> b) -> b -> WithProtocolTemperature pt a -> b Source # foldl' :: (b -> a -> b) -> b -> WithProtocolTemperature pt a -> b Source # foldr1 :: (a -> a -> a) -> WithProtocolTemperature pt a -> a Source # foldl1 :: (a -> a -> a) -> WithProtocolTemperature pt a -> a Source # toList :: WithProtocolTemperature pt a -> [a] Source # null :: WithProtocolTemperature pt a -> Bool Source # length :: WithProtocolTemperature pt a -> Int Source # elem :: Eq a => a -> WithProtocolTemperature pt a -> Bool Source # maximum :: Ord a => WithProtocolTemperature pt a -> a Source # minimum :: Ord a => WithProtocolTemperature pt a -> a Source # sum :: Num a => WithProtocolTemperature pt a -> a Source # product :: Num a => WithProtocolTemperature pt a -> a Source #
Traversable ( WithProtocolTemperature pt) Source #
Instance details Defined in Ouroboros.Network.Mux Methods traverse :: Applicative f => (a -> f b) -> WithProtocolTemperature pt a -> f ( WithProtocolTemperature pt b) Source # sequenceA :: Applicative f => WithProtocolTemperature pt (f a) -> f ( WithProtocolTemperature pt a) Source # mapM :: Monad m => (a -> m b) -> WithProtocolTemperature pt a -> m ( WithProtocolTemperature pt b) Source # sequence :: Monad m => WithProtocolTemperature pt (m a) -> m ( WithProtocolTemperature pt a) Source #
Eq a => Eq ( WithProtocolTemperature pt a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods (==) :: WithProtocolTemperature pt a -> WithProtocolTemperature pt a -> Bool Source # (/=) :: WithProtocolTemperature pt a -> WithProtocolTemperature pt a -> Bool Source #
Show a => Show ( WithProtocolTemperature pt a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods showsPrec :: Int -> WithProtocolTemperature pt a -> ShowS Source # show :: WithProtocolTemperature pt a -> String Source # showList :: [ WithProtocolTemperature pt a] -> ShowS Source #
Semigroup a => Semigroup ( WithProtocolTemperature pt a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods (<>) :: WithProtocolTemperature pt a -> WithProtocolTemperature pt a -> WithProtocolTemperature pt a Source # sconcat :: NonEmpty ( WithProtocolTemperature pt a) -> WithProtocolTemperature pt a Source # stimes :: Integral b => b -> WithProtocolTemperature pt a -> WithProtocolTemperature pt a Source #
Monoid a => Monoid ( WithProtocolTemperature ' Established a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods mempty :: WithProtocolTemperature ' Established a Source # mappend :: WithProtocolTemperature ' Established a -> WithProtocolTemperature ' Established a -> WithProtocolTemperature ' Established a Source # mconcat :: [ WithProtocolTemperature ' Established a] -> WithProtocolTemperature ' Established a Source #
Monoid a => Monoid ( WithProtocolTemperature ' Warm a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods mempty :: WithProtocolTemperature ' Warm a Source # mappend :: WithProtocolTemperature ' Warm a -> WithProtocolTemperature ' Warm a -> WithProtocolTemperature ' Warm a Source # mconcat :: [ WithProtocolTemperature ' Warm a] -> WithProtocolTemperature ' Warm a Source #
Monoid a => Monoid ( WithProtocolTemperature ' Hot a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods mempty :: WithProtocolTemperature ' Hot a Source # mappend :: WithProtocolTemperature ' Hot a -> WithProtocolTemperature ' Hot a -> WithProtocolTemperature ' Hot a Source # mconcat :: [ WithProtocolTemperature ' Hot a] -> WithProtocolTemperature ' Hot a Source #

withoutProtocolTemperature :: WithProtocolTemperature pt a -> a Source #

data WithSomeProtocolTemperature a where Source #

Constructors

WithSomeProtocolTemperature :: WithProtocolTemperature pt a -> WithSomeProtocolTemperature a

Instances

Instances details

Functor WithSomeProtocolTemperature Source #
Instance details Defined in Ouroboros.Network.Mux Methods fmap :: (a -> b) -> WithSomeProtocolTemperature a -> WithSomeProtocolTemperature b Source # (<$) :: a -> WithSomeProtocolTemperature b -> WithSomeProtocolTemperature a Source #
Show a => Show ( WithSomeProtocolTemperature a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods showsPrec :: Int -> WithSomeProtocolTemperature a -> ShowS Source # show :: WithSomeProtocolTemperature a -> String Source # showList :: [ WithSomeProtocolTemperature a] -> ShowS Source #

withoutSomeProtocolTemperature :: WithSomeProtocolTemperature a -> a Source #

data Bundle a Source #

A bundle of HotApp , WarmApp and EstablishedApp .

Constructors

Bundle
Fields withHot :: !( WithProtocolTemperature Hot a) hot mini-protocols withWarm :: !( WithProtocolTemperature Warm a) warm mini-protocols withEstablished :: !( WithProtocolTemperature Established a) established mini-protocols

Instances

Instances details

Functor Bundle Source #
Instance details Defined in Ouroboros.Network.Mux Methods fmap :: (a -> b) -> Bundle a -> Bundle b Source # (<$) :: a -> Bundle b -> Bundle a Source #
Applicative Bundle Source #
Instance details Defined in Ouroboros.Network.Mux Methods pure :: a -> Bundle a Source # (<>) :: Bundle (a -> b) -> Bundle a -> Bundle b Source # liftA2 :: (a -> b -> c) -> Bundle a -> Bundle b -> Bundle c Source # (>) :: Bundle a -> Bundle b -> Bundle b Source # (<*) :: Bundle a -> Bundle b -> Bundle a Source #
Foldable Bundle Source #
Instance details Defined in Ouroboros.Network.Mux Methods fold :: Monoid m => Bundle m -> m Source # foldMap :: Monoid m => (a -> m) -> Bundle a -> m Source # foldMap' :: Monoid m => (a -> m) -> Bundle a -> m Source # foldr :: (a -> b -> b) -> b -> Bundle a -> b Source # foldr' :: (a -> b -> b) -> b -> Bundle a -> b Source # foldl :: (b -> a -> b) -> b -> Bundle a -> b Source # foldl' :: (b -> a -> b) -> b -> Bundle a -> b Source # foldr1 :: (a -> a -> a) -> Bundle a -> a Source # foldl1 :: (a -> a -> a) -> Bundle a -> a Source # toList :: Bundle a -> [a] Source # null :: Bundle a -> Bool Source # length :: Bundle a -> Int Source # elem :: Eq a => a -> Bundle a -> Bool Source # maximum :: Ord a => Bundle a -> a Source # minimum :: Ord a => Bundle a -> a Source # sum :: Num a => Bundle a -> a Source # product :: Num a => Bundle a -> a Source #
Traversable Bundle Source #
Instance details Defined in Ouroboros.Network.Mux Methods traverse :: Applicative f => (a -> f b) -> Bundle a -> f ( Bundle b) Source # sequenceA :: Applicative f => Bundle (f a) -> f ( Bundle a) Source # mapM :: Monad m => (a -> m b) -> Bundle a -> m ( Bundle b) Source # sequence :: Monad m => Bundle (m a) -> m ( Bundle a) Source #
Eq a => Eq ( Bundle a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods (==) :: Bundle a -> Bundle a -> Bool Source # (/=) :: Bundle a -> Bundle a -> Bool Source #
Show a => Show ( Bundle a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods showsPrec :: Int -> Bundle a -> ShowS Source # show :: Bundle a -> String Source # showList :: [ Bundle a] -> ShowS Source #
Semigroup a => Semigroup ( Bundle a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods (<>) :: Bundle a -> Bundle a -> Bundle a Source # sconcat :: NonEmpty ( Bundle a) -> Bundle a Source # stimes :: Integral b => b -> Bundle a -> Bundle a Source #
Monoid a => Monoid ( Bundle a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods mempty :: Bundle a Source # mappend :: Bundle a -> Bundle a -> Bundle a Source # mconcat :: [ Bundle a] -> Bundle a Source #

projectBundle :: TokProtocolTemperature pt -> Bundle a -> a Source #

type OuroborosBundle (mode :: MuxMode ) addr bytes m a b = Bundle ( MuxProtocolBundle mode addr bytes m a b) Source #

type MuxBundle (mode :: MuxMode ) bytes m a b = Bundle [ MiniProtocol mode bytes m a b] Source #

data MiniProtocol (mode :: MuxMode ) bytes m a b Source #

Constructors

MiniProtocol
Fields miniProtocolNum :: ! MiniProtocolNum miniProtocolLimits :: ! MiniProtocolLimits miniProtocolRun :: !( RunMiniProtocol mode bytes m a b)

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
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
Instance details Defined in Network.Mux.Types Methods (==) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source # (/=) :: MiniProtocolNum -> MiniProtocolNum -> Bool Source #
Ord MiniProtocolNum
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
Instance details Defined in Network.Mux.Types Methods showsPrec :: Int -> MiniProtocolNum -> ShowS Source # show :: MiniProtocolNum -> String Source # showList :: [ MiniProtocolNum ] -> ShowS Source #
Ix MiniProtocolNum
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 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 RunMiniProtocol (mode :: MuxMode ) bytes m a b where Source #

Constructors

InitiatorProtocolOnly :: MuxPeer bytes m a -> RunMiniProtocol InitiatorMode bytes m a Void
ResponderProtocolOnly :: MuxPeer bytes m b -> RunMiniProtocol ResponderMode bytes m Void b
InitiatorAndResponderProtocol :: MuxPeer bytes m a -> MuxPeer bytes m b -> RunMiniProtocol InitiatorResponderMode bytes m a b

data MuxPeer bytes m a where Source #

Constructors

MuxPeer :: forall (pr :: PeerRole ) ps (st :: ps) failure bytes m a. ( Show failure, forall (st' :: ps). Show ( ClientHasAgency st'), forall (st' :: ps). Show ( ServerHasAgency st'), ShowProxy ps) => Tracer m ( TraceSendRecv ps) -> Codec ps failure m bytes -> Peer ps pr st m a -> MuxPeer bytes m a
MuxPeerPipelined :: forall (pr :: PeerRole ) ps (st :: ps) failure bytes m a. ( Show failure, forall (st' :: ps). Show ( ClientHasAgency st'), forall (st' :: ps). Show ( ServerHasAgency st'), ShowProxy ps) => Tracer m ( TraceSendRecv ps) -> Codec ps failure m bytes -> PeerPipelined ps pr st m a -> MuxPeer bytes m a
MuxPeerRaw :: ( Channel m bytes -> m (a, Maybe bytes)) -> MuxPeer bytes m a

runMuxPeer :: ( MonadCatch m, MonadAsync m) => MuxPeer bytes m a -> Channel m bytes -> m (a, Maybe bytes) Source #

Run a MuxPeer using either runPeer or runPipelinedPeer .

toApplication :: ( MonadCatch m, MonadAsync m) => ConnectionId addr -> ControlMessageSTM m -> OuroborosApplication mode addr ByteString m a b -> MuxApplication mode m a b Source #

mkMuxApplicationBundle :: forall mode addr bytes m a b. ConnectionId addr -> Bundle ( ControlMessageSTM m) -> OuroborosBundle mode addr bytes m a b -> MuxBundle mode bytes m a b Source #

mkMiniProtocolBundle :: MuxBundle mode bytes m a b -> MiniProtocolBundle mode Source #

Make MiniProtocolBundle , which is used to create a mux interface with newMux . The output of mkMuxApplicationBundle can be used as input.

data ControlMessage Source #

Control signal sent to a mini-protocol. expected to exit, on Continue it should continue its operation

Constructors

Continue	Continue operation.
Quiesce	Hold on, e.g. do not sent messages until resumed. This is not used for any hot protocol.
Terminate	The client is expected to terminate as soon as possible.

Instances

Instances details

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

type ControlMessageSTM m = STM m ControlMessage Source #

ControlMessageSTM should depend on muxMode (we only need to shedule stop for intiator side). This is not done only because this would break tests, but once the old api is removed it should be possible.

continueForever :: Applicative ( STM m) => proxy m -> ControlMessageSTM m Source #

timeoutWithControlMessage :: MonadSTM m => ControlMessageSTM m -> STM m a -> m ( Maybe a) Source #

First to finish synchronisation between Terminate state of ControlMessage and an stm action.

This should return STM m (Maybe a) but STM is a non-injective type family, and we would need to pass Proxy m to fix an ambiuous type (or use AllowAmbiguousTypes extension).

Re-exports

from Network.Mux

data MuxError Source #

Error type used in across the mux layer.

Constructors

MuxError
Fields errorType :: ! MuxErrorType errorMsg :: ! String

Instances

Instances details

Show MuxError
Instance details Defined in Network.Mux.Trace Methods showsPrec :: Int -> MuxError -> ShowS Source # show :: MuxError -> String Source # showList :: [ MuxError ] -> ShowS Source #
Generic MuxError
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
Instance details Defined in Network.Mux.Trace Methods toException :: MuxError -> SomeException Source # fromException :: SomeException -> Maybe MuxError Source # displayException :: MuxError -> String Source #
type Rep MuxError
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
Instance details Defined in Network.Mux.Trace Methods (==) :: MuxErrorType -> MuxErrorType -> Bool Source # (/=) :: MuxErrorType -> MuxErrorType -> Bool Source #
Show MuxErrorType
Instance details Defined in Network.Mux.Trace Methods showsPrec :: Int -> MuxErrorType -> ShowS Source # show :: MuxErrorType -> String Source # showList :: [ MuxErrorType ] -> ShowS Source #

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