Safe Haskell	None
Language	Haskell2010

Cardano.Network.PeerSelection.Churn

Description

This subsystem manages the discovery and selection of upstream peers.

Synopsis

data PeerChurnArgs (m :: Type -> Type) extraArgs extraDebugState extraFlags extraPeers extraAPI peeraddr = PeerChurnArgs {
- pcaPeerSelectionTracer :: Tracer m (TracePeerSelection extraDebugState extraFlags extraPeers peeraddr)
- pcaDeadlineInterval :: DiffTime
- pcaBulkInterval :: DiffTime
- pcaPeerRequestTimeout :: DiffTime
- pcaRng :: StdGen
- pcaPeerSelectionVar :: StrictTVar m PeerSelectionTargets
- pcaReadCounters :: STM m (PeerSelectionCounters (ViewExtraPeers extraPeers))
- getLedgerPeersAPI :: LedgerPeersConsensusInterface extraAPI m
- getLocalRootHotTarget :: STM m HotValency
- pcaPeerSelectionTargets :: PeerSelectionTargets
- getExtraArgs :: extraArgs
}
newtype ChurnMode = ChurnMode {
- getFetchMode :: FetchMode
}
newtype TraceChurnMode = TraceChurnMode ChurnMode
data ExtraArguments (m :: Type -> Type) = ExtraArguments {
- modeVar :: StrictTVar m ChurnMode
- genesisPeerSelectionTargets :: PeerSelectionTargets
- readUseBootstrap :: STM m UseBootstrapPeers
- consensusMode :: ConsensusMode
- tracerChurnMode :: Tracer m TraceChurnMode
}
peerChurnGovernor :: forall m extraState extraFlags extraPeers extraCounters peeraddr. (MonadDelay m, Alternative (STM m), MonadTimer m, MonadCatch m, extraCounters ~ ViewExtraPeers extraPeers) => PeerChurnArgs m (ExtraArguments m) extraState extraFlags extraPeers (LedgerPeersConsensusInterface m) peeraddr -> m Void

Documentation

data PeerChurnArgs (m :: Type -> Type) extraArgs extraDebugState extraFlags extraPeers extraAPI peeraddr #

Record of arguments for peer churn governor

Constructors

PeerChurnArgs

Fields

pcaPeerSelectionTracer :: Tracer m (TracePeerSelection extraDebugState extraFlags extraPeers peeraddr)
pcaDeadlineInterval :: DiffTime
pcaBulkInterval :: DiffTime
pcaPeerRequestTimeout :: DiffTime
the timeout for outbound governor to find new (thus cold) peers through peer sharing mechanism.
pcaRng :: StdGen
pcaPeerSelectionVar :: StrictTVar m PeerSelectionTargets
pcaReadCounters :: STM m (PeerSelectionCounters (ViewExtraPeers extraPeers))
getLedgerPeersAPI :: LedgerPeersConsensusInterface extraAPI m
getLocalRootHotTarget :: STM m HotValency
pcaPeerSelectionTargets :: PeerSelectionTargets
configured peer selection targets
getExtraArgs :: extraArgs

newtype ChurnMode Source #

Churn mode is set by churn and available in peer selection policy. It follows FetchMode, thus it's a newtype wrapper.

It is shared using its own TVar to make sure the value available in peer selection policy is consistent with the value available in churn actions.

Constructors

ChurnMode
Fields getFetchMode :: FetchMode

Instances

Instances details

Generic ChurnMode Source #

Instance details

Defined in Cardano.Network.PeerSelection.Churn

Associated Types

type Rep ChurnMode
Instance details Defined in Cardano.Network.PeerSelection.Churn type Rep ChurnMode = D1 ('MetaData "ChurnMode" "Cardano.Network.PeerSelection.Churn" "cardano-diffusion-1.0.0.0-inplace" 'True) (C1 ('MetaCons "ChurnMode" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFetchMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FetchMode)))

Methods

from :: ChurnMode -> Rep ChurnMode x #

to :: Rep ChurnMode x -> ChurnMode #

Show ChurnMode Source #

Instance details

Defined in Cardano.Network.PeerSelection.Churn

Methods

showsPrec :: Int -> ChurnMode -> ShowS #

show :: ChurnMode -> String #

showList :: [ChurnMode] -> ShowS #

type Rep ChurnMode Source #

Instance details

Defined in Cardano.Network.PeerSelection.Churn

type Rep ChurnMode = D1 ('MetaData "ChurnMode" "Cardano.Network.PeerSelection.Churn" "cardano-diffusion-1.0.0.0-inplace" 'True) (C1 ('MetaCons "ChurnMode" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFetchMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FetchMode)))

newtype TraceChurnMode Source #

Constructors

TraceChurnMode ChurnMode

Instances

Instances details

Show TraceChurnMode Source #
Instance details Defined in Cardano.Network.PeerSelection.Churn Methods showsPrec :: Int -> TraceChurnMode -> ShowS # show :: TraceChurnMode -> String # showList :: [TraceChurnMode] -> ShowS #

data ExtraArguments (m :: Type -> Type) Source #

Cardano Churn Extra Arguments

Constructors

ExtraArguments
Fields modeVar :: StrictTVar m ChurnMode genesisPeerSelectionTargets :: PeerSelectionTargets readUseBootstrap :: STM m UseBootstrapPeers consensusMode :: ConsensusMode tracerChurnMode :: Tracer m TraceChurnMode

peerChurnGovernor :: forall m extraState extraFlags extraPeers extraCounters peeraddr. (MonadDelay m, Alternative (STM m), MonadTimer m, MonadCatch m, extraCounters ~ ViewExtraPeers extraPeers) => PeerChurnArgs m (ExtraArguments m) extraState extraFlags extraPeers (LedgerPeersConsensusInterface m) peeraddr -> m Void Source #

Churn governor.

At every churn interval decrease active peers for a short while (1s), so that we can pick new ones. Then we churn non-active peers.

On startup the churn governor gives a head start to local root peers over root peers.