Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.PeerSelection.PeerSelectionActions

Contents

Re-exports

Synopsis

withPeerSelectionActions :: forall peeraddr peerconn resolver exception m a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, MonadMVar m, Ord peeraddr, Exception exception) => StrictTVar m (Config peeraddr) -> PeerActionsDNS peeraddr resolver exception m -> PeerSelectionActionsArgs peeraddr peerconn exception m -> WithLedgerPeersArgs m -> PeerSelectionActionsDiffusionMode peeraddr peerconn m -> ((Async m Void, Async m Void) -> PeerSelectionActions peeraddr peerconn m -> m a) -> m a
data PeerSelectionTargets = PeerSelectionTargets {
- targetNumberOfRootPeers :: !Int
- targetNumberOfKnownPeers :: !Int
- targetNumberOfEstablishedPeers :: !Int
- targetNumberOfActivePeers :: !Int
- targetNumberOfKnownBigLedgerPeers :: !Int
- targetNumberOfEstablishedBigLedgerPeers :: !Int
- targetNumberOfActiveBigLedgerPeers :: !Int
}
data PeerAdvertise
- = DoNotAdvertisePeer
- | DoAdvertisePeer
data PeerSelectionActionsArgs peeraddr peerconn exception (m :: Type -> Type) = PeerSelectionActionsArgs {
- psLocalRootPeersTracer :: Tracer m (TraceLocalRootPeers peeraddr exception)
- psPublicRootPeersTracer :: Tracer m TracePublicRootPeers
- psReadTargets :: STM m PeerSelectionTargets
- peerTargets :: ConsensusModePeerTargets
- getLedgerStateCtx :: LedgerPeersConsensusInterface m
- psReadLocalRootPeers :: STM m [(HotValency, WarmValency, Map RelayAccessPoint (PeerAdvertise, PeerTrustable))]
- psReadPublicRootPeers :: STM m (Map RelayAccessPoint PeerAdvertise)
- psReadUseBootstrapPeers :: STM m UseBootstrapPeers
- psPeerSharing :: PeerSharing
- psPeerConnToPeerSharing :: peerconn -> PeerSharing
- psReadPeerSharingController :: STM m (Map peeraddr (PeerSharingController peeraddr m))
- psUpdateOutboundConnectionsState :: OutboundConnectionsState -> STM m ()
- psReadInboundPeers :: m (Map peeraddr PeerSharing)
- readLedgerPeerSnapshot :: STM m (Maybe LedgerPeerSnapshot)
}
newtype PeerSelectionActionsDiffusionMode peeraddr peerhandle (m :: Type -> Type) = PeerSelectionActionsDiffusionMode {
- psPeerStateActions :: PeerStateActions peeraddr peerhandle m
}

Documentation

withPeerSelectionActions Source #

Arguments

:: forall peeraddr peerconn resolver exception m a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, MonadMVar m, Ord peeraddr, Exception exception)
=> StrictTVar m (Config peeraddr)
-> PeerActionsDNS peeraddr resolver exception m
-> PeerSelectionActionsArgs peeraddr peerconn exception m
-> WithLedgerPeersArgs m
-> PeerSelectionActionsDiffusionMode peeraddr peerconn m
-> ((Async m Void, Async m Void) -> PeerSelectionActions peeraddr peerconn m -> m a)	continuation, receives a handle to the local roots peer provider thread (only if local root peers were non-empty).
-> m a

Re-exports

data PeerSelectionTargets Source #

Adjustable targets for the peer selection mechanism.

These are used by the peer selection governor as targets. They are used by the peer churn governor loop as knobs to adjust, to influence the peer selection governor.

The known, established and active peer targets are targets both from below and from above: the governor will attempt to grow or shrink the sets to hit these targets.

Unlike the other targets, the root peer target is "one sided", it is only a target from below. The governor does not try to shrink the root set to hit it, it simply stops looking for more.

There is also an implicit target that enough local root peers are selected as active. This comes from the configuration for local roots, and is not an independently adjustable target.

Constructors

PeerSelectionTargets

Fields

targetNumberOfRootPeers :: !Int
targetNumberOfKnownPeers :: !Int
The target number of all known peers. Doesn't include big ledger peers |
targetNumberOfEstablishedPeers :: !Int
The target number of established peers (does not include big ledger peers).
The target includes root peers, local root peers, and ledger peers
targetNumberOfActivePeers :: !Int
The target number of active peers (does not include big ledger peers).
targetNumberOfKnownBigLedgerPeers :: !Int
Target number of known big ledger peers.
This target is independent of targetNumberOfKnownPeers. The total number of known peers will be sum of the two targets.
targetNumberOfEstablishedBigLedgerPeers :: !Int
Target number of established big ledger peers.
This target is independent of targetNumberOfEstablishedPeers. The total number of established peers will be sum of the two targets and local root peers.
targetNumberOfActiveBigLedgerPeers :: !Int
Target number of active big ledger peers.
This target is independent of targetNumberOfActivePeers. The total number of active peers will be sum of the two targets and active local root peers.

Instances

Instances details

Show PeerSelectionTargets Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods showsPrec :: Int -> PeerSelectionTargets -> ShowS # show :: PeerSelectionTargets -> String # showList :: [PeerSelectionTargets] -> ShowS #
Eq PeerSelectionTargets Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods (==) :: PeerSelectionTargets -> PeerSelectionTargets -> Bool # (/=) :: PeerSelectionTargets -> PeerSelectionTargets -> Bool #

data PeerAdvertise #

Should this peer be advertised to other peers asking for known peers? For certain peers specified by configuration it would be an appropriate policy to keep them private.

Constructors

DoNotAdvertisePeer
DoAdvertisePeer

Instances

Instances details

FromJSON PeerAdvertise

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerAdvertise

Methods

parseJSON :: Value -> Parser PeerAdvertise #

parseJSONList :: Value -> Parser [PeerAdvertise] #

omittedField :: Maybe PeerAdvertise #

ToJSON PeerAdvertise

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerAdvertise

Methods

toJSON :: PeerAdvertise -> Value #

toEncoding :: PeerAdvertise -> Encoding #

toJSONList :: [PeerAdvertise] -> Value #

toEncodingList :: [PeerAdvertise] -> Encoding #

omitField :: PeerAdvertise -> Bool #

Generic PeerAdvertise

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerAdvertise

Associated Types

type Rep PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise type Rep PeerAdvertise = D1 ('MetaData "PeerAdvertise" "Ouroboros.Network.PeerSelection.PeerAdvertise" "ouroboros-network-api-0.11.0.0-inplace" 'False) (C1 ('MetaCons "DoNotAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: PeerAdvertise -> Rep PeerAdvertise x #

to :: Rep PeerAdvertise x -> PeerAdvertise #

Show PeerAdvertise

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerAdvertise

Methods

showsPrec :: Int -> PeerAdvertise -> ShowS #

show :: PeerAdvertise -> String #

showList :: [PeerAdvertise] -> ShowS #

Eq PeerAdvertise

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerAdvertise

Methods

(==) :: PeerAdvertise -> PeerAdvertise -> Bool #

(/=) :: PeerAdvertise -> PeerAdvertise -> Bool #

Ord PeerAdvertise

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerAdvertise

Methods

compare :: PeerAdvertise -> PeerAdvertise -> Ordering #

(<) :: PeerAdvertise -> PeerAdvertise -> Bool #

(<=) :: PeerAdvertise -> PeerAdvertise -> Bool #

(>) :: PeerAdvertise -> PeerAdvertise -> Bool #

(>=) :: PeerAdvertise -> PeerAdvertise -> Bool #

max :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise #

min :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise #

type Rep PeerAdvertise

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerAdvertise

type Rep PeerAdvertise = D1 ('MetaData "PeerAdvertise" "Ouroboros.Network.PeerSelection.PeerAdvertise" "ouroboros-network-api-0.11.0.0-inplace" 'False) (C1 ('MetaCons "DoNotAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type))

data PeerSelectionActionsArgs peeraddr peerconn exception (m :: Type -> Type) Source #

Record of parameters for withPeerSelectionActions independent of diffusion mode

Constructors

PeerSelectionActionsArgs

Fields

psLocalRootPeersTracer :: Tracer m (TraceLocalRootPeers peeraddr exception)
psPublicRootPeersTracer :: Tracer m TracePublicRootPeers
psReadTargets :: STM m PeerSelectionTargets
peerTargets :: ConsensusModePeerTargets
peer selection governor know, established and active targets
getLedgerStateCtx :: LedgerPeersConsensusInterface m
Is consensus close to current slot?
psReadLocalRootPeers :: STM m [(HotValency, WarmValency, Map RelayAccessPoint (PeerAdvertise, PeerTrustable))]
psReadPublicRootPeers :: STM m (Map RelayAccessPoint PeerAdvertise)
psReadUseBootstrapPeers :: STM m UseBootstrapPeers
psPeerSharing :: PeerSharing
peer sharing configured value
psPeerConnToPeerSharing :: peerconn -> PeerSharing
Extract peer sharing information from peerconn
psReadPeerSharingController :: STM m (Map peeraddr (PeerSharingController peeraddr m))
peer sharing registry
psUpdateOutboundConnectionsState :: OutboundConnectionsState -> STM m ()
Callback which updates information about outbound connections state.
psReadInboundPeers :: m (Map peeraddr PeerSharing)
inbound duplex peers
readLedgerPeerSnapshot :: STM m (Maybe LedgerPeerSnapshot)

newtype PeerSelectionActionsDiffusionMode peeraddr peerhandle (m :: Type -> Type) Source #

Record of remaining parameters for withPeerSelectionActions that were extracted out since the following vary based on the diffusion mode

Constructors

PeerSelectionActionsDiffusionMode
Fields psPeerStateActions :: PeerStateActions peeraddr peerhandle m callbacks for peer state changes