Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.InboundGovernor

Contents

Run Inbound Protocol Governor
Trace
Re-exports

Description

Server implementation based on ConnectionManager

Synopsis

newtype InboundGovernorObservableState = InboundGovernorObservableState {
- igosPrng ∷ StdGen
}
newObservableStateVar ∷ MonadLabelledSTM m ⇒ StdGen → m (StrictTVar m InboundGovernorObservableState)
newObservableStateVarIO ∷ IO (StrictTVar IO InboundGovernorObservableState)
newObservableStateVarFromSeed ∷ MonadLabelledSTM m ⇒ Int → m (StrictTVar m InboundGovernorObservableState)
inboundGovernor ∷ ∀ (muxMode ∷ MuxMode) socket initiatorCtx peerAddr versionData versionNumber m a b. (Alternative (STM m), MonadAsync m, MonadCatch m, MonadEvaluate m, MonadThrow m, MonadThrow (STM m), MonadTime m, MonadTimer m, MonadMask m, Ord peerAddr, HasResponder muxMode ~ True) ⇒ Tracer m (RemoteTransitionTrace peerAddr) → Tracer m (InboundGovernorTrace peerAddr) → InboundGovernorInfoChannel muxMode initiatorCtx peerAddr versionData ByteString m a b → Maybe DiffTime → MuxConnectionManager muxMode socket initiatorCtx (ResponderContext peerAddr) peerAddr versionData versionNumber ByteString m a b → StrictTVar m InboundGovernorObservableState → m Void
data InboundGovernorTrace peerAddr
- = TrNewConnection !Provenance !(ConnectionId peerAddr)
- | TrResponderRestarted !(ConnectionId peerAddr) !MiniProtocolNum
- | TrResponderStartFailure !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
- | TrResponderErrored !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
- | TrResponderStarted !(ConnectionId peerAddr) !MiniProtocolNum
- | TrResponderTerminated !(ConnectionId peerAddr) !MiniProtocolNum
- | TrPromotedToWarmRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
- | TrPromotedToHotRemote !(ConnectionId peerAddr)
- | TrDemotedToWarmRemote !(ConnectionId peerAddr)
- | TrDemotedToColdRemote !(ConnectionId peerAddr) !(OperationResult DemotedToColdRemoteTr)
- | TrWaitIdleRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
- | TrMuxCleanExit !(ConnectionId peerAddr)
- | TrMuxErrored !(ConnectionId peerAddr) SomeException
- | TrInboundGovernorCounters !InboundGovernorCounters
- | TrRemoteState !(Map (ConnectionId peerAddr) RemoteSt)
- | TrUnexpectedlyFalseAssertion !(IGAssertionLocation peerAddr)
- | TrInboundGovernorError !SomeException
data RemoteSt
- = RemoteWarmSt
- | RemoteHotSt
- | RemoteIdleSt
- | RemoteColdSt
type RemoteTransition = Transition' (Maybe RemoteSt)
type RemoteTransitionTrace peerAddr = TransitionTrace' peerAddr (Maybe RemoteSt)
data AcceptConnectionsPolicyTrace
data Transition' state = Transition {
- fromState ∷ !state
- toState ∷ !state
}
data TransitionTrace' peerAddr state = TransitionTrace {
- ttPeerAddr ∷ peerAddr
- ttTransition ∷ Transition' state
}

Documentation

newtype InboundGovernorObservableState Source #

Currently only StdGen, but in the future this will be extended to a record which contains some useful statistics about peers to support more advanced prune strategies (see. PruneStrategy).

Constructors

InboundGovernorObservableState
Fields igosPrng ∷ StdGen

newObservableStateVar ∷ MonadLabelledSTM m ⇒ StdGen → m (StrictTVar m InboundGovernorObservableState) Source #

Create new observable state StrictTVar.

newObservableStateVarIO ∷ IO (StrictTVar IO InboundGovernorObservableState) Source #

Using the global StdGen.

newObservableStateVarFromSeed ∷ MonadLabelledSTM m ⇒ Int → m (StrictTVar m InboundGovernorObservableState) Source #

Useful for testing, it is using mkStdGen.

Run Inbound Protocol Governor

inboundGovernor ∷ ∀ (muxMode ∷ MuxMode) socket initiatorCtx peerAddr versionData versionNumber m a b. (Alternative (STM m), MonadAsync m, MonadCatch m, MonadEvaluate m, MonadThrow m, MonadThrow (STM m), MonadTime m, MonadTimer m, MonadMask m, Ord peerAddr, HasResponder muxMode ~ True) ⇒ Tracer m (RemoteTransitionTrace peerAddr) → Tracer m (InboundGovernorTrace peerAddr) → InboundGovernorInfoChannel muxMode initiatorCtx peerAddr versionData ByteString m a b → Maybe DiffTime → MuxConnectionManager muxMode socket initiatorCtx (ResponderContext peerAddr) peerAddr versionData versionNumber ByteString m a b → StrictTVar m InboundGovernorObservableState → m Void Source #

Run the server, which consists of the following components:

inbound governor, it corresponds to p2p-governor on outbound side
accept loop(s), one per given ip address. We support up to one ipv4 address and up to one ipv6 address, i.e. an ipv6 enabled node will run two accept loops on listening on different addresses with shared inbound governor.

The server can be run in either of two MuxMode-es:

The first one is used in data diffusion for Node-To-Node protocol, while the other is useful for running a server for the Node-To-Client protocol.

Trace

data InboundGovernorTrace peerAddr Source #

Constructors

TrNewConnection !Provenance !(ConnectionId peerAddr)
TrResponderRestarted !(ConnectionId peerAddr) !MiniProtocolNum
TrResponderStartFailure !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
TrResponderErrored !(ConnectionId peerAddr) !MiniProtocolNum !SomeException
TrResponderStarted !(ConnectionId peerAddr) !MiniProtocolNum
TrResponderTerminated !(ConnectionId peerAddr) !MiniProtocolNum
TrPromotedToWarmRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
TrPromotedToHotRemote !(ConnectionId peerAddr)
TrDemotedToWarmRemote !(ConnectionId peerAddr)
TrDemotedToColdRemote !(ConnectionId peerAddr) !(OperationResult DemotedToColdRemoteTr)	All mini-protocols terminated. The boolean is true if this connection was not used by p2p-governor, and thus the connection will be terminated.
TrWaitIdleRemote !(ConnectionId peerAddr) !(OperationResult AbstractState)
TrMuxCleanExit !(ConnectionId peerAddr)
TrMuxErrored !(ConnectionId peerAddr) SomeException
TrInboundGovernorCounters !InboundGovernorCounters
TrRemoteState !(Map (ConnectionId peerAddr) RemoteSt)
TrUnexpectedlyFalseAssertion !(IGAssertionLocation peerAddr)	This case is unexpected at call site.
TrInboundGovernorError !SomeException

Instances

Instances details

Show peerAddr ⇒ Show (InboundGovernorTrace peerAddr) Source #
Instance details Defined in Ouroboros.Network.InboundGovernor Methods showsPrec ∷ Int → InboundGovernorTrace peerAddr → ShowS # show ∷ InboundGovernorTrace peerAddr → String # showList ∷ [InboundGovernorTrace peerAddr] → ShowS #

data RemoteSt Source #

Remote connection state tracked by inbound protocol governor.

Constructors

RemoteWarmSt
RemoteHotSt
RemoteIdleSt
RemoteColdSt

Instances

Instances details

Show RemoteSt Source #
Instance details Defined in Ouroboros.Network.InboundGovernor Methods showsPrec ∷ Int → RemoteSt → ShowS # show ∷ RemoteSt → String # showList ∷ [RemoteSt] → ShowS #
Eq RemoteSt Source #
Instance details Defined in Ouroboros.Network.InboundGovernor Methods (==) ∷ RemoteSt → RemoteSt → Bool # (/=) ∷ RemoteSt → RemoteSt → Bool #

type RemoteTransition = Transition' (Maybe RemoteSt) Source #

Nothing represents uninitialised state.

type RemoteTransitionTrace peerAddr = TransitionTrace' peerAddr (Maybe RemoteSt) Source #

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

Constructors

ServerTraceAcceptConnectionRateLimiting DiffTime Int
ServerTraceAcceptConnectionHardLimit Word32
ServerTraceAcceptConnectionResume Int

Instances

Instances details

Show AcceptConnectionsPolicyTrace Source #
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods showsPrec ∷ Int → AcceptConnectionsPolicyTrace → ShowS # show ∷ AcceptConnectionsPolicyTrace → String # showList ∷ [AcceptConnectionsPolicyTrace] → ShowS #
Eq AcceptConnectionsPolicyTrace Source #
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods (==) ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → Bool # (/=) ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → Bool #
Ord AcceptConnectionsPolicyTrace Source #
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods compare ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → Ordering # (<) ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → Bool # (<=) ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → Bool # (>) ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → Bool # (>=) ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → Bool # max ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace # min ∷ AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace → AcceptConnectionsPolicyTrace #

Re-exports

data Transition' state Source #

Constructors

Transition
Fields fromState ∷ !state toState ∷ !state

Instances

Instances details

Functor Transition' Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods fmap ∷ (a → b) → Transition' a → Transition' b # (<$) ∷ a → Transition' b → Transition' a #
Show state ⇒ Show (Transition' state) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods showsPrec ∷ Int → Transition' state → ShowS # show ∷ Transition' state → String # showList ∷ [Transition' state] → ShowS #
Eq state ⇒ Eq (Transition' state) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods (==) ∷ Transition' state → Transition' state → Bool # (/=) ∷ Transition' state → Transition' state → Bool #

data TransitionTrace' peerAddr state Source #

Constructors

TransitionTrace
Fields ttPeerAddr ∷ peerAddr ttTransition ∷ Transition' state

Instances

Instances details

Functor (TransitionTrace' peerAddr) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods fmap ∷ (a → b) → TransitionTrace' peerAddr a → TransitionTrace' peerAddr b # (<$) ∷ a → TransitionTrace' peerAddr b → TransitionTrace' peerAddr a #
(Show peerAddr, Show state) ⇒ Show (TransitionTrace' peerAddr state) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Types Methods showsPrec ∷ Int → TransitionTrace' peerAddr state → ShowS # show ∷ TransitionTrace' peerAddr state → String # showList ∷ [TransitionTrace' peerAddr state] → ShowS #