Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Mux

Contents

Basic notions
Mux mini-protocol callback
Mux mini-protocol callback in MuxMode
MiniProtocol description
MiniProtocol bundle
Non-P2P API
Re-exports
Deprecated APIs

Synopsis

data MuxMode where
- InitiatorMode ∷ MuxMode
- ResponderMode ∷ MuxMode
- InitiatorResponderMode ∷ MuxMode
data ProtocolTemperature
- = Established
- | Warm
- | Hot
data SingProtocolTemperature (pt ∷ ProtocolTemperature) where
- SingHot ∷ SingProtocolTemperature Hot
- SingWarm ∷ SingProtocolTemperature Warm
- SingEstablished ∷ SingProtocolTemperature Established
data SomeTokProtocolTemperature where
- SomeTokProtocolTemperature ∷ SingProtocolTemperature 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 TemperatureBundle a = TemperatureBundle {
- withHot ∷ !(WithProtocolTemperature Hot a)
- withWarm ∷ !(WithProtocolTemperature Warm a)
- withEstablished ∷ !(WithProtocolTemperature Established a)
}
projectBundle ∷ SingProtocolTemperature pt → TemperatureBundle a → a
data MiniProtocolCb ctx bytes m a where
- MiniProtocolCb ∷ (ctx → Channel m bytes → m (a, Maybe bytes)) → MiniProtocolCb ctx bytes m a
- MuxPeer ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure ctx bytes m a. (Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, Peer ps pr st m a)) → MiniProtocolCb ctx bytes m a
- MuxPeerPipelined ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure ctx bytes m a. (Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, PeerPipelined ps pr st m a)) → MiniProtocolCb ctx bytes m a
- pattern MuxPeerRaw ∷ ∀ ctx bytes m a. (ctx → Channel m bytes → m (a, Maybe bytes)) → MiniProtocolCb ctx bytes m a
runMiniProtocolCb ∷ (MonadAsync m, MonadThrow m) ⇒ MiniProtocolCb ctx ByteString m a → ctx → Channel m → m (a, Maybe ByteString)
mkMiniProtocolCbFromPeer ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure bytes ctx m a. (MonadThrow m, Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, Peer ps pr st m a)) → MiniProtocolCb ctx bytes m a
mkMiniProtocolCbFromPeerPipelined ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure ctx bytes m a. (MonadAsync m, MonadThrow m, Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, PeerPipelined ps pr st m a)) → MiniProtocolCb ctx bytes m a
data RunMiniProtocol (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b where
- InitiatorProtocolOnly ∷ MiniProtocolCb initiatorCtx bytes m a → RunMiniProtocol InitiatorMode initiatorCtx responderCtx bytes m a Void
- ResponderProtocolOnly ∷ MiniProtocolCb responderCtx bytes m b → RunMiniProtocol ResponderMode initiatorCtx responderCtx bytes m Void b
- InitiatorAndResponderProtocol ∷ MiniProtocolCb initiatorCtx bytes m a → MiniProtocolCb responderCtx bytes m b → RunMiniProtocol InitiatorResponderMode initiatorCtx responderCtx bytes m a b
type RunMiniProtocolWithExpandedCtx mode peerAddr bytes m a b = RunMiniProtocol mode (ExpandedInitiatorContext peerAddr m) (ResponderContext peerAddr) bytes m a b
type RunMiniProtocolWithMinimalCtx mode peerAddr bytes m a b = RunMiniProtocol mode (MinimalInitiatorContext peerAddr) (ResponderContext peerAddr) bytes m a b
data MiniProtocol (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b = MiniProtocol {
- miniProtocolNum ∷ !MiniProtocolNum
- miniProtocolLimits ∷ !MiniProtocolLimits
- miniProtocolRun ∷ !(RunMiniProtocol mode initiatorCtx responderCtx bytes m a b)
}
type MiniProtocolWithExpandedCtx mode peerAddr bytes m a b = MiniProtocol mode (ExpandedInitiatorContext peerAddr m) (ResponderContext peerAddr) bytes m a b
type MiniProtocolWithMinimalCtx mode peerAddr bytes m a b = MiniProtocol mode (MinimalInitiatorContext peerAddr) (ResponderContext peerAddr) bytes m a b
newtype MiniProtocolNum = MiniProtocolNum Word16
newtype MiniProtocolLimits = MiniProtocolLimits {
- maximumIngressQueue ∷ Int
}
type OuroborosBundle (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b = TemperatureBundle [MiniProtocol mode initiatorCtx responderCtx bytes m a b]
type OuroborosBundleWithExpandedCtx (mode ∷ MuxMode) peerAddr bytes m a b = OuroborosBundle mode (ExpandedInitiatorContext peerAddr m) (ResponderContext peerAddr) bytes m a b
newtype OuroborosApplication (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b = OuroborosApplication [MiniProtocol mode initiatorCtx responderCtx bytes m a b]
type OuroborosApplicationWithMinimalCtx mode peerAddr bytes m a b = OuroborosApplication mode (MinimalInitiatorContext peerAddr) (ResponderContext peerAddr) bytes m a b
toApplication ∷ ∀ mode initiatorCtx responderCtx m a b. (MonadAsync m, MonadThrow m) ⇒ initiatorCtx → responderCtx → OuroborosApplication mode initiatorCtx responderCtx ByteString m a b → MuxApplication mode m a b
mkMiniProtocolBundle ∷ OuroborosBundle mode initiatorCtx responderCtx bytes m a b → MiniProtocolBundle mode
fromOuroborosBundle ∷ OuroborosBundle mode initiatorCtx responderCtx bytes m a b → OuroborosApplication mode initiatorCtx responderCtx bytes m a b
contramapInitiatorCtx ∷ (initiatorCtx' → initiatorCtx) → OuroborosApplication mode initiatorCtx responderCtx bytes m a b → OuroborosApplication mode initiatorCtx' responderCtx bytes m a b
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 ...
type MuxPeer = MiniProtocolCb
runMuxPeer ∷ MiniProtocolCb ctx bytes m a → ctx → Channel m bytes → m (a, Maybe bytes)

Basic notions

data MuxMode where Source #

Constructors

InitiatorMode ∷ MuxMode
ResponderMode ∷ MuxMode
InitiatorResponderMode ∷ MuxMode

data ProtocolTemperature Source #

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

Constructors

Established
Warm
Hot

Instances

Instances details

Show ProtocolTemperature Source #
Instance details Defined in Ouroboros.Network.Mux Methods showsPrec ∷ Int → ProtocolTemperature → ShowS Source # show ∷ ProtocolTemperature → String Source # showList ∷ [ProtocolTemperature] → ShowS Source #
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 #

data SingProtocolTemperature (pt ∷ ProtocolTemperature) where Source #

Singletons for ProtocolTemperature.

Constructors

SingHot ∷ SingProtocolTemperature Hot
SingWarm ∷ SingProtocolTemperature Warm
SingEstablished ∷ SingProtocolTemperature Established

data SomeTokProtocolTemperature where Source #

Constructors

SomeTokProtocolTemperature ∷ SingProtocolTemperature 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 handy projectBundle map.

Constructors

WithHot ∷ !a → WithProtocolTemperature Hot a
WithWarm ∷ !a → WithProtocolTemperature Warm a
WithEstablished ∷ !a → WithProtocolTemperature Established a

Instances

Instances details

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 #
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 '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 #
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 #
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 #
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 '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 #
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 #
Semigroup a ⇒ Semigroup (WithProtocolTemperature 'Established a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods (<>) ∷ WithProtocolTemperature 'Established a → WithProtocolTemperature 'Established a → WithProtocolTemperature 'Established a Source # sconcat ∷ NonEmpty (WithProtocolTemperature 'Established a) → WithProtocolTemperature 'Established a Source # stimes ∷ Integral b ⇒ b → WithProtocolTemperature 'Established a → WithProtocolTemperature 'Established a Source #
Semigroup a ⇒ Semigroup (WithProtocolTemperature 'Hot a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods (<>) ∷ WithProtocolTemperature 'Hot a → WithProtocolTemperature 'Hot a → WithProtocolTemperature 'Hot a Source # sconcat ∷ NonEmpty (WithProtocolTemperature 'Hot a) → WithProtocolTemperature 'Hot a Source # stimes ∷ Integral b ⇒ b → WithProtocolTemperature 'Hot a → WithProtocolTemperature 'Hot a Source #
Semigroup a ⇒ Semigroup (WithProtocolTemperature 'Warm a) Source #
Instance details Defined in Ouroboros.Network.Mux Methods (<>) ∷ WithProtocolTemperature 'Warm a → WithProtocolTemperature 'Warm a → WithProtocolTemperature 'Warm a Source # sconcat ∷ NonEmpty (WithProtocolTemperature 'Warm a) → WithProtocolTemperature 'Warm a Source # stimes ∷ Integral b ⇒ b → WithProtocolTemperature 'Warm a → WithProtocolTemperature 'Warm a 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 #
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 #

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 TemperatureBundle a Source #

A bundle of HotApp, WarmApp and EstablishedApp.

Constructors

TemperatureBundle
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

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

projectBundle ∷ SingProtocolTemperature pt → TemperatureBundle a → a Source #

Mux mini-protocol callback

data MiniProtocolCb ctx bytes m a where Source #

A callback executed by each muxed mini-protocol.

Constructors

MiniProtocolCb ∷ (ctx → Channel m bytes → m (a, Maybe bytes)) → MiniProtocolCb ctx bytes m a
MuxPeer ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure ctx bytes m a. (Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, Peer ps pr st m a)) → MiniProtocolCb ctx bytes m a	Deprecated: Use either `MiniProtocolCb` type instead of `MiniProtocolCb` type, or`mkMiniProtocolCbFromPeer` instead the `MiniProtocolCb` constructor.
MuxPeerPipelined ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure ctx bytes m a. (Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, PeerPipelined ps pr st m a)) → MiniProtocolCb ctx bytes m a	Deprecated: Use mkMiniProtocolCbFromPeer instead

Bundled Patterns

pattern MuxPeerRaw ∷ ∀ ctx bytes m a. (ctx → Channel m bytes → m (a, Maybe bytes)) → MiniProtocolCb ctx bytes m a

Deprecated: Use MiniProtocolCb instead

runMiniProtocolCb ∷ (MonadAsync m, MonadThrow m) ⇒ MiniProtocolCb ctx ByteString m a → ctx → Channel m → m (a, Maybe ByteString) Source #

Run a MiniProtocolCb using supplied ctx and Channel

mkMiniProtocolCbFromPeer ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure bytes ctx m a. (MonadThrow m, Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, Peer ps pr st m a)) → MiniProtocolCb ctx bytes m a Source #

Create a MiniProtocolCb from a tracer, codec and Peer.

mkMiniProtocolCbFromPeerPipelined ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure ctx bytes m a. (MonadAsync m, MonadThrow m, Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ (ctx → (Tracer m (TraceSendRecv ps), Codec ps failure m bytes, PeerPipelined ps pr st m a)) → MiniProtocolCb ctx bytes m a Source #

Create a MiniProtocolCb from a tracer, codec and PeerPipelined.

Mux mini-protocol callback in MuxMode

data RunMiniProtocol (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b where Source #

RunMiniProtocol. It also capture context (the IsBigLedgerPeer) which is passed to the mini-protocol when a mini-protocol is started.

Constructors

InitiatorProtocolOnly ∷ MiniProtocolCb initiatorCtx bytes m a → RunMiniProtocol InitiatorMode initiatorCtx responderCtx bytes m a Void
ResponderProtocolOnly ∷ MiniProtocolCb responderCtx bytes m b → RunMiniProtocol ResponderMode initiatorCtx responderCtx bytes m Void b
InitiatorAndResponderProtocol ∷ MiniProtocolCb initiatorCtx bytes m a → MiniProtocolCb responderCtx bytes m b → RunMiniProtocol InitiatorResponderMode initiatorCtx responderCtx bytes m a b

type RunMiniProtocolWithExpandedCtx mode peerAddr bytes m a b = RunMiniProtocol mode (ExpandedInitiatorContext peerAddr m) (ResponderContext peerAddr) bytes m a b Source #

RunMiniProtocol with ExpandedInitiatorContext and ResponderContext.

Used to run P2P node-to-node applications.

type RunMiniProtocolWithMinimalCtx mode peerAddr bytes m a b = RunMiniProtocol mode (MinimalInitiatorContext peerAddr) (ResponderContext peerAddr) bytes m a b Source #

RunMiniProtocol with MinimalInitiatorContext and ResponderContext.

Use to run node-to-client application as well as in some non p2p contexts.

MiniProtocol description

data MiniProtocol (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b Source #

Each mini-protocol is represented by its

mini-protocol number,
ingress size limit, and
callbacks.

Constructors

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

type MiniProtocolWithExpandedCtx mode peerAddr bytes m a b = MiniProtocol mode (ExpandedInitiatorContext peerAddr m) (ResponderContext peerAddr) bytes m a b Source #

MiniProtocol type used in P2P.

type MiniProtocolWithMinimalCtx mode peerAddr bytes m a b = MiniProtocol mode (MinimalInitiatorContext peerAddr) (ResponderContext peerAddr) bytes m a b Source #

MiniProtocol type used in non-P2P.

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

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.

MiniProtocol bundle

type OuroborosBundle (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b = TemperatureBundle [MiniProtocol mode initiatorCtx responderCtx bytes m a b] Source #

type OuroborosBundleWithExpandedCtx (mode ∷ MuxMode) peerAddr bytes m a b = OuroborosBundle mode (ExpandedInitiatorContext peerAddr m) (ResponderContext peerAddr) bytes m a b Source #

OuroborosBundle used in P2P.

Non-P2P API

newtype OuroborosApplication (mode ∷ MuxMode) initiatorCtx responderCtx bytes m a b Source #

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

Note: Only used in some non-P2P contexts.

Constructors

OuroborosApplication [MiniProtocol mode initiatorCtx responderCtx bytes m a b]

type OuroborosApplicationWithMinimalCtx mode peerAddr bytes m a b = OuroborosApplication mode (MinimalInitiatorContext peerAddr) (ResponderContext peerAddr) bytes m a b Source #

OuroborosApplication used in NonP2P mode.

toApplication ∷ ∀ mode initiatorCtx responderCtx m a b. (MonadAsync m, MonadThrow m) ⇒ initiatorCtx → responderCtx → OuroborosApplication mode initiatorCtx responderCtx ByteString m a b → MuxApplication mode m a b Source #

Create non p2p mux application.

Note that callbacks will always receive IsNotBigLedgerPeer.

mkMiniProtocolBundle ∷ OuroborosBundle mode initiatorCtx responderCtx bytes m a b → MiniProtocolBundle mode Source #

Make MiniProtocolBundle, which is used to create a mux interface with newMux.

fromOuroborosBundle ∷ OuroborosBundle mode initiatorCtx responderCtx bytes m a b → OuroborosApplication mode initiatorCtx responderCtx bytes m a b Source #

contramapInitiatorCtx ∷ (initiatorCtx' → initiatorCtx) → OuroborosApplication mode initiatorCtx responderCtx bytes m a b → OuroborosApplication mode initiatorCtx' responderCtx bytes m a b Source #

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

Exception MuxError
Instance details Defined in Network.Mux.Trace Methods toException ∷ MuxError → SomeException Source # fromException ∷ SomeException → Maybe MuxError Source # displayException ∷ MuxError → String 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 #
Show MuxError
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → MuxError → ShowS Source # show ∷ MuxError → String Source # showList ∷ [MuxError] → ShowS Source #
type Rep MuxError
Instance details Defined in Network.Mux.Trace type Rep MuxError = D1 ('MetaData "MuxError" "Network.Mux.Trace" "network-mux-0.4.0.0-inplace" '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

Show MuxErrorType
Instance details Defined in Network.Mux.Trace Methods showsPrec ∷ Int → MuxErrorType → ShowS Source # show ∷ MuxErrorType → String Source # showList ∷ [MuxErrorType] → ShowS Source #
Eq MuxErrorType
Instance details Defined in Network.Mux.Trace Methods (==) ∷ MuxErrorType → MuxErrorType → Bool Source # (/=) ∷ MuxErrorType → MuxErrorType → Bool 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

Deprecated APIs

type MuxPeer = MiniProtocolCb Source #

Deprecated: Use either MiniProtocolCb type instead of MiniProtocolCb type, ormkMiniProtocolCbFromPeer instead the MiniProtocolCb constructor.

runMuxPeer ∷ MiniProtocolCb ctx bytes m a → ctx → Channel m bytes → m (a, Maybe bytes) Source #