Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.InboundGovernor.State

Contents

Internals

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)
data InboundGovernorState muxMode initiatorCtx peerAddr m a b = InboundGovernorState {
- igsConnections ∷ !(Map (ConnectionId peerAddr) (ConnectionState muxMode initiatorCtx peerAddr m a b))
- igsObservableVar ∷ !(StrictTVar m InboundGovernorObservableState)
- igsCountersCache ∷ !(Cache InboundGovernorCounters)
}
data ConnectionState muxMode initiatorCtx peerAddr m a b = ConnectionState {
- csMux ∷ !(Mux muxMode m)
- csDataFlow ∷ !DataFlow
- csMiniProtocolMap ∷ !(Map MiniProtocolNum (MiniProtocolData muxMode initiatorCtx peerAddr m a b))
- csCompletionMap ∷ !(Map MiniProtocolNum (STM m (Either SomeException b)))
- csRemoteState ∷ !(RemoteState m)
}
data InboundGovernorCounters = InboundGovernorCounters {
- coldPeersRemote ∷ !Int
- idlePeersRemote ∷ !Int
- warmPeersRemote ∷ !Int
- hotPeersRemote ∷ !Int
}
inboundGovernorCounters ∷ InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorCounters
unregisterConnection ∷ Ord peerAddr ⇒ ConnectionId peerAddr → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b
updateMiniProtocol ∷ Ord peerAddr ⇒ ConnectionId peerAddr → MiniProtocolNum → STM m (Either SomeException b) → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b
data RemoteState m where
- RemoteWarm
- RemoteHot
- RemoteIdle !(STM m ())
- RemoteCold
- pattern RemoteEstablished ∷ RemoteState m
updateRemoteState ∷ Ord peerAddr ⇒ ConnectionId peerAddr → RemoteState m → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b
mapRemoteState ∷ Ord peerAddr ⇒ ConnectionId peerAddr → (RemoteState m → RemoteState m) → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b
data MiniProtocolData muxMode initiatorCtx peerAddr m a b = MiniProtocolData {
- mpdMiniProtocol ∷ !(MiniProtocol muxMode initiatorCtx (ResponderContext peerAddr) ByteString m a b)
- mpdResponderContext ∷ !(ResponderContext peerAddr)
- mpdMiniProtocolTemp ∷ !ProtocolTemperature
}

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.

Internals

data InboundGovernorState muxMode initiatorCtx peerAddr m a b Source #

InboundGovernorState, which consist of pure part, and a mutable part. The mutable part can be observable from outside. Future version could contain additional statistics on the peers.

Constructors

InboundGovernorState

Fields

igsConnections ∷ !(Map (ConnectionId peerAddr) (ConnectionState muxMode initiatorCtx peerAddr m a b))
Map of connections state. Modifying igsConnections outside of inboundGovernorLoop is not safe.
igsObservableVar ∷ !(StrictTVar m InboundGovernorObservableState)
PRNG available to PrunePolicy.
igsCountersCache ∷ !(Cache InboundGovernorCounters)
InboundGovernorCounters counters cache. Allows to only trace values when necessary.

data ConnectionState muxMode initiatorCtx peerAddr m a b Source #

Per connection state tracked by inbound protocol governor.

Constructors

ConnectionState

Fields

csMux ∷ !(Mux muxMode m)
Mux interface.
csDataFlow ∷ !DataFlow
Connection data flow.
csMiniProtocolMap ∷ !(Map MiniProtocolNum (MiniProtocolData muxMode initiatorCtx peerAddr m a b))
All supported mini-protocols and respective ProtocolTemperature
csCompletionMap ∷ !(Map MiniProtocolNum (STM m (Either SomeException b)))
Map of all running mini-protocol completion STM actions.
csRemoteState ∷ !(RemoteState m)
State of the connection.

data InboundGovernorCounters Source #

Counters for tracing and analysis purposes

Constructors

InboundGovernorCounters

Fields

coldPeersRemote ∷ !Int
the number of remote peers which are in RemoteCold state
idlePeersRemote ∷ !Int
the number of remote peers which are in RemoteIdle state
warmPeersRemote ∷ !Int
the number of remote peers which are in RemoteWarm state (a close approximation of peers that have the node as a warm peer)
hotPeersRemote ∷ !Int
the number of remote peers which are in RemoteHot state (a close approximation of peers that have the node as a hot peer)

Instances

Instances details

Monoid InboundGovernorCounters Source #
Instance details Defined in Ouroboros.Network.InboundGovernor.State Methods mempty ∷ InboundGovernorCounters # mappend ∷ InboundGovernorCounters → InboundGovernorCounters → InboundGovernorCounters # mconcat ∷ [InboundGovernorCounters] → InboundGovernorCounters #
Semigroup InboundGovernorCounters Source #
Instance details Defined in Ouroboros.Network.InboundGovernor.State Methods (<>) ∷ InboundGovernorCounters → InboundGovernorCounters → InboundGovernorCounters # sconcat ∷ NonEmpty InboundGovernorCounters → InboundGovernorCounters # stimes ∷ Integral b ⇒ b → InboundGovernorCounters → InboundGovernorCounters #
Show InboundGovernorCounters Source #
Instance details Defined in Ouroboros.Network.InboundGovernor.State Methods showsPrec ∷ Int → InboundGovernorCounters → ShowS # show ∷ InboundGovernorCounters → String # showList ∷ [InboundGovernorCounters] → ShowS #
Eq InboundGovernorCounters Source #
Instance details Defined in Ouroboros.Network.InboundGovernor.State Methods (==) ∷ InboundGovernorCounters → InboundGovernorCounters → Bool # (/=) ∷ InboundGovernorCounters → InboundGovernorCounters → Bool #
Ord InboundGovernorCounters Source #
Instance details Defined in Ouroboros.Network.InboundGovernor.State Methods compare ∷ InboundGovernorCounters → InboundGovernorCounters → Ordering # (<) ∷ InboundGovernorCounters → InboundGovernorCounters → Bool # (<=) ∷ InboundGovernorCounters → InboundGovernorCounters → Bool # (>) ∷ InboundGovernorCounters → InboundGovernorCounters → Bool # (>=) ∷ InboundGovernorCounters → InboundGovernorCounters → Bool # max ∷ InboundGovernorCounters → InboundGovernorCounters → InboundGovernorCounters # min ∷ InboundGovernorCounters → InboundGovernorCounters → InboundGovernorCounters #

inboundGovernorCounters ∷ InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorCounters Source #

unregisterConnection ∷ Ord peerAddr ⇒ ConnectionId peerAddr → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b Source #

Remove connection from InboundGovernorState.

updateMiniProtocol ∷ Ord peerAddr ⇒ ConnectionId peerAddr → MiniProtocolNum → STM m (Either SomeException b) → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b Source #

Update a mini-protocol in ConnectionState. Once a mini-protocol was restarted we put the new completion action into csCompletionMap.

data RemoteState m Source #

Each inbound connection is either in RemoteIdle, RemoteCold or RemoteEstablished state. We only need to support PromotedToWarm^{Duplex}_{Remote}, DemotedToCold^{Duplex}_{Remote} and DemotedToCold^{Unidirectional}_{Remote} transitions.

Constructors

RemoteWarm	After `PromotedToWarm^{dataFlow}_{Remote}` a connection is in `RemoteWarm` state.
RemoteHot	In this state all established and hot mini-protocols are running and none of the warm mini-protocols is running.
RemoteIdle !(STM m ())	After `DemotedToCold^{dataFlow}_{Remote}` is detected. This state corresponds to `InboundIdleState`. In this state we are checking if the responder protocols are idle during protocol idle timeout (represented by an `STM` action) `RemoteIdle` is the initial state of an accepted a connection.
RemoteCold	The `RemoteCold` state for `Duplex` connections allows us to have responders started using the on-demand strategy. This assures that once the remote peer start using the connection the local side will be ready to serve it. For a `Duplex` connection: a `RemoteIdle` connection transitions to `RemoteCold` state after all responders being idle for `protocolIdleTimeout`. This triggers `unregisterInboundConnection`. For a `Unidreictional` connection: after all responders terminated.

Bundled Patterns

pattern RemoteEstablished ∷ RemoteState m

updateRemoteState ∷ Ord peerAddr ⇒ ConnectionId peerAddr → RemoteState m → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b Source #

Set csRemoteState for a given connection.

mapRemoteState ∷ Ord peerAddr ⇒ ConnectionId peerAddr → (RemoteState m → RemoteState m) → InboundGovernorState muxMode initiatorCtx peerAddr m a b → InboundGovernorState muxMode initiatorCtx peerAddr m a b Source #

data MiniProtocolData muxMode initiatorCtx peerAddr m a b Source #

Constructors

MiniProtocolData
Fields mpdMiniProtocol ∷ !(MiniProtocol muxMode initiatorCtx (ResponderContext peerAddr) ByteString m a b) Static `MiniProtocol` description. mpdResponderContext ∷ !(ResponderContext peerAddr) mpdMiniProtocolTemp ∷ !ProtocolTemperature Static mini-protocol temperature.