Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Driver.Limits

Contents

Limits
Normal peers
Pipelined peers
Driver utilities

Description

Drivers for running Peers.

Synopsis

data ProtocolSizeLimits ps bytes = ProtocolSizeLimits {
- sizeLimitForState ∷ ∀ (pr ∷ PeerRole) (st ∷ ps). PeerHasAgency pr st → Word
- dataSize ∷ bytes → Word
}
data ProtocolTimeLimits ps = ProtocolTimeLimits {
- timeLimitForState ∷ ∀ (pr ∷ PeerRole) (st ∷ ps). PeerHasAgency pr st → Maybe DiffTime
}
data ProtocolLimitFailure where
- ExceededSizeLimit ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps). (∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ PeerHasAgency pr st → ProtocolLimitFailure
- ExceededTimeLimit ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps). (∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ PeerHasAgency pr st → ProtocolLimitFailure
runPeerWithLimits ∷ ∀ ps (st ∷ ps) pr failure bytes m a. (MonadAsync m, MonadFork m, MonadMask m, MonadThrow (STM m), MonadTimer m, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps, Show failure) ⇒ Tracer m (TraceSendRecv ps) → Codec ps failure m bytes → ProtocolSizeLimits ps bytes → ProtocolTimeLimits ps → Channel m bytes → Peer ps pr st m a → m (a, Maybe bytes)
data TraceSendRecv ps where
- TraceSendMsg ∷ AnyMessageAndAgency ps → TraceSendRecv ps
- TraceRecvMsg ∷ AnyMessageAndAgency ps → TraceSendRecv ps
runPipelinedPeerWithLimits ∷ ∀ ps (st ∷ ps) pr failure bytes m a. (MonadAsync m, MonadFork m, MonadMask m, MonadThrow (STM m), MonadTimer m, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps, Show failure) ⇒ Tracer m (TraceSendRecv ps) → Codec ps failure m bytes → ProtocolSizeLimits ps bytes → ProtocolTimeLimits ps → Channel m bytes → PeerPipelined ps pr st m a → m (a, Maybe bytes)
driverWithLimits ∷ ∀ ps failure bytes m. (MonadThrow m, Show failure, ShowProxy ps, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st')) ⇒ Tracer m (TraceSendRecv ps) → TimeoutFn m → Codec ps failure m bytes → ProtocolSizeLimits ps bytes → ProtocolTimeLimits ps → Channel m bytes → Driver ps (Maybe bytes) m

Limits

data ProtocolSizeLimits ps bytes Source #

Constructors

ProtocolSizeLimits
Fields sizeLimitForState ∷ ∀ (pr ∷ PeerRole) (st ∷ ps). PeerHasAgency pr st → Word dataSize ∷ bytes → Word

data ProtocolTimeLimits ps Source #

Constructors

ProtocolTimeLimits
Fields timeLimitForState ∷ ∀ (pr ∷ PeerRole) (st ∷ ps). PeerHasAgency pr st → Maybe DiffTime

data ProtocolLimitFailure where Source #

Constructors

ExceededSizeLimit ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps). (∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ PeerHasAgency pr st → ProtocolLimitFailure
ExceededTimeLimit ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps). (∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ PeerHasAgency pr st → ProtocolLimitFailure

Instances

Instances details

Exception ProtocolLimitFailure
Instance details Defined in Ouroboros.Network.Protocol.Limits Methods toException ∷ ProtocolLimitFailure → SomeException Source # fromException ∷ SomeException → Maybe ProtocolLimitFailure Source # displayException ∷ ProtocolLimitFailure → String Source #
Show ProtocolLimitFailure
Instance details Defined in Ouroboros.Network.Protocol.Limits Methods showsPrec ∷ Int → ProtocolLimitFailure → ShowS Source # show ∷ ProtocolLimitFailure → String Source # showList ∷ [ProtocolLimitFailure] → ShowS Source #

Normal peers

runPeerWithLimits ∷ ∀ ps (st ∷ ps) pr failure bytes m a. (MonadAsync m, MonadFork m, MonadMask m, MonadThrow (STM m), MonadTimer m, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps, Show failure) ⇒ Tracer m (TraceSendRecv ps) → Codec ps failure m bytes → ProtocolSizeLimits ps bytes → ProtocolTimeLimits ps → Channel m bytes → Peer ps pr st m a → m (a, Maybe bytes) Source #

data TraceSendRecv ps where Source #

Structured Tracer output for runPeer and derivitives.

Constructors

TraceSendMsg ∷ AnyMessageAndAgency ps → TraceSendRecv ps
TraceRecvMsg ∷ AnyMessageAndAgency ps → TraceSendRecv ps

Instances

Instances details

Show (AnyMessageAndAgency ps) ⇒ Show (TraceSendRecv ps) Source #
Instance details Defined in Ouroboros.Network.Driver.Simple Methods showsPrec ∷ Int → TraceSendRecv ps → ShowS Source # show ∷ TraceSendRecv ps → String Source # showList ∷ [TraceSendRecv ps] → ShowS Source #

Pipelined peers

runPipelinedPeerWithLimits ∷ ∀ ps (st ∷ ps) pr failure bytes m a. (MonadAsync m, MonadFork m, MonadMask m, MonadThrow (STM m), MonadTimer m, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps, Show failure) ⇒ Tracer m (TraceSendRecv ps) → Codec ps failure m bytes → ProtocolSizeLimits ps bytes → ProtocolTimeLimits ps → Channel m bytes → PeerPipelined ps pr st m a → m (a, Maybe bytes) Source #

Run a pipelined peer with the given channel via the given codec.

This runs the peer to completion (if the protocol allows for termination).

Unlike normal peers, running pipelined peers rely on concurrency, hence the MonadAsync constraint.

Driver utilities

driverWithLimits ∷ ∀ ps failure bytes m. (MonadThrow m, Show failure, ShowProxy ps, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st')) ⇒ Tracer m (TraceSendRecv ps) → TimeoutFn m → Codec ps failure m bytes → ProtocolSizeLimits ps bytes → ProtocolTimeLimits ps → Channel m bytes → Driver ps (Maybe bytes) m Source #