Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.PeerSelection

Synopsis

data PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn (m :: Type -> Type) = PeerSelectionActions {
- peerSelectionTargets :: PeerSelectionTargets
- readPeerSelectionTargets :: STM m PeerSelectionTargets
- readLocalRootPeersFromFile :: STM m (Config extraFlags RelayAccessPoint)
- readLocalRootPeers :: STM m (Config extraFlags peeraddr)
- readInboundPeers :: m (Map peeraddr PeerSharing)
- peerSharing :: PeerSharing
- peerConnToPeerSharing :: peerconn -> PeerSharing
- extraPeersAPI :: PublicExtraPeersAPI extraPeers peeraddr
- extraStateToExtraCounters :: PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraCounters
- requestPublicRootPeers :: LedgerPeersKind -> StdGen -> Int -> m (PublicRootPeers extraPeers peeraddr, DiffTime)
- requestPeerShare :: PeerSharingAmount -> peeraddr -> m (PeerSharingResult peeraddr)
- peerStateActions :: PeerStateActions peeraddr peerconn m
- getLedgerStateCtx :: LedgerPeersConsensusInterface extraAPI m
- readLedgerPeerSnapshot :: STM m (Maybe LedgerPeerSnapshot)
}
data PeerSelectionTargets = PeerSelectionTargets {
- targetNumberOfRootPeers :: !Int
- targetNumberOfKnownPeers :: !Int
- targetNumberOfEstablishedPeers :: !Int
- targetNumberOfActivePeers :: !Int
- targetNumberOfKnownBigLedgerPeers :: !Int
- targetNumberOfEstablishedBigLedgerPeers :: !Int
- targetNumberOfActiveBigLedgerPeers :: !Int
}
data PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn
data PeerStateActions peeraddr peerconn (m :: Type -> Type) = PeerStateActions {
- monitorPeerConnection :: peerconn -> STM m (PeerStatus, Maybe RepromoteDelay)
- establishPeerConnection :: IsBigLedgerPeer -> DiffusionMode -> peeraddr -> m peerconn
- activatePeerConnection :: IsBigLedgerPeer -> peerconn -> m ()
- deactivatePeerConnection :: peerconn -> m ()
- closePeerConnection :: peerconn -> m ()
- errorDelay :: RepromoteDelay
}
data PeerSelectionPolicy peeraddr (m :: Type -> Type) = PeerSelectionPolicy {
- policyPickKnownPeersForPeerShare :: PickPolicy peeraddr (STM m)
- policyPickColdPeersToPromote :: PickPolicy peeraddr (STM m)
- policyPickWarmPeersToPromote :: PickPolicy peeraddr (STM m)
- policyPickHotPeersToDemote :: PickPolicy peeraddr (STM m)
- policyPickWarmPeersToDemote :: PickPolicy peeraddr (STM m)
- policyPickColdPeersToForget :: PickPolicy peeraddr (STM m)
- policyPickInboundPeers :: PickPolicy peeraddr (STM m)
- policyFindPublicRootTimeout :: !DiffTime
- policyMaxInProgressPeerShareReqs :: !Int
- policyPeerShareRetryTime :: !DiffTime
- policyPeerShareBatchWaitTime :: !DiffTime
- policyPeerShareOverallTimeout :: !DiffTime
- policyPeerShareActivationDelay :: !DiffTime
}
type PickPolicy peeraddr (m :: Type -> Type) = (peeraddr -> PeerSource) -> (peeraddr -> Int) -> (peeraddr -> Bool) -> Set peeraddr -> Int -> m (Set peeraddr)
data PeerSelectionInterfaces extraState extraFlags extraPeers extraCounters peeraddr peerconn (m :: Type -> Type) = PeerSelectionInterfaces {
- countersVar :: StrictTVar m (PeerSelectionCounters extraCounters)
- publicStateVar :: StrictTVar m (PublicPeerSelectionState peeraddr)
- debugStateVar :: StrictTVar m (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn)
- readUseLedgerPeers :: STM m UseLedgerPeers
}
data PeerSelectionGovernorArgs extraState extraDebugState extraFlags extraPeers extraAPI extraCounters extraTrace peeraddr peerconn exception (m :: Type -> Type) = PeerSelectionGovernorArgs {
- abortGovernor :: Time -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> Maybe exception
- updateWithState :: PeerSelectionInterfaces extraState extraFlags extraPeers extraCounters peeraddr peerconn m -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn m -> PeerSelectionSetsWithSizes extraCounters peeraddr -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> STM m ()
- extraDecisions :: ExtraGuardedDecisions extraState extraDebugState extraFlags extraPeers extraAPI extraCounters extraTrace peeraddr peerconn m
}
data TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr
- = TraceLocalRootPeersChanged (LocalRootPeers extraFlags peeraddr) (LocalRootPeers extraFlags peeraddr)
- | TraceTargetsChanged PeerSelectionTargets PeerSelectionTargets
- | TracePublicRootsRequest Int Int
- | TracePublicRootsResults (PublicRootPeers extraPeers peeraddr) Int DiffTime
- | TracePublicRootsFailure SomeException Int DiffTime
- | TraceForgetColdPeers Int Int (Set peeraddr)
- | TraceBigLedgerPeersRequest Int Int
- | TraceBigLedgerPeersResults (Set peeraddr) Int DiffTime
- | TraceBigLedgerPeersFailure SomeException Int DiffTime
- | TraceForgetBigLedgerPeers Int Int (Set peeraddr)
- | TracePeerShareRequests Int Int PeerSharingAmount (Set peeraddr) (Set peeraddr)
- | TracePeerShareResults [(peeraddr, Either SomeException (PeerSharingResult peeraddr))]
- | TracePeerShareResultsFiltered [peeraddr]
- | TracePickInboundPeers Int Int (Map peeraddr PeerSharing) (Set peeraddr)
- | TracePromoteColdPeers Int Int (Set peeraddr)
- | TracePromoteColdLocalPeers [(WarmValency, Int)] (Set peeraddr)
- | TracePromoteColdFailed Int Int peeraddr DiffTime SomeException
- | TracePromoteColdDone Int Int peeraddr
- | TracePromoteColdBigLedgerPeers Int Int (Set peeraddr)
- | TracePromoteColdBigLedgerPeerFailed Int Int peeraddr DiffTime SomeException
- | TracePromoteColdBigLedgerPeerDone Int Int peeraddr
- | TracePromoteWarmPeers Int Int (Set peeraddr)
- | TracePromoteWarmLocalPeers [(HotValency, Int)] (Set peeraddr)
- | TracePromoteWarmFailed Int Int peeraddr SomeException
- | TracePromoteWarmDone Int Int peeraddr
- | TracePromoteWarmAborted Int Int peeraddr
- | TracePromoteWarmBigLedgerPeers Int Int (Set peeraddr)
- | TracePromoteWarmBigLedgerPeerFailed Int Int peeraddr SomeException
- | TracePromoteWarmBigLedgerPeerDone Int Int peeraddr
- | TracePromoteWarmBigLedgerPeerAborted Int Int peeraddr
- | TraceDemoteWarmPeers Int Int (Set peeraddr)
- | TraceDemoteWarmFailed Int Int peeraddr SomeException
- | TraceDemoteWarmDone Int Int peeraddr
- | TraceDemoteWarmBigLedgerPeers Int Int (Set peeraddr)
- | TraceDemoteWarmBigLedgerPeerFailed Int Int peeraddr SomeException
- | TraceDemoteWarmBigLedgerPeerDone Int Int peeraddr
- | TraceDemoteHotPeers Int Int (Set peeraddr)
- | TraceDemoteLocalHotPeers [(HotValency, Int)] (Set peeraddr)
- | TraceDemoteHotFailed Int Int peeraddr SomeException
- | TraceDemoteHotDone Int Int peeraddr
- | TraceDemoteHotBigLedgerPeers Int Int (Set peeraddr)
- | TraceDemoteHotBigLedgerPeerFailed Int Int peeraddr SomeException
- | TraceDemoteHotBigLedgerPeerDone Int Int peeraddr
- | TraceDemoteAsynchronous (Map peeraddr (PeerStatus, Maybe RepromoteDelay))
- | TraceDemoteLocalAsynchronous (Map peeraddr (PeerStatus, Maybe RepromoteDelay))
- | TraceDemoteBigLedgerPeersAsynchronous (Map peeraddr (PeerStatus, Maybe RepromoteDelay))
- | TraceGovernorWakeup
- | TraceChurnWait DiffTime
- | TraceChurnAction DiffTime ChurnAction Int
- | TraceChurnTimeout DiffTime ChurnAction Int
- | TraceOnlyBootstrapPeers
- | TraceBootstrapPeersFlagChangedWhilstInSensitiveState
- | TraceVerifyPeerSnapshot Bool
- | TraceOutboundGovernorCriticalFailure SomeException
- | TraceDebugState Time (DebugPeerSelectionState extraDebugState extraFlags extraPeers peeraddr)
- | ExtraTrace extraTrace
data ChurnAction
- = DecreasedActivePeers
- | IncreasedActivePeers
- | DecreasedActiveBigLedgerPeers
- | IncreasedActiveBigLedgerPeers
- | DecreasedEstablishedPeers
- | IncreasedEstablishedPeers
- | IncreasedEstablishedBigLedgerPeers
- | DecreasedEstablishedBigLedgerPeers
- | DecreasedKnownPeers
- | IncreasedKnownPeers
- | DecreasedKnownBigLedgerPeers
- | IncreasedKnownBigLedgerPeers
data DebugPeerSelection extraState extraFlags extraPeers peeraddr where
- TraceGovernorState :: forall extraState extraFlags extraPeers peeraddr peerconn. Show peerconn => Time -> Maybe DiffTime -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> DebugPeerSelection extraState extraFlags extraPeers peeraddr
data AssociationMode
- = LocalRootsOnly
- | Unrestricted
data DebugPeerSelectionState extraState extraFlags extraPeers peeraddr = DebugPeerSelectionState {
- dpssTargets :: !PeerSelectionTargets
- dpssLocalRootPeers :: !(LocalRootPeers extraFlags peeraddr)
- dpssPublicRootPeers :: !(PublicRootPeers extraPeers peeraddr)
- dpssKnownPeers :: !(KnownPeers peeraddr)
- dpssEstablishedPeers :: !(Set peeraddr)
- dpssActivePeers :: !(Set peeraddr)
- dpssPublicRootBackoffs :: !Int
- dpssPublicRootRetryTime :: !Time
- dpssInProgressPublicRootsReq :: !Bool
- dpssBigLedgerPeerBackoffs :: !Int
- dpssBigLedgerPeerRetryTime :: !Time
- dpssInProgressBigLedgerPeersReq :: !Bool
- dpssInProgressPeerShareReqs :: !Int
- dpssInProgressPromoteCold :: !(Set peeraddr)
- dpssInProgressPromoteWarm :: !(Set peeraddr)
- dpssInProgressDemoteWarm :: !(Set peeraddr)
- dpssInProgressDemoteHot :: !(Set peeraddr)
- dpssInProgressDemoteToCold :: !(Set peeraddr)
- dpssUpstreamyness :: !(Map peeraddr Int)
- dpssFetchynessBlocks :: !(Map peeraddr Int)
- dpssAssociationMode :: !AssociationMode
- dpssHotDurations :: !(Map peeraddr (IsBigLedgerPeer, DiffTime))
- dpssExtraState :: !extraState
}
peerSelectionGovernor :: (Alternative (STM m), MonadAsync m, MonadDelay m, MonadLabelledSTM m, MonadMask m, MonadTimer m, Ord peeraddr, Show peerconn, Hashable peeraddr, Exception exception, Eq extraCounters, Semigroup extraPeers, Eq extraFlags) => Tracer m (TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr) -> Tracer m (DebugPeerSelection extraState extraFlags extraPeers peeraddr) -> Tracer m (PeerSelectionCounters extraCounters) -> PeerSelectionGovernorArgs extraState extraDebugState extraFlags extraPeers extraAPI extraCounters extraTrace peeraddr peerconn exception m -> StdGen -> extraState -> extraPeers -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn m -> PeerSelectionPolicy peeraddr m -> PeerSelectionInterfaces extraState extraFlags extraPeers extraCounters peeraddr peerconn m -> m Void
assertPeerSelectionState :: Ord peeraddr => (extraPeers -> Set peeraddr) -> (extraPeers -> Bool) -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> a -> a
sanePeerSelectionTargets :: PeerSelectionTargets -> Bool
establishedPeersStatus :: Ord peeraddr => PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> Map peeraddr PeerStatus
newtype PublicPeerSelectionState peeraddr = PublicPeerSelectionState {
- availableToShare :: Set peeraddr
}
makePublicPeerSelectionStateVar :: (MonadSTM m, Ord peeraddr) => m (StrictTVar m (PublicPeerSelectionState peeraddr))
data PeerSelectionView extraViews a where
- PeerSelectionView {
  - viewRootPeers :: a
  - viewKnownPeers :: a
  - viewAvailableToConnectPeers :: a
  - viewColdPeersPromotions :: a
  - viewEstablishedPeers :: a
  - viewWarmPeersDemotions :: a
  - viewWarmPeersPromotions :: a
  - viewActivePeers :: a
  - viewActivePeersDemotions :: a
  - viewKnownBigLedgerPeers :: a
  - viewAvailableToConnectBigLedgerPeers :: a
  - viewColdBigLedgerPeersPromotions :: a
  - viewEstablishedBigLedgerPeers :: a
  - viewWarmBigLedgerPeersDemotions :: a
  - viewWarmBigLedgerPeersPromotions :: a
  - viewActiveBigLedgerPeers :: a
  - viewActiveBigLedgerPeersDemotions :: a
  - viewKnownLocalRootPeers :: a
  - viewAvailableToConnectLocalRootPeers :: a
  - viewColdLocalRootPeersPromotions :: a
  - viewEstablishedLocalRootPeers :: a
  - viewWarmLocalRootPeersPromotions :: a
  - viewActiveLocalRootPeers :: a
  - viewActiveLocalRootPeersDemotions :: a
  - viewKnownNonRootPeers :: a
  - viewColdNonRootPeersPromotions :: a
  - viewEstablishedNonRootPeers :: a
  - viewWarmNonRootPeersDemotions :: a
  - viewWarmNonRootPeersPromotions :: a
  - viewActiveNonRootPeers :: a
  - viewActiveNonRootPeersDemotions :: a
  - viewExtraViews :: extraViews
  }
- pattern PeerSelectionCounters :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> extraCounters -> PeerSelectionCounters extraCounters
- pattern PeerSelectionCountersHWC :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> PeerSelectionCounters extraCounters
type PeerSelectionCounters extraCounters = PeerSelectionView extraCounters Int
type PeerSelectionSetsWithSizes extraViews peeraddr = PeerSelectionView extraViews (Set peeraddr, Int)
peerSelectionStateToCounters :: Ord peeraddr => (extraPeers -> Set peeraddr) -> (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraCounters) -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> PeerSelectionCounters extraCounters
emptyPeerSelectionCounters :: extraCounters -> PeerSelectionCounters extraCounters
nullPeerSelectionTargets :: PeerSelectionTargets
emptyPeerSelectionState :: StdGen -> extraState -> extraPeers -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn
peerSelectionStateToView :: Ord peeraddr => (extraPeers -> Set peeraddr) -> (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraViews) -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> PeerSelectionSetsWithSizes extraViews peeraddr
module Ouroboros.Network.PeerSelection.Types
module Ouroboros.Network.PeerSelection.Types
data PublicRootPeers extraPeers peeraddr
module Ouroboros.Network.PeerSelection.PeerStateActions
data PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn (m :: Type -> Type) = PeerSelectionActions PeerSelectionTargets (STM m PeerSelectionTargets) (STM m (Config extraFlags RelayAccessPoint)) (STM m (Config extraFlags peeraddr)) (m (Map peeraddr PeerSharing)) PeerSharing (peerconn -> PeerSharing) (PublicExtraPeersAPI extraPeers peeraddr) (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraCounters) (LedgerPeersKind -> StdGen -> Int -> m (PublicRootPeers extraPeers peeraddr, DiffTime)) (PeerSharingAmount -> peeraddr -> m (PeerSharingResult peeraddr)) (PeerStateActions peeraddr peerconn m) (LedgerPeersConsensusInterface extraAPI m) (STM m (Maybe LedgerPeerSnapshot))
withPeerSelectionActions :: forall extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn resolver m a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, Ord peeraddr, Eq extraFlags) => Tracer m (TraceLocalRootPeers extraFlags peeraddr) -> StrictTVar m (Config extraFlags peeraddr) -> PeerActionsDNS peeraddr resolver m -> ((NumberOfPeers -> LedgerPeersKind -> m (Maybe (Set peeraddr, DiffTime))) -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn m) -> WithLedgerPeersArgs extraAPI m -> StdGen -> ((Async m Void, Async m Void) -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn m -> m a) -> m a
requestPeerSharingResult :: (MonadSTM m, MonadMVar m, Ord peeraddr) => STM m (Map peeraddr (PeerSharingController peeraddr m)) -> PeerSharingAmount -> peeraddr -> m (PeerSharingResult peeraddr)
data IP
- = IPv4 {
  - ipv4 :: IPv4
  }
- | IPv6 {
  - ipv6 :: IPv6
  }
data PortNumber
data RelayAccessPoint
- = RelayAccessDomain !Domain !PortNumber
- | RelayAccessSRVDomain !Domain
- | RelayAccessAddress !IP !PortNumber
type SRVPrefix = Domain
data LedgerRelayAccessPoint
- = LedgerRelayAccessDomain !Domain !PortNumber
- | LedgerRelayAccessSRVDomain !Domain
- | LedgerRelayAccessAddress !IP !PortNumber
newtype LedgerRelayAccessPointV1 = LedgerRelayAccessPointV1 {
- getLedgerReelayAccessPointV1 :: LedgerRelayAccessPoint
}
prefixLedgerRelayAccessPoint :: SRVPrefix -> LedgerRelayAccessPoint -> RelayAccessPoint
data AfterSlot
- = Always
- | After SlotNo
data UseLedgerPeers
- = DontUseLedgerPeers
- | UseLedgerPeers AfterSlot
data LedgerPeers
- = LedgerPeers [(PoolStake, NonEmpty RelayAccessPoint)]
- | BeforeSlot
data IsBigLedgerPeer
- = IsBigLedgerPeer
- | IsNotBigLedgerPeer
data LedgerPeerSnapshot where
- LedgerPeerSnapshotV2 (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))])
- pattern LedgerPeerSnapshot :: (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))]) -> LedgerPeerSnapshot
data LedgerPeersConsensusInterface extraAPI (m :: Type -> Type) = LedgerPeersConsensusInterface {
- lpGetLatestSlot :: STM m (WithOrigin SlotNo)
- lpGetLedgerPeers :: STM m [(PoolStake, NonEmpty LedgerRelayAccessPoint)]
- lpExtraAPI :: extraAPI
}
data LedgerPeersKind
- = AllLedgerPeers
- | BigLedgerPeers
newtype NumberOfPeers = NumberOfPeers {
- getNumberOfPeers :: Word16
}
newtype PoolStake = PoolStake {
- unPoolStake :: Rational
}
data TraceLedgerPeers
- = PickedBigLedgerPeer RelayAccessPoint AccPoolStake PoolStake
- | PickedLedgerPeer RelayAccessPoint AccPoolStake PoolStake
- | PickedBigLedgerPeers NumberOfPeers [RelayAccessPoint]
- | PickedLedgerPeers NumberOfPeers [RelayAccessPoint]
- | FetchingNewLedgerState Int Int
- | TraceLedgerPeersDomains [RelayAccessPoint]
- | DisabledLedgerPeers
- | TraceUseLedgerPeers UseLedgerPeers
- | WaitingOnRequest
- | RequestForPeers NumberOfPeers
- | ReusingLedgerState Int DiffTime
- | FallingBackToPublicRootPeers
- | NotEnoughBigLedgerPeers NumberOfPeers Int
- | NotEnoughLedgerPeers NumberOfPeers Int
- | UsingBigLedgerPeerSnapshot
data WithLedgerPeersArgs extraAPI (m :: Type -> Type) = WithLedgerPeersArgs {
- wlpRng :: StdGen
- wlpConsensusInterface :: LedgerPeersConsensusInterface extraAPI m
- wlpTracer :: Tracer m TraceLedgerPeers
- wlpGetUseLedgerPeers :: STM m UseLedgerPeers
- wlpGetLedgerPeerSnapshot :: STM m (Maybe LedgerPeerSnapshot)
- wlpSemaphore :: DNSSemaphore m
- wlpSRVPrefix :: SRVPrefix
}
withLedgerPeers :: forall peerAddr resolver extraAPI m a. (MonadAsync m, MonadThrow m, MonadMonotonicTime m, Ord peerAddr) => PeerActionsDNS peerAddr resolver m -> WithLedgerPeersArgs extraAPI m -> ((NumberOfPeers -> LedgerPeersKind -> m (Maybe (Set peerAddr, DiffTime))) -> Async m Void -> m a) -> m a
data PeerMetrics (m :: Type -> Type) p
newtype PeerMetricsConfiguration = PeerMetricsConfiguration {
- maxEntriesToTrack :: Int
}
data ReportPeerMetrics (m :: Type -> Type) peerAddr = ReportPeerMetrics {
- reportHeader :: Tracer (STM m) (TraceLabelPeer peerAddr (SlotNo, Time))
- reportFetch :: Tracer (STM m) (TraceLabelPeer peerAddr (SizeInBytes, SlotNo, Time))
}
newPeerMetric :: (MonadLabelledSTM m, NoThunks p, NFData p) => PeerMetricsConfiguration -> m (PeerMetrics m p)
newPeerMetric' :: (MonadLabelledSTM m, NoThunks p, NFData p) => SlotMetric p -> SlotMetric (p, SizeInBytes) -> PeerMetricsConfiguration -> m (PeerMetrics m p)
nullMetric :: forall (m :: Type -> Type) p. MonadSTM m => ReportPeerMetrics m p
reportMetric :: forall (m :: Type -> Type) p. (MonadSTM m, Ord p) => PeerMetricsConfiguration -> PeerMetrics m p -> ReportPeerMetrics m (ConnectionId p)
data PeerAdvertise
- = DoNotAdvertisePeer
- | DoAdvertisePeer
data PeerSharing
- = PeerSharingDisabled
- | PeerSharingEnabled
newtype PeerSharingAmount = PeerSharingAmount {
- getAmount :: Word8
}
data PeerSharingResult peerAddress
- = PeerSharingResult [peerAddress]
- | PeerSharingNotRegisteredYet
newtype Resource (m :: Type -> Type) a = Resource {
- withResource :: m (a, Resource m a)
}
type SRVPrefix = Domain
data DNSorIOError
resolveLedgerPeers :: forall m peerAddr resolver. (Ord peerAddr, MonadThrow m, MonadAsync m) => DNSSemaphore m -> ResolvConf -> DNSActions peerAddr resolver m -> LedgerPeersKind -> [RelayAccessPoint] -> StdGen -> m (Map Domain (Set peerAddr))
data DNSActions peerAddr resolver (m :: Type -> Type) = DNSActions {
- dnsResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError resolver))
- dnsAsyncResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError resolver))
- dnsLookupWithTTL :: DNSPeersKind -> RelayAccessPoint -> ResolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr)
}
data DNSSemaphore (m :: Type -> Type)
data PeerActionsDNS peeraddr resolver (m :: Type -> Type) = PeerActionsDNS {
- paToPeerAddr :: IP -> PortNumber -> peeraddr
- paDnsActions :: DNSActions peeraddr resolver m
}
ioDNSActions :: Tracer IO DNSTrace -> DNSLookupType -> (IP -> PortNumber -> peerAddr) -> DNSActions peerAddr Resolver IO
data DNSLookupType
- = LookupReqAOnly
- | LookupReqAAAAOnly
- | LookupReqAAndAAAA
type DNSLookupResult peerAddr = Either [DNSError] [(peerAddr, TTL)]
data DNSTrace
- = DNSLookupResult DNSPeersKind Domain (Maybe Domain) [(IP, PortNumber, TTL)]
- | DNSLookupError DNSPeersKind (Maybe DNSLookupType) Domain DNSError
- | SRVLookupResult DNSPeersKind Domain [(Domain, Word16, Word16, Word16, TTL)]
- | SRVLookupError DNSPeersKind Domain
retryResource :: forall (m :: Type -> Type) e a. MonadDelay m => Tracer m e -> NonEmpty DiffTime -> Resource m (Either e a) -> Resource m a
constantResource :: forall (m :: Type -> Type) a. Applicative m => a -> Resource m a
dispatchLookupWithTTL :: MonadAsync m => DNSLookupType -> (resolver -> resolvConf -> Domain -> TYPE -> m (Maybe (Either DNSError DNSMessage))) -> Tracer m DNSTrace -> (IP -> PortNumber -> peerAddr) -> DNSPeersKind -> RelayAccessPoint -> resolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr)
data DNSPeersKind
- = DNSLocalPeer
- | DNSPublicPeer
- | DNSLedgerPeer LedgerPeersKind
newLedgerAndPublicRootDNSSemaphore :: MonadSTM m => m (DNSSemaphore m)
newDNSLocalRootSemaphore :: forall (m :: Type -> Type). MonadSTM m => STM m (DNSSemaphore m)
withDNSSemaphore :: (MonadSTM m, MonadThrow m) => DNSSemaphore m -> m a -> m a
localRootPeersProvider :: forall m extraFlags peerAddr resolver. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, Ord peerAddr, Eq extraFlags) => Tracer m (TraceLocalRootPeers extraFlags peerAddr) -> PeerActionsDNS peerAddr resolver m -> ResolvConf -> StdGen -> STM m [(HotValency, WarmValency, Map RelayAccessPoint (LocalRootConfig extraFlags))] -> StrictTVar m [(HotValency, WarmValency, Map peerAddr (LocalRootConfig extraFlags))] -> m Void
data TraceLocalRootPeers extraFlags peerAddr
- = TraceLocalRootDomains (Config extraFlags RelayAccessPoint)
- | TraceLocalRootWaiting RelayAccessPoint DiffTime
- | TraceLocalRootGroups (Config extraFlags peerAddr)
- | TraceLocalRootDNSMap (Map RelayAccessPoint [peerAddr])
- | TraceLocalRootReconfigured (Config extraFlags RelayAccessPoint) (Config extraFlags RelayAccessPoint)
- | TraceLocalRootFailure RelayAccessPoint DNSorIOError
- | TraceLocalRootError Domain SomeException
publicRootPeersProvider :: forall peerAddr resolver a m. (MonadThrow m, MonadAsync m, Ord peerAddr) => Tracer m TracePublicRootPeers -> (IP -> PortNumber -> peerAddr) -> DNSSemaphore m -> ResolvConf -> STM m (Map RelayAccessPoint PeerAdvertise) -> DNSActions peerAddr resolver m -> StdGen -> ((Int -> m (Map peerAddr PeerAdvertise, DiffTime)) -> m a) -> m a
data TracePublicRootPeers
- = TracePublicRootRelayAccessPoint (Map RelayAccessPoint PeerAdvertise)
- | TracePublicRootDomains [RelayAccessPoint]
data KnownPeerInfo = KnownPeerInfo {
- knownPeerFailCount :: !Int
- knownPeerTepid :: !Bool
- knownPeerSharing :: !(StrictMaybe PeerSharing)
- knownPeerAdvertise :: !(StrictMaybe PeerAdvertise)
- knownSuccessfulConnection :: !Bool
}
data LocalRootPeers extraFlags peeraddr
newtype HotValency = HotValency {
- getHotValency :: Int
}
data LocalRootConfig extraFlags = LocalRootConfig {
- peerAdvertise :: !PeerAdvertise
- diffusionMode :: !DiffusionMode
- extraLocalRootFlags :: !extraFlags
}
newtype WarmValency = WarmValency {
- getWarmValency :: Int
}

Documentation

data PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn (m :: Type -> Type) Source #

Constructors

PeerSelectionActions

Fields

peerSelectionTargets :: PeerSelectionTargets
These are the targets as seen in the static configuration
readPeerSelectionTargets :: STM m PeerSelectionTargets
Read current Peer Selection Targets these can be changed by Churn Governor
readLocalRootPeersFromFile :: STM m (Config extraFlags RelayAccessPoint)
Read the original set of locally configured root peers.
This should come from ArgumentsExtra when initializing Diffusion
readLocalRootPeers :: STM m (Config extraFlags peeraddr)
Read the current set of locally or privately known root peers.
In general this is expected to be updated asynchronously by some other thread. It is intended to cover the use case of peers from local configuration. It could be dynamic due to DNS resolution, or due to dynamic configuration updates.
It is structured as a collection of (non-overlapping) groups of peers where we are supposed to select n from each group.
readInboundPeers :: m (Map peeraddr PeerSharing)
Read inbound peers which negotiated duplex connection.
peerSharing :: PeerSharing
Read the current Peer Sharing willingness value
This value comes from the Node's configuration file.
peerConnToPeerSharing :: peerconn -> PeerSharing
Get the remote's side PeerSharing value from peerconn
peerconn ideally comes from a call to establishPeerConnection. This will establish a connection and perform handshake. The returned peerconn has all the versionData negotiated in the handshake, including the remote peer's PeerSharing willingness information.
extraPeersAPI :: PublicExtraPeersAPI extraPeers peeraddr
Public Extra Peers Actions
extraStateToExtraCounters :: PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraCounters
Compute extraCounters from PeerSelectionState
requestPublicRootPeers :: LedgerPeersKind -> StdGen -> Int -> m (PublicRootPeers extraPeers peeraddr, DiffTime)
Request a sample of public root peers.
It is intended to cover use cases including:
- federated relays from a DNS pool
- Official bootstrap peers from a trusted source
- stake pool relays published in the blockchain
- a pre-distributed snapshot of stake pool relays from the blockchain
It also makes a distinction between normal and big ledger peers to be fetched.
requestPeerShare :: PeerSharingAmount -> peeraddr -> m (PeerSharingResult peeraddr)
The action to contact a known peer and request a sample of its known peers.
peerStateActions :: PeerStateActions peeraddr peerconn m
Core actions run by the governor to change PeerStatus.
getLedgerStateCtx :: LedgerPeersConsensusInterface extraAPI m
Read the current ledger state
readLedgerPeerSnapshot :: STM m (Maybe LedgerPeerSnapshot)
Read the current state of ledger peer snapshot

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 PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn Source #

The internal state used by the peerSelectionGovernor.

The local and public root sets are disjoint, and their union is the overall root set.

Documentation of individual fields describes some of the invariants these structures should maintain. For the entire picture, see assertPeerSelectionState.

Instances

Instances details

(Ord peeraddr, Show extraFlags, Show peeraddr, Show extraPeers, Show peerconn, Show extraState) => Show (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods showsPrec :: Int -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> ShowS # show :: PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> String # showList :: [PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn] -> ShowS #

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

Callbacks which are performed to change peer state.

Constructors

PeerStateActions

Fields

monitorPeerConnection :: peerconn -> STM m (PeerStatus, Maybe RepromoteDelay)
Monitor peer state. Must be non-blocking.
establishPeerConnection :: IsBigLedgerPeer -> DiffusionMode -> peeraddr -> m peerconn
Establish new connection: cold to warm.
IsBigLedgerPeer is passed from the outbound governor to the mini-protocol callbacks.
activatePeerConnection :: IsBigLedgerPeer -> peerconn -> m ()
Activate a connection: warm to hot promotion.
IsBigLedgerPeer is passed from the outbound governor to the mini-protocol callbacks.
deactivatePeerConnection :: peerconn -> m ()
Deactive a peer: hot to warm demotion.
closePeerConnection :: peerconn -> m ()
Close a connection: warm to cold transition.
errorDelay :: RepromoteDelay
Expose repromote delay received as spsExitPolicy through PeerStateActionsArguments.

data PeerSelectionPolicy peeraddr (m :: Type -> Type) Source #

Constructors

PeerSelectionPolicy

Fields

policyPickKnownPeersForPeerShare :: PickPolicy peeraddr (STM m)
policyPickColdPeersToPromote :: PickPolicy peeraddr (STM m)
policyPickWarmPeersToPromote :: PickPolicy peeraddr (STM m)
policyPickHotPeersToDemote :: PickPolicy peeraddr (STM m)
policyPickWarmPeersToDemote :: PickPolicy peeraddr (STM m)
policyPickColdPeersToForget :: PickPolicy peeraddr (STM m)
policyPickInboundPeers :: PickPolicy peeraddr (STM m)
policyFindPublicRootTimeout :: !DiffTime
policyMaxInProgressPeerShareReqs :: !Int
Maximum number of peer sharing requests that can be in progress
policyPeerShareRetryTime :: !DiffTime
Amount of time a node has to wait before issuing a new peer sharing request
policyPeerShareBatchWaitTime :: !DiffTime
Amount of time a batch of peer sharing requests is allowed to take
policyPeerShareOverallTimeout :: !DiffTime
Amount of time the overall batches of peer sharing requests are allowed to take
policyPeerShareActivationDelay :: !DiffTime
Delay until we consider a peer suitable for peer sharing

type PickPolicy peeraddr (m :: Type -> Type) = (peeraddr -> PeerSource) -> (peeraddr -> Int) -> (peeraddr -> Bool) -> Set peeraddr -> Int -> m (Set peeraddr) Source #

A peer pick policy is an action that picks a subset of elements from a map of peers.

The pre-condition is that the map of available choices will be non-empty, and the requested number to pick will be strictly positive.

The post-condition is that the picked set is non-empty but must not be bigger than the requested number.

Peer selection API is using `STM m` monad, internally it is using m.

data PeerSelectionInterfaces extraState extraFlags extraPeers extraCounters peeraddr peerconn (m :: Type -> Type) Source #

Interfaces required by the peer selection governor, which do not need to be shared with actions and thus are not part of PeerSelectionActions.

Constructors

PeerSelectionInterfaces

Fields

countersVar :: StrictTVar m (PeerSelectionCounters extraCounters)
PeerSelectionCounters are shared with churn through a StrictTVar.
publicStateVar :: StrictTVar m (PublicPeerSelectionState peeraddr)
PublicPeerSelectionState var.
debugStateVar :: StrictTVar m (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn)
PeerSelectionState shared for debugging purposes (to support SIGUSR1 debug event tracing)
readUseLedgerPeers :: STM m UseLedgerPeers
UseLedgerPeers used by peerSelectionGovernor to support HiddenRelayOrBP

data PeerSelectionGovernorArgs extraState extraDebugState extraFlags extraPeers extraAPI extraCounters extraTrace peeraddr peerconn exception (m :: Type -> Type) Source #

Constructors

PeerSelectionGovernorArgs

Fields

abortGovernor :: Time -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> Maybe exception
updateWithState :: PeerSelectionInterfaces extraState extraFlags extraPeers extraCounters peeraddr peerconn m -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn m -> PeerSelectionSetsWithSizes extraCounters peeraddr -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> STM m ()
extraDecisions :: ExtraGuardedDecisions extraState extraDebugState extraFlags extraPeers extraAPI extraCounters extraTrace peeraddr peerconn m

data TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr Source #

Constructors

TraceLocalRootPeersChanged (LocalRootPeers extraFlags peeraddr) (LocalRootPeers extraFlags peeraddr)
TraceTargetsChanged PeerSelectionTargets PeerSelectionTargets	Peer selection targets changed: old targets, new targets.
TracePublicRootsRequest Int Int
TracePublicRootsResults (PublicRootPeers extraPeers peeraddr) Int DiffTime
TracePublicRootsFailure SomeException Int DiffTime
TraceForgetColdPeers Int Int (Set peeraddr)	target known peers, actual known peers, selected peers
TraceBigLedgerPeersRequest Int Int
TraceBigLedgerPeersResults (Set peeraddr) Int DiffTime
TraceBigLedgerPeersFailure SomeException Int DiffTime
TraceForgetBigLedgerPeers Int Int (Set peeraddr)	target known big ledger peers, actual known big ledger peers, selected peers
TracePeerShareRequests Int Int PeerSharingAmount (Set peeraddr) (Set peeraddr)	target known peers, actual known peers, number of peers to request, peers available for peer sharing, peers selected for peer sharing
TracePeerShareResults [(peeraddr, Either SomeException (PeerSharingResult peeraddr))]
TracePeerShareResultsFiltered [peeraddr]
TracePickInboundPeers Int Int (Map peeraddr PeerSharing) (Set peeraddr)	target known peers, actual known peers, selected inbound peers, available peers
TracePromoteColdPeers Int Int (Set peeraddr)	target established, actual established, selected peers
TracePromoteColdLocalPeers [(WarmValency, Int)] (Set peeraddr)	target local established, actual local established, selected peers
TracePromoteColdFailed Int Int peeraddr DiffTime SomeException
TracePromoteColdDone Int Int peeraddr	target established, actual established, peer
TracePromoteColdBigLedgerPeers Int Int (Set peeraddr)	target established big ledger peers, actual established big ledger peers, selected peers
TracePromoteColdBigLedgerPeerFailed Int Int peeraddr DiffTime SomeException	target established big ledger peers, actual established big ledger peers, peer, delay until next promotion, reason
TracePromoteColdBigLedgerPeerDone Int Int peeraddr	target established big ledger peers, actual established big ledger peers, peer
TracePromoteWarmPeers Int Int (Set peeraddr)	target active, actual active, selected peers
TracePromoteWarmLocalPeers	Promote local peers to warm
Fields [(HotValency, Int)] local per-group `(target active, actual active)`, only limited to groups which are below their target. (Set peeraddr) selected peers \| target active, actual active, peer, reason
TracePromoteWarmFailed Int Int peeraddr SomeException
TracePromoteWarmDone Int Int peeraddr	target active, actual active, peer
TracePromoteWarmAborted Int Int peeraddr	aborted promotion of a warm peer; likely it was asynchronously demoted in the meantime. target active, actual active, peer
TracePromoteWarmBigLedgerPeers Int Int (Set peeraddr)	target active big ledger peers, actual active big ledger peers, selected peers
TracePromoteWarmBigLedgerPeerFailed Int Int peeraddr SomeException	target active big ledger peers, actual active big ledger peers, peer, reason
TracePromoteWarmBigLedgerPeerDone Int Int peeraddr	target active big ledger peers, actual active big ledger peers, peer
TracePromoteWarmBigLedgerPeerAborted Int Int peeraddr	aborted promotion of a warm big ledger peer; likely it was asynchronously demoted in the meantime. target active, actual active, peer
TraceDemoteWarmPeers Int Int (Set peeraddr)	target established, actual established, selected peers
TraceDemoteWarmFailed Int Int peeraddr SomeException	target established, actual established, peer, reason
TraceDemoteWarmDone Int Int peeraddr	target established, actual established, peer
TraceDemoteWarmBigLedgerPeers Int Int (Set peeraddr)	target established big ledger peers, actual established big ledger peers, selected peers
TraceDemoteWarmBigLedgerPeerFailed Int Int peeraddr SomeException	target established big ledger peers, actual established big ledger peers, peer, reason
TraceDemoteWarmBigLedgerPeerDone Int Int peeraddr	target established big ledger peers, actual established big ledger peers, peer
TraceDemoteHotPeers Int Int (Set peeraddr)	target active, actual active, selected peers
TraceDemoteLocalHotPeers [(HotValency, Int)] (Set peeraddr)	local per-group (target active, actual active), selected peers
TraceDemoteHotFailed Int Int peeraddr SomeException	target active, actual active, peer, reason
TraceDemoteHotDone Int Int peeraddr	target active, actual active, peer
TraceDemoteHotBigLedgerPeers Int Int (Set peeraddr)	target active big ledger peers, actual active big ledger peers, selected peers
TraceDemoteHotBigLedgerPeerFailed Int Int peeraddr SomeException	target active big ledger peers, actual active big ledger peers, peer, reason
TraceDemoteHotBigLedgerPeerDone Int Int peeraddr	target active big ledger peers, actual active big ledger peers, peer
TraceDemoteAsynchronous (Map peeraddr (PeerStatus, Maybe RepromoteDelay))
TraceDemoteLocalAsynchronous (Map peeraddr (PeerStatus, Maybe RepromoteDelay))
TraceDemoteBigLedgerPeersAsynchronous (Map peeraddr (PeerStatus, Maybe RepromoteDelay))
TraceGovernorWakeup
TraceChurnWait DiffTime
TraceChurnAction
Fields DiffTime duration of the churn action ChurnAction churn action type Int how many peers were removed or added within the duration of the action.
TraceChurnTimeout
Fields DiffTime duration of the churn action ChurnAction churn action type Int how many peers were removed or added within the duration of the action; note that if the action timeouts the governor will still look to remove or add peers as required.
TraceOnlyBootstrapPeers
TraceBootstrapPeersFlagChangedWhilstInSensitiveState
TraceVerifyPeerSnapshot Bool
TraceOutboundGovernorCriticalFailure SomeException
TraceDebugState Time (DebugPeerSelectionState extraDebugState extraFlags extraPeers peeraddr)
ExtraTrace extraTrace

Instances

Instances details

(Ord peeraddr, Show extraFlags, Show extraPeers, Show peeraddr, Show extraDebugState, Show extraTrace) => Show (TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods showsPrec :: Int -> TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr -> ShowS # show :: TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr -> String # showList :: [TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr] -> ShowS #

data ChurnAction Source #

Constructors

DecreasedActivePeers
IncreasedActivePeers
DecreasedActiveBigLedgerPeers
IncreasedActiveBigLedgerPeers
DecreasedEstablishedPeers
IncreasedEstablishedPeers
IncreasedEstablishedBigLedgerPeers
DecreasedEstablishedBigLedgerPeers
DecreasedKnownPeers
IncreasedKnownPeers
DecreasedKnownBigLedgerPeers
IncreasedKnownBigLedgerPeers

Instances

Instances details

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

data DebugPeerSelection extraState extraFlags extraPeers peeraddr where Source #

Constructors

TraceGovernorState :: forall extraState extraFlags extraPeers peeraddr peerconn. Show peerconn => Time -> Maybe DiffTime -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> DebugPeerSelection extraState extraFlags extraPeers peeraddr

Instances

Instances details

(Show extraState, Show extraFlags, Show extraPeers, Ord peeraddr, Show peeraddr) => Show (DebugPeerSelection extraState extraFlags extraPeers peeraddr) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods showsPrec :: Int -> DebugPeerSelection extraState extraFlags extraPeers peeraddr -> ShowS # show :: DebugPeerSelection extraState extraFlags extraPeers peeraddr -> String # showList :: [DebugPeerSelection extraState extraFlags extraPeers peeraddr] -> ShowS #

data AssociationMode Source #

A node is classified as LocalRootsOnly if it is a hidden relay or a BP, e.g. if it is configured such that it can only have a chance to be connected to local roots. This is true if the node is configured in one of two ways:

DontUseBootstrapPeers, DontUseLedgerPeers and PeerSharingDisabled; or
UseBootstrapPeers, DontUseLedgerPeers and PeerSharingDisabled, but it's not using any bootstrap peers (i.e. it is synced).

Note that in the second case a node might transition between LocalRootsOnly and Unrestricted modes, depending on LedgerStateJudgement.

See readAssociationMode.

Constructors

LocalRootsOnly
Unrestricted

Instances

Instances details

Show AssociationMode Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods showsPrec :: Int -> AssociationMode -> ShowS # show :: AssociationMode -> String # showList :: [AssociationMode] -> ShowS #

data DebugPeerSelectionState extraState extraFlags extraPeers peeraddr Source #

Constructors

DebugPeerSelectionState

Fields

dpssTargets :: !PeerSelectionTargets
dpssLocalRootPeers :: !(LocalRootPeers extraFlags peeraddr)
dpssPublicRootPeers :: !(PublicRootPeers extraPeers peeraddr)
dpssKnownPeers :: !(KnownPeers peeraddr)
dpssEstablishedPeers :: !(Set peeraddr)
dpssActivePeers :: !(Set peeraddr)
dpssPublicRootBackoffs :: !Int
dpssPublicRootRetryTime :: !Time
dpssInProgressPublicRootsReq :: !Bool
dpssBigLedgerPeerBackoffs :: !Int
dpssBigLedgerPeerRetryTime :: !Time
dpssInProgressBigLedgerPeersReq :: !Bool
dpssInProgressPeerShareReqs :: !Int
dpssInProgressPromoteCold :: !(Set peeraddr)
dpssInProgressPromoteWarm :: !(Set peeraddr)
dpssInProgressDemoteWarm :: !(Set peeraddr)
dpssInProgressDemoteHot :: !(Set peeraddr)
dpssInProgressDemoteToCold :: !(Set peeraddr)
dpssUpstreamyness :: !(Map peeraddr Int)
dpssFetchynessBlocks :: !(Map peeraddr Int)
dpssAssociationMode :: !AssociationMode
dpssHotDurations :: !(Map peeraddr (IsBigLedgerPeer, DiffTime))
dpssExtraState :: !extraState

Instances

Instances details

(Ord peeraddr, Show extraFlags, Show peeraddr, Show extraPeers, Show extraState) => Show (DebugPeerSelectionState extraState extraFlags extraPeers peeraddr) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods showsPrec :: Int -> DebugPeerSelectionState extraState extraFlags extraPeers peeraddr -> ShowS # show :: DebugPeerSelectionState extraState extraFlags extraPeers peeraddr -> String # showList :: [DebugPeerSelectionState extraState extraFlags extraPeers peeraddr] -> ShowS #

peerSelectionGovernor :: (Alternative (STM m), MonadAsync m, MonadDelay m, MonadLabelledSTM m, MonadMask m, MonadTimer m, Ord peeraddr, Show peerconn, Hashable peeraddr, Exception exception, Eq extraCounters, Semigroup extraPeers, Eq extraFlags) => Tracer m (TracePeerSelection extraDebugState extraFlags extraPeers extraTrace peeraddr) -> Tracer m (DebugPeerSelection extraState extraFlags extraPeers peeraddr) -> Tracer m (PeerSelectionCounters extraCounters) -> PeerSelectionGovernorArgs extraState extraDebugState extraFlags extraPeers extraAPI extraCounters extraTrace peeraddr peerconn exception m -> StdGen -> extraState -> extraPeers -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn m -> PeerSelectionPolicy peeraddr m -> PeerSelectionInterfaces extraState extraFlags extraPeers extraCounters peeraddr peerconn m -> m Void Source #

assertPeerSelectionState Source #

Arguments

:: Ord peeraddr
=> (extraPeers -> Set peeraddr)	This function comes from `PublicExtraPeersAPI` It is needed to compute the set of all extraPeers and use that information to compute the invariant.
-> (extraPeers -> Bool)	This function comes from `PublicExtraPeersAPI` It is needed to compute the invariant of the extraPeers data type.
-> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn
-> a
-> a

sanePeerSelectionTargets :: PeerSelectionTargets -> Bool Source #

establishedPeersStatus :: Ord peeraddr => PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> Map peeraddr PeerStatus Source #

A view of the status of each established peer, for testing and debugging.

newtype PublicPeerSelectionState peeraddr Source #

Public PeerSelectionState that can be accessed by Peer Sharing mechanisms without any problem.

This data type should not expose too much information and keep only essential data needed for computing the peer sharing request result

Constructors

PublicPeerSelectionState
Fields availableToShare :: Set peeraddr

makePublicPeerSelectionStateVar :: (MonadSTM m, Ord peeraddr) => m (StrictTVar m (PublicPeerSelectionState peeraddr)) Source #

data PeerSelectionView extraViews a Source #

Peer selection view.

This is a functor which is used to hold computation of various peer sets and their sizes. See peerSelectionStateToView, peerSelectionStateToCounters.

Constructors

PeerSelectionView

Fields

viewRootPeers :: a
viewKnownPeers :: a
number of known peers excluding big ledger peers
viewAvailableToConnectPeers :: a
number of known peers available to connect
viewColdPeersPromotions :: a
number of known peers (excluding big ledger peers) being promoted to warm
viewEstablishedPeers :: a
number of established peers excluding big ledger peers
viewWarmPeersDemotions :: a
number of warm peers (excluding big ledger peers) being demoted to cold
viewWarmPeersPromotions :: a
number of warm peers (excluding big ledger peers) being promote to hot
viewActivePeers :: a
number of active peers excluding big ledger peers
viewActivePeersDemotions :: a
number of active peers (excluding big ledger peers) being demoted to warm
viewKnownBigLedgerPeers :: a
number of known big ledger peers
viewAvailableToConnectBigLedgerPeers :: a
number of known big ledger peers available to connect
viewColdBigLedgerPeersPromotions :: a
number of cold big ledger peers being promoted to warm
viewEstablishedBigLedgerPeers :: a
number of established big ledger peers
viewWarmBigLedgerPeersDemotions :: a
number of warm big ledger peers being demoted to cold
viewWarmBigLedgerPeersPromotions :: a
number of warm big ledger peers being promote to hot
viewActiveBigLedgerPeers :: a
number of active big ledger peers
viewActiveBigLedgerPeersDemotions :: a
number of active big ledger peers being demoted to warm
viewKnownLocalRootPeers :: a
number of known local root peers should always be equal to the sum of established & active local roots.
viewAvailableToConnectLocalRootPeers :: a
viewColdLocalRootPeersPromotions :: a
viewEstablishedLocalRootPeers :: a
viewWarmLocalRootPeersPromotions :: a
viewActiveLocalRootPeers :: a
viewActiveLocalRootPeersDemotions :: a
viewKnownNonRootPeers :: a
number of known non root peers. These are mostly peers received through peer sharing (or light peer sharing); but also will contains peers which used to be local roots after a reconfiguration.
viewColdNonRootPeersPromotions :: a
viewEstablishedNonRootPeers :: a
viewWarmNonRootPeersDemotions :: a
viewWarmNonRootPeersPromotions :: a
viewActiveNonRootPeers :: a
viewActiveNonRootPeersDemotions :: a
viewExtraViews :: extraViews

Bundled Patterns

pattern PeerSelectionCounters :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> extraCounters -> PeerSelectionCounters extraCounters
pattern PeerSelectionCountersHWC :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> PeerSelectionCounters extraCounters	A Pattern synonym which computes `hot`, `warm`, `cold` counters from `PeerSelectionCounters`.

Instances

Instances details

Functor (PeerSelectionView extraViews) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods fmap :: (a -> b) -> PeerSelectionView extraViews a -> PeerSelectionView extraViews b # (<$) :: a -> PeerSelectionView extraViews b -> PeerSelectionView extraViews a #
(Show a, Show extraViews) => Show (PeerSelectionView extraViews a) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods showsPrec :: Int -> PeerSelectionView extraViews a -> ShowS # show :: PeerSelectionView extraViews a -> String # showList :: [PeerSelectionView extraViews a] -> ShowS #
(Eq a, Eq extraViews) => Eq (PeerSelectionView extraViews a) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods (==) :: PeerSelectionView extraViews a -> PeerSelectionView extraViews a -> Bool # (/=) :: PeerSelectionView extraViews a -> PeerSelectionView extraViews a -> Bool #

type PeerSelectionCounters extraCounters = PeerSelectionView extraCounters Int Source #

type PeerSelectionSetsWithSizes extraViews peeraddr = PeerSelectionView extraViews (Set peeraddr, Int) Source #

peerSelectionStateToCounters Source #

Arguments

:: Ord peeraddr
=> (extraPeers -> Set peeraddr)	This function comes from `PublicExtraPeersAPI` It is needed to compute the set of all extraPeers and use that information to compute the counters.
-> (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraCounters)
-> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn
-> PeerSelectionCounters extraCounters

emptyPeerSelectionCounters :: extraCounters -> PeerSelectionCounters extraCounters Source #

nullPeerSelectionTargets :: PeerSelectionTargets Source #

emptyPeerSelectionState :: StdGen -> extraState -> extraPeers -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn Source #

peerSelectionStateToView :: Ord peeraddr => (extraPeers -> Set peeraddr) -> (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraViews) -> PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> PeerSelectionSetsWithSizes extraViews peeraddr Source #

Compute peer selection sets & their sizes.

This function is used internally by the outbound-governor and to compute PeerSelectionCounters which are used by churn or are traced (e.g. as EKG metrics). For this reason one has to be very careful when changing the function, as it will affect the outbound governor behaviour.

module Ouroboros.Network.PeerSelection.Types

data PublicRootPeers extraPeers peeraddr Source #

Public Root Peers consist of either a set of manually configured bootstrap peers.

There's an implicit precedence that will priorise bootstrap peers over the other sets, so if we are adding a bootstrap peer and that peer is already a member of other public root set, it is going to be removed from that set and added to the bootstrap peer set.

Instances

Instances details

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

module Ouroboros.Network.PeerSelection.PeerStateActions

data PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn (m :: Type -> Type) Source #

Constructors

PeerSelectionActions PeerSelectionTargets (STM m PeerSelectionTargets) (STM m (Config extraFlags RelayAccessPoint)) (STM m (Config extraFlags peeraddr)) (m (Map peeraddr PeerSharing)) PeerSharing (peerconn -> PeerSharing) (PublicExtraPeersAPI extraPeers peeraddr) (PeerSelectionState extraState extraFlags extraPeers peeraddr peerconn -> extraCounters) (LedgerPeersKind -> StdGen -> Int -> m (PublicRootPeers extraPeers peeraddr, DiffTime)) (PeerSharingAmount -> peeraddr -> m (PeerSharingResult peeraddr)) (PeerStateActions peeraddr peerconn m) (LedgerPeersConsensusInterface extraAPI m) (STM m (Maybe LedgerPeerSnapshot))

withPeerSelectionActions Source #

Arguments

:: forall extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn resolver m a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, Ord peeraddr, Eq extraFlags)
=> Tracer m (TraceLocalRootPeers extraFlags peeraddr)
-> StrictTVar m (Config extraFlags peeraddr)
-> PeerActionsDNS peeraddr resolver m
-> ((NumberOfPeers -> LedgerPeersKind -> m (Maybe (Set peeraddr, DiffTime))) -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters peeraddr peerconn m)	construct PeerSelectionActions given a function which obtains ledger peers that is supplied by `withLedgerPeers`.
-> WithLedgerPeersArgs extraAPI m
-> StdGen
-> ((Async m Void, Async m Void) -> PeerSelectionActions extraState extraFlags extraPeers extraAPI extraCounters 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

requestPeerSharingResult :: (MonadSTM m, MonadMVar m, Ord peeraddr) => STM m (Map peeraddr (PeerSharingController peeraddr m)) -> PeerSharingAmount -> peeraddr -> m (PeerSharingResult peeraddr) Source #

data IP #

A unified IP data for IPv4 and IPv6. To create this, use the data constructors. Or use read "192.0.2.1" :: IP, for example. Also, "192.0.2.1" can be used as literal with OverloadedStrings.

>>> (read "192.0.2.1" :: IP) == IPv4 (read "192.0.2.1" :: IPv4)
True
>>> (read "2001:db8:00:00:00:00:00:01" :: IP) == IPv6 (read "2001:db8:00:00:00:00:00:01" :: IPv6)
True

Constructors

IPv4
Fields ipv4 :: IPv4
IPv6
Fields ipv6 :: IPv6

Instances

Instances details

Data IP

Instance details

Defined in Data.IP.Addr

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IP -> c IP #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IP #

toConstr :: IP -> Constr #

dataTypeOf :: IP -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IP) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IP) #

gmapT :: (forall b. Data b => b -> b) -> IP -> IP #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r #

gmapQ :: (forall d. Data d => d -> u) -> IP -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> IP -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IP -> m IP #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IP -> m IP #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IP -> m IP #

IsString IP

Instance details

Defined in Data.IP.Addr

Methods

fromString :: String -> IP #

Enum IP

Instance details

Defined in Data.IP.Addr

Methods

succ :: IP -> IP #

pred :: IP -> IP #

toEnum :: Int -> IP #

fromEnum :: IP -> Int #

enumFrom :: IP -> [IP] #

enumFromThen :: IP -> IP -> [IP] #

enumFromTo :: IP -> IP -> [IP] #

enumFromThenTo :: IP -> IP -> IP -> [IP] #

Generic IP

Instance details

Defined in Data.IP.Addr

Associated Types

type Rep IP

Instance details

Defined in Data.IP.Addr

type Rep IP = D1 ('MetaData "IP" "Data.IP.Addr" "iproute-1.7.15-9cbdeead1ad2dac143f0d52d2bd4e8985efc2da022ee700aca7f7cbbf02b48d0" 'False) (C1 ('MetaCons "IPv4" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv4") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 IPv4)) :+: C1 ('MetaCons "IPv6" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPv6)))

Methods

from :: IP -> Rep IP x #

to :: Rep IP x -> IP #

Read IP

Instance details

Defined in Data.IP.Addr

Methods

readsPrec :: Int -> ReadS IP #

readList :: ReadS [IP] #

readPrec :: ReadPrec IP #

readListPrec :: ReadPrec [IP] #

Show IP

Instance details

Defined in Data.IP.Addr

Methods

showsPrec :: Int -> IP -> ShowS #

show :: IP -> String #

showList :: [IP] -> ShowS #

Eq IP

Equality over IP addresses. Correctly compare IPv4 and IPv4-embedded-in-IPv6 addresses.

>>> (read "2001:db8:00:00:00:00:00:01" :: IP) == (read "2001:db8:00:00:00:00:00:01" :: IP)
True
>>> (read "2001:db8:00:00:00:00:00:01" :: IP) == (read "2001:db8:00:00:00:00:00:05" :: IP)
False
>>> (read "127.0.0.1" :: IP) == (read "127.0.0.1" :: IP)
True
>>> (read "127.0.0.1" :: IP) == (read "10.0.0.1" :: IP)
False
>>> (read "::ffff:127.0.0.1" :: IP) == (read "127.0.0.1" :: IP)
True
>>> (read "::ffff:127.0.0.1" :: IP) == (read "127.0.0.9" :: IP)
False
>>> (read "::ffff:127.0.0.1" :: IP) >= (read "127.0.0.1" :: IP)
True
>>> (read "::ffff:127.0.0.1" :: IP) <= (read "127.0.0.1" :: IP)
True

Instance details

Defined in Data.IP.Addr

Methods

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

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

Ord IP

Instance details

Defined in Data.IP.Addr

Methods

compare :: IP -> IP -> Ordering #

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

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

(>) :: IP -> IP -> Bool #

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

max :: IP -> IP -> IP #

min :: IP -> IP -> IP #

type Rep IP

Instance details

Defined in Data.IP.Addr

type Rep IP = D1 ('MetaData "IP" "Data.IP.Addr" "iproute-1.7.15-9cbdeead1ad2dac143f0d52d2bd4e8985efc2da022ee700aca7f7cbbf02b48d0" 'False) (C1 ('MetaCons "IPv4" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv4") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 IPv4)) :+: C1 ('MetaCons "IPv6" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPv6)))

data PortNumber #

Port number. Use the Num instance (i.e. use a literal) to create a PortNumber value.

>>> 1 :: PortNumber
1
>>> read "1" :: PortNumber
1
>>> show (12345 :: PortNumber)
"12345"
>>> 50000 < (51000 :: PortNumber)
True
>>> 50000 < (52000 :: PortNumber)
True
>>> 50000 + (10000 :: PortNumber)
60000

Instances

Instances details

Bounded PortNumber
Instance details Defined in Network.Socket.Types Methods minBound :: PortNumber # maxBound :: PortNumber #
Enum PortNumber
Instance details Defined in Network.Socket.Types Methods succ :: PortNumber -> PortNumber # pred :: PortNumber -> PortNumber # toEnum :: Int -> PortNumber # fromEnum :: PortNumber -> Int # enumFrom :: PortNumber -> [PortNumber] # enumFromThen :: PortNumber -> PortNumber -> [PortNumber] # enumFromTo :: PortNumber -> PortNumber -> [PortNumber] # enumFromThenTo :: PortNumber -> PortNumber -> PortNumber -> [PortNumber] #
Storable PortNumber
Instance details Defined in Network.Socket.Types Methods sizeOf :: PortNumber -> Int # alignment :: PortNumber -> Int # peekElemOff :: Ptr PortNumber -> Int -> IO PortNumber # pokeElemOff :: Ptr PortNumber -> Int -> PortNumber -> IO () # peekByteOff :: Ptr b -> Int -> IO PortNumber # pokeByteOff :: Ptr b -> Int -> PortNumber -> IO () # peek :: Ptr PortNumber -> IO PortNumber # poke :: Ptr PortNumber -> PortNumber -> IO () #
Num PortNumber
Instance details Defined in Network.Socket.Types Methods (+) :: PortNumber -> PortNumber -> PortNumber # (-) :: PortNumber -> PortNumber -> PortNumber # (*) :: PortNumber -> PortNumber -> PortNumber # negate :: PortNumber -> PortNumber # abs :: PortNumber -> PortNumber # signum :: PortNumber -> PortNumber # fromInteger :: Integer -> PortNumber #
Read PortNumber
Instance details Defined in Network.Socket.Types Methods readsPrec :: Int -> ReadS PortNumber # readList :: ReadS [PortNumber] # readPrec :: ReadPrec PortNumber # readListPrec :: ReadPrec [PortNumber] #
Integral PortNumber
Instance details Defined in Network.Socket.Types Methods quot :: PortNumber -> PortNumber -> PortNumber # rem :: PortNumber -> PortNumber -> PortNumber # div :: PortNumber -> PortNumber -> PortNumber # mod :: PortNumber -> PortNumber -> PortNumber # quotRem :: PortNumber -> PortNumber -> (PortNumber, PortNumber) # divMod :: PortNumber -> PortNumber -> (PortNumber, PortNumber) # toInteger :: PortNumber -> Integer #
Real PortNumber
Instance details Defined in Network.Socket.Types Methods toRational :: PortNumber -> Rational #
Show PortNumber
Instance details Defined in Network.Socket.Types Methods showsPrec :: Int -> PortNumber -> ShowS # show :: PortNumber -> String # showList :: [PortNumber] -> ShowS #
Eq PortNumber
Instance details Defined in Network.Socket.Types Methods (==) :: PortNumber -> PortNumber -> Bool # (/=) :: PortNumber -> PortNumber -> Bool #
Ord PortNumber
Instance details Defined in Network.Socket.Types Methods compare :: PortNumber -> PortNumber -> Ordering # (<) :: PortNumber -> PortNumber -> Bool # (<=) :: PortNumber -> PortNumber -> Bool # (>) :: PortNumber -> PortNumber -> Bool # (>=) :: PortNumber -> PortNumber -> Bool # max :: PortNumber -> PortNumber -> PortNumber # min :: PortNumber -> PortNumber -> PortNumber #

data RelayAccessPoint #

Constructors

RelayAccessDomain !Domain !PortNumber
RelayAccessSRVDomain !Domain
RelayAccessAddress !IP !PortNumber

Instances

Instances details

FromJSON RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods parseJSON :: Value -> Parser RelayAccessPoint # parseJSONList :: Value -> Parser [RelayAccessPoint] # omittedField :: Maybe RelayAccessPoint #
ToJSON RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods toJSON :: RelayAccessPoint -> Value # toEncoding :: RelayAccessPoint -> Encoding # toJSONList :: [RelayAccessPoint] -> Value # toEncodingList :: [RelayAccessPoint] -> Encoding # omitField :: RelayAccessPoint -> Bool #
FromCBOR RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods fromCBOR :: Decoder s RelayAccessPoint # label :: Proxy RelayAccessPoint -> Text #
ToCBOR RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods toCBOR :: RelayAccessPoint -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy RelayAccessPoint -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [RelayAccessPoint] -> Size #
NFData RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods rnf :: RelayAccessPoint -> () #
Show RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods showsPrec :: Int -> RelayAccessPoint -> ShowS # show :: RelayAccessPoint -> String # showList :: [RelayAccessPoint] -> ShowS #
Eq RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods (==) :: RelayAccessPoint -> RelayAccessPoint -> Bool # (/=) :: RelayAccessPoint -> RelayAccessPoint -> Bool #
Ord RelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods compare :: RelayAccessPoint -> RelayAccessPoint -> Ordering # (<) :: RelayAccessPoint -> RelayAccessPoint -> Bool # (<=) :: RelayAccessPoint -> RelayAccessPoint -> Bool # (>) :: RelayAccessPoint -> RelayAccessPoint -> Bool # (>=) :: RelayAccessPoint -> RelayAccessPoint -> Bool # max :: RelayAccessPoint -> RelayAccessPoint -> RelayAccessPoint # min :: RelayAccessPoint -> RelayAccessPoint -> RelayAccessPoint #

type SRVPrefix = Domain #

data LedgerRelayAccessPoint #

Constructors

LedgerRelayAccessDomain !Domain !PortNumber
LedgerRelayAccessSRVDomain !Domain
LedgerRelayAccessAddress !IP !PortNumber

Instances

Instances details

FromJSON LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods parseJSON :: Value -> Parser LedgerRelayAccessPoint # parseJSONList :: Value -> Parser [LedgerRelayAccessPoint] # omittedField :: Maybe LedgerRelayAccessPoint #
ToJSON LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods toJSON :: LedgerRelayAccessPoint -> Value # toEncoding :: LedgerRelayAccessPoint -> Encoding # toJSONList :: [LedgerRelayAccessPoint] -> Value # toEncodingList :: [LedgerRelayAccessPoint] -> Encoding # omitField :: LedgerRelayAccessPoint -> Bool #
FromCBOR LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods fromCBOR :: Decoder s LedgerRelayAccessPoint # label :: Proxy LedgerRelayAccessPoint -> Text #
ToCBOR LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods toCBOR :: LedgerRelayAccessPoint -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy LedgerRelayAccessPoint -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [LedgerRelayAccessPoint] -> Size #
NFData LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods rnf :: LedgerRelayAccessPoint -> () #
Show LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods showsPrec :: Int -> LedgerRelayAccessPoint -> ShowS # show :: LedgerRelayAccessPoint -> String # showList :: [LedgerRelayAccessPoint] -> ShowS #
Eq LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods (==) :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> Bool # (/=) :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> Bool #
Ord LedgerRelayAccessPoint
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods compare :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> Ordering # (<) :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> Bool # (<=) :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> Bool # (>) :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> Bool # (>=) :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> Bool # max :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> LedgerRelayAccessPoint # min :: LedgerRelayAccessPoint -> LedgerRelayAccessPoint -> LedgerRelayAccessPoint #

newtype LedgerRelayAccessPointV1 #

Constructors

LedgerRelayAccessPointV1
Fields getLedgerReelayAccessPointV1 :: LedgerRelayAccessPoint

Instances

Instances details

FromJSON LedgerRelayAccessPointV1
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods parseJSON :: Value -> Parser LedgerRelayAccessPointV1 # parseJSONList :: Value -> Parser [LedgerRelayAccessPointV1] # omittedField :: Maybe LedgerRelayAccessPointV1 #

prefixLedgerRelayAccessPoint :: SRVPrefix -> LedgerRelayAccessPoint -> RelayAccessPoint #

data AfterSlot #

Constructors

Always
After SlotNo

Instances

Instances details

Generic AfterSlot

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Associated Types

type Rep AfterSlot

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

type Rep AfterSlot = D1 ('MetaData "AfterSlot" "Ouroboros.Network.PeerSelection.LedgerPeers.Type" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "Always" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "After" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo)))

Methods

from :: AfterSlot -> Rep AfterSlot x #

to :: Rep AfterSlot x -> AfterSlot #

Show AfterSlot

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

showsPrec :: Int -> AfterSlot -> ShowS #

show :: AfterSlot -> String #

showList :: [AfterSlot] -> ShowS #

Eq AfterSlot

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

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

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

NoThunks AfterSlot

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

noThunks :: Context -> AfterSlot -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> AfterSlot -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy AfterSlot -> String #

type Rep AfterSlot

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

type Rep AfterSlot = D1 ('MetaData "AfterSlot" "Ouroboros.Network.PeerSelection.LedgerPeers.Type" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "Always" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "After" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo)))

data UseLedgerPeers #

Constructors

DontUseLedgerPeers
UseLedgerPeers AfterSlot

Instances

Instances details

Generic UseLedgerPeers

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Associated Types

type Rep UseLedgerPeers

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

type Rep UseLedgerPeers = D1 ('MetaData "UseLedgerPeers" "Ouroboros.Network.PeerSelection.LedgerPeers.Type" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "DontUseLedgerPeers" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UseLedgerPeers" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AfterSlot)))

Methods

from :: UseLedgerPeers -> Rep UseLedgerPeers x #

to :: Rep UseLedgerPeers x -> UseLedgerPeers #

Show UseLedgerPeers

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

showsPrec :: Int -> UseLedgerPeers -> ShowS #

show :: UseLedgerPeers -> String #

showList :: [UseLedgerPeers] -> ShowS #

Eq UseLedgerPeers

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

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

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

NoThunks UseLedgerPeers

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

Methods

noThunks :: Context -> UseLedgerPeers -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> UseLedgerPeers -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy UseLedgerPeers -> String #

type Rep UseLedgerPeers

Instance details

Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type

type Rep UseLedgerPeers = D1 ('MetaData "UseLedgerPeers" "Ouroboros.Network.PeerSelection.LedgerPeers.Type" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "DontUseLedgerPeers" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UseLedgerPeers" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AfterSlot)))

data LedgerPeers Source #

Ledger Peer request result

Constructors

LedgerPeers [(PoolStake, NonEmpty RelayAccessPoint)]	Ledger peers
BeforeSlot	No result because the node is still before the configured UseLedgerAfter slot number

Instances

Instances details

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

data IsBigLedgerPeer #

Constructors

IsBigLedgerPeer
IsNotBigLedgerPeer

Instances

Instances details

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

data LedgerPeerSnapshot #

Constructors

LedgerPeerSnapshotV2 (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))])

Bundled Patterns

pattern LedgerPeerSnapshot :: (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))]) -> LedgerPeerSnapshot

Instances

Instances details

FromJSON LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods parseJSON :: Value -> Parser LedgerPeerSnapshot # parseJSONList :: Value -> Parser [LedgerPeerSnapshot] # omittedField :: Maybe LedgerPeerSnapshot #
ToJSON LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods toJSON :: LedgerPeerSnapshot -> Value # toEncoding :: LedgerPeerSnapshot -> Encoding # toJSONList :: [LedgerPeerSnapshot] -> Value # toEncodingList :: [LedgerPeerSnapshot] -> Encoding # omitField :: LedgerPeerSnapshot -> Bool #
Show LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec :: Int -> LedgerPeerSnapshot -> ShowS # show :: LedgerPeerSnapshot -> String # showList :: [LedgerPeerSnapshot] -> ShowS #
Eq LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) :: LedgerPeerSnapshot -> LedgerPeerSnapshot -> Bool # (/=) :: LedgerPeerSnapshot -> LedgerPeerSnapshot -> Bool #

data LedgerPeersConsensusInterface extraAPI (m :: Type -> Type) #

Constructors

LedgerPeersConsensusInterface
Fields lpGetLatestSlot :: STM m (WithOrigin SlotNo) lpGetLedgerPeers :: STM m [(PoolStake, NonEmpty LedgerRelayAccessPoint)] lpExtraAPI :: extraAPI

data LedgerPeersKind #

Constructors

AllLedgerPeers
BigLedgerPeers

Instances

Instances details

Show LedgerPeersKind
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec :: Int -> LedgerPeersKind -> ShowS # show :: LedgerPeersKind -> String # showList :: [LedgerPeersKind] -> ShowS #

newtype NumberOfPeers Source #

Number of peers to pick.

Constructors

NumberOfPeers
Fields getNumberOfPeers :: Word16

Instances

Instances details

Show NumberOfPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers Methods showsPrec :: Int -> NumberOfPeers -> ShowS # show :: NumberOfPeers -> String # showList :: [NumberOfPeers] -> ShowS #

newtype PoolStake #

Constructors

PoolStake
Fields unPoolStake :: Rational

Instances

Instances details

NFData PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods rnf :: PoolStake -> () #
Num PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (+) :: PoolStake -> PoolStake -> PoolStake # (-) :: PoolStake -> PoolStake -> PoolStake # (*) :: PoolStake -> PoolStake -> PoolStake # negate :: PoolStake -> PoolStake # abs :: PoolStake -> PoolStake # signum :: PoolStake -> PoolStake # fromInteger :: Integer -> PoolStake #
Fractional PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (/) :: PoolStake -> PoolStake -> PoolStake # recip :: PoolStake -> PoolStake # fromRational :: Rational -> PoolStake #
Show PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec :: Int -> PoolStake -> ShowS # show :: PoolStake -> String # showList :: [PoolStake] -> ShowS #
Eq PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) :: PoolStake -> PoolStake -> Bool # (/=) :: PoolStake -> PoolStake -> Bool #
Ord PoolStake
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods compare :: PoolStake -> PoolStake -> Ordering # (<) :: PoolStake -> PoolStake -> Bool # (<=) :: PoolStake -> PoolStake -> Bool # (>) :: PoolStake -> PoolStake -> Bool # (>=) :: PoolStake -> PoolStake -> Bool # max :: PoolStake -> PoolStake -> PoolStake # min :: PoolStake -> PoolStake -> PoolStake #

data TraceLedgerPeers Source #

Trace LedgerPeers events.

Constructors

PickedBigLedgerPeer RelayAccessPoint AccPoolStake PoolStake	Trace for a significant ledger peer picked with accumulated and relative stake of its pool.
PickedLedgerPeer RelayAccessPoint AccPoolStake PoolStake	Trace for a ledger peer picked with accumulated and relative stake of its pool.
PickedBigLedgerPeers NumberOfPeers [RelayAccessPoint]
PickedLedgerPeers NumberOfPeers [RelayAccessPoint]	Trace for the number of peers and we wanted to pick and the list of peers picked.
FetchingNewLedgerState Int Int	Trace for fetching a new list of peers from the ledger. The first Int is the number of ledger peers returned the latter is the number of big ledger peers.
TraceLedgerPeersDomains [RelayAccessPoint]
DisabledLedgerPeers	Trace for when getting peers from the ledger is disabled, that is DontUseLedgerPeers.
TraceUseLedgerPeers UseLedgerPeers	Trace UseLedgerPeers value
WaitingOnRequest
RequestForPeers NumberOfPeers
ReusingLedgerState Int DiffTime
FallingBackToPublicRootPeers
NotEnoughBigLedgerPeers NumberOfPeers Int
NotEnoughLedgerPeers NumberOfPeers Int
UsingBigLedgerPeerSnapshot

Instances

Instances details

Show TraceLedgerPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers Methods showsPrec :: Int -> TraceLedgerPeers -> ShowS # show :: TraceLedgerPeers -> String # showList :: [TraceLedgerPeers] -> ShowS #

data WithLedgerPeersArgs extraAPI (m :: Type -> Type) Source #

Argument record for withLedgerPeers

Constructors

WithLedgerPeersArgs

Fields

wlpRng :: StdGen
Random generator for picking ledger peers
wlpConsensusInterface :: LedgerPeersConsensusInterface extraAPI m
wlpTracer :: Tracer m TraceLedgerPeers
Get Ledger Peers comes from here
wlpGetUseLedgerPeers :: STM m UseLedgerPeers
Get Use Ledger After value
wlpGetLedgerPeerSnapshot :: STM m (Maybe LedgerPeerSnapshot)
Get ledger peer snapshot from file read by node
wlpSemaphore :: DNSSemaphore m
wlpSRVPrefix :: SRVPrefix
SRV prefix (CIP#0155)

withLedgerPeers :: forall peerAddr resolver extraAPI m a. (MonadAsync m, MonadThrow m, MonadMonotonicTime m, Ord peerAddr) => PeerActionsDNS peerAddr resolver m -> WithLedgerPeersArgs extraAPI m -> ((NumberOfPeers -> LedgerPeersKind -> m (Maybe (Set peerAddr, DiffTime))) -> Async m Void -> m a) -> m a Source #

For a LedgerPeers worker thread and submit request and receive responses.

data PeerMetrics (m :: Type -> Type) p Source #

Mutable peer metrics state accessible via STM.

newtype PeerMetricsConfiguration Source #

Constructors

PeerMetricsConfiguration
Fields maxEntriesToTrack :: Int The maximum numbers of slots we will store data for. On some chains sometimes this corresponds to 1h worth of metrics sighs. this number MUST correspond to number of headers / blocks which are produced in one hour.

Instances

Instances details

NFData PeerMetricsConfiguration Source #

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerMetric

Methods

rnf :: PeerMetricsConfiguration -> () #

Generic PeerMetricsConfiguration Source #

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerMetric

Associated Types

type Rep PeerMetricsConfiguration

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerMetric

type Rep PeerMetricsConfiguration = D1 ('MetaData "PeerMetricsConfiguration" "Ouroboros.Network.PeerSelection.PeerMetric" "ouroboros-network-0.23.0.0-inplace" 'True) (C1 ('MetaCons "PeerMetricsConfiguration" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxEntriesToTrack") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: PeerMetricsConfiguration -> Rep PeerMetricsConfiguration x #

to :: Rep PeerMetricsConfiguration x -> PeerMetricsConfiguration #

Show PeerMetricsConfiguration Source #

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerMetric

Methods

showsPrec :: Int -> PeerMetricsConfiguration -> ShowS #

show :: PeerMetricsConfiguration -> String #

showList :: [PeerMetricsConfiguration] -> ShowS #

NoThunks PeerMetricsConfiguration Source #

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerMetric

Methods

noThunks :: Context -> PeerMetricsConfiguration -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> PeerMetricsConfiguration -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy PeerMetricsConfiguration -> String #

type Rep PeerMetricsConfiguration Source #

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerMetric

type Rep PeerMetricsConfiguration = D1 ('MetaData "PeerMetricsConfiguration" "Ouroboros.Network.PeerSelection.PeerMetric" "ouroboros-network-0.23.0.0-inplace" 'True) (C1 ('MetaCons "PeerMetricsConfiguration" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxEntriesToTrack") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data ReportPeerMetrics (m :: Type -> Type) peerAddr #

Constructors

ReportPeerMetrics
Fields reportHeader :: Tracer (STM m) (TraceLabelPeer peerAddr (SlotNo, Time)) reportFetch :: Tracer (STM m) (TraceLabelPeer peerAddr (SizeInBytes, SlotNo, Time))

newPeerMetric :: (MonadLabelledSTM m, NoThunks p, NFData p) => PeerMetricsConfiguration -> m (PeerMetrics m p) Source #

newPeerMetric' :: (MonadLabelledSTM m, NoThunks p, NFData p) => SlotMetric p -> SlotMetric (p, SizeInBytes) -> PeerMetricsConfiguration -> m (PeerMetrics m p) Source #

nullMetric :: forall (m :: Type -> Type) p. MonadSTM m => ReportPeerMetrics m p Source #

reportMetric :: forall (m :: Type -> Type) p. (MonadSTM m, Ord p) => PeerMetricsConfiguration -> PeerMetrics m p -> ReportPeerMetrics m (ConnectionId p) Source #

data PeerAdvertise #

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-0.23.0.0-inplace-api" '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-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "DoNotAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type))

data PeerSharing #

Constructors

PeerSharingDisabled
PeerSharingEnabled

Instances

Instances details

Monoid PeerSharing

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerSharing

Methods

mempty :: PeerSharing #

mappend :: PeerSharing -> PeerSharing -> PeerSharing #

mconcat :: [PeerSharing] -> PeerSharing #

Semigroup PeerSharing

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerSharing

Methods

(<>) :: PeerSharing -> PeerSharing -> PeerSharing #

sconcat :: NonEmpty PeerSharing -> PeerSharing #

stimes :: Integral b => b -> PeerSharing -> PeerSharing #

Generic PeerSharing

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerSharing

Associated Types

type Rep PeerSharing
Instance details Defined in Ouroboros.Network.PeerSelection.PeerSharing type Rep PeerSharing = D1 ('MetaData "PeerSharing" "Ouroboros.Network.PeerSelection.PeerSharing" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "PeerSharingDisabled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PeerSharingEnabled" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: PeerSharing -> Rep PeerSharing x #

to :: Rep PeerSharing x -> PeerSharing #

Read PeerSharing

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerSharing

Methods

readsPrec :: Int -> ReadS PeerSharing #

readList :: ReadS [PeerSharing] #

readPrec :: ReadPrec PeerSharing #

readListPrec :: ReadPrec [PeerSharing] #

Show PeerSharing

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerSharing

Methods

showsPrec :: Int -> PeerSharing -> ShowS #

show :: PeerSharing -> String #

showList :: [PeerSharing] -> ShowS #

Eq PeerSharing

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerSharing

Methods

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

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

type Rep PeerSharing

Instance details

Defined in Ouroboros.Network.PeerSelection.PeerSharing

type Rep PeerSharing = D1 ('MetaData "PeerSharing" "Ouroboros.Network.PeerSelection.PeerSharing" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "PeerSharingDisabled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PeerSharingEnabled" 'PrefixI 'False) (U1 :: Type -> Type))

newtype PeerSharingAmount #

Constructors

PeerSharingAmount
Fields getAmount :: Word8

Instances

Instances details

Enum PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

succ :: PeerSharingAmount -> PeerSharingAmount #

pred :: PeerSharingAmount -> PeerSharingAmount #

toEnum :: Int -> PeerSharingAmount #

fromEnum :: PeerSharingAmount -> Int #

enumFrom :: PeerSharingAmount -> [PeerSharingAmount] #

enumFromThen :: PeerSharingAmount -> PeerSharingAmount -> [PeerSharingAmount] #

enumFromTo :: PeerSharingAmount -> PeerSharingAmount -> [PeerSharingAmount] #

enumFromThenTo :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount -> [PeerSharingAmount] #

Generic PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Associated Types

type Rep PeerSharingAmount
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type type Rep PeerSharingAmount = D1 ('MetaData "PeerSharingAmount" "Ouroboros.Network.Protocol.PeerSharing.Type" "ouroboros-network-0.23.0.0-inplace-protocols" 'True) (C1 ('MetaCons "PeerSharingAmount" 'PrefixI 'True) (S1 ('MetaSel ('Just "getAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

Methods

from :: PeerSharingAmount -> Rep PeerSharingAmount x #

to :: Rep PeerSharingAmount x -> PeerSharingAmount #

Num PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

(+) :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

(-) :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

(*) :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

negate :: PeerSharingAmount -> PeerSharingAmount #

abs :: PeerSharingAmount -> PeerSharingAmount #

signum :: PeerSharingAmount -> PeerSharingAmount #

fromInteger :: Integer -> PeerSharingAmount #

Integral PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

quot :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

rem :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

div :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

mod :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

quotRem :: PeerSharingAmount -> PeerSharingAmount -> (PeerSharingAmount, PeerSharingAmount) #

divMod :: PeerSharingAmount -> PeerSharingAmount -> (PeerSharingAmount, PeerSharingAmount) #

toInteger :: PeerSharingAmount -> Integer #

Real PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

toRational :: PeerSharingAmount -> Rational #

Show PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

showsPrec :: Int -> PeerSharingAmount -> ShowS #

show :: PeerSharingAmount -> String #

showList :: [PeerSharingAmount] -> ShowS #

Eq PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

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

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

Ord PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

compare :: PeerSharingAmount -> PeerSharingAmount -> Ordering #

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

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

(>) :: PeerSharingAmount -> PeerSharingAmount -> Bool #

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

max :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

min :: PeerSharingAmount -> PeerSharingAmount -> PeerSharingAmount #

Serialise PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

encode :: PeerSharingAmount -> Encoding #

decode :: Decoder s PeerSharingAmount #

encodeList :: [PeerSharingAmount] -> Encoding #

decodeList :: Decoder s [PeerSharingAmount] #

type Rep PeerSharingAmount

Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

type Rep PeerSharingAmount = D1 ('MetaData "PeerSharingAmount" "Ouroboros.Network.Protocol.PeerSharing.Type" "ouroboros-network-0.23.0.0-inplace-protocols" 'True) (C1 ('MetaCons "PeerSharingAmount" 'PrefixI 'True) (S1 ('MetaSel ('Just "getAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

data PeerSharingResult peerAddress #

Constructors

PeerSharingResult [peerAddress]
PeerSharingNotRegisteredYet

Instances

Instances details

Show peerAddress => Show (PeerSharingResult peerAddress)
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods showsPrec :: Int -> PeerSharingResult peerAddress -> ShowS # show :: PeerSharingResult peerAddress -> String # showList :: [PeerSharingResult peerAddress] -> ShowS #
Eq peerAddress => Eq (PeerSharingResult peerAddress)
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods (==) :: PeerSharingResult peerAddress -> PeerSharingResult peerAddress -> Bool # (/=) :: PeerSharingResult peerAddress -> PeerSharingResult peerAddress -> Bool #

newtype Resource (m :: Type -> Type) a Source #

Evolving resource; We use it to reinitialise the DNS library if the `etcresolv.conf` file was modified.

Note: constantResource and retryResource are written using a simplified approach inspired by _"The Different Aspects of Monads and Mixins"_, by Bruno C. d S. Oliveira, see https://www.youtube.com/watch?v=pfwP4hXM5hA.

Constructors

Resource
Fields withResource :: m (a, Resource m a)

Instances

Instances details

Functor m => Functor (Resource m) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods fmap :: (a -> b) -> Resource m a -> Resource m b # (<$) :: a -> Resource m b -> Resource m a #

type SRVPrefix = Domain #

data DNSorIOError Source #

Instances

Instances details

Exception DNSorIOError Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods toException :: DNSorIOError -> SomeException # fromException :: SomeException -> Maybe DNSorIOError # displayException :: DNSorIOError -> String # backtraceDesired :: DNSorIOError -> Bool #
Show DNSorIOError Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods showsPrec :: Int -> DNSorIOError -> ShowS # show :: DNSorIOError -> String # showList :: [DNSorIOError] -> ShowS #

resolveLedgerPeers :: forall m peerAddr resolver. (Ord peerAddr, MonadThrow m, MonadAsync m) => DNSSemaphore m -> ResolvConf -> DNSActions peerAddr resolver m -> LedgerPeersKind -> [RelayAccessPoint] -> StdGen -> m (Map Domain (Set peerAddr)) Source #

Provides DNS resolution functionality.

Concurrently resolve DNS names, respecting the maxDNSConcurrency limit.

data DNSActions peerAddr resolver (m :: Type -> Type) Source #

Dictionary of DNS actions vocabulary

Constructors

DNSActions

Fields

dnsResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError resolver))
TODO: it could be useful for publicRootPeersProvider.
dnsAsyncResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError resolver))
Resource which passes the Resolver (or abstract resolver type) through a StrictTVar. Better than resolverResource when using in multiple threads.
On Windows we use a different implementation which always returns a newly initialised Resolver at each step. This is because on Windows we don't have a way to check that the network configuration has changed. The dns library is using 'GetNetworkParams@ win32 api call to get the list of default dns servers.
dnsLookupWithTTL :: DNSPeersKind -> RelayAccessPoint -> ResolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr)
Like lookupA but also return the TTL for the results.
DNS library timeouts do not work reliably on Windows (#1873), hence the additional timeout.

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

A semaphore used to limit concurrency of dns names resolution.

data PeerActionsDNS peeraddr resolver (m :: Type -> Type) Source #

Record of some parameters that are commonly used together

TODO: rename as PeerDNSActions; can we bundle paToPeerAddr with DNSActions?

Constructors

PeerActionsDNS
Fields paToPeerAddr :: IP -> PortNumber -> peeraddr paDnsActions :: DNSActions peeraddr resolver m

ioDNSActions :: Tracer IO DNSTrace -> DNSLookupType -> (IP -> PortNumber -> peerAddr) -> DNSActions peerAddr Resolver IO Source #

IO DNSActions which resolve domain names with Resolver.

The IPv4 and IPv6 addresses the node will be using should determine the LookupReqs so that we can avoid lookups for address types that wont be used.

It guarantees that returned TTLs are strictly greater than 0.

data DNSLookupType Source #

Constructors

LookupReqAOnly
LookupReqAAAAOnly
LookupReqAAndAAAA

Instances

Instances details

Show DNSLookupType Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods showsPrec :: Int -> DNSLookupType -> ShowS # show :: DNSLookupType -> String # showList :: [DNSLookupType] -> ShowS #

type DNSLookupResult peerAddr = Either [DNSError] [(peerAddr, TTL)] Source #

Wraps lookup result for client code

data DNSTrace Source #

Provides DNS lookup trace information

Constructors

DNSLookupResult	DNS lookup result
Fields DNSPeersKind Domain source of addresses (Maybe Domain) SRV domain, if relevant [(IP, PortNumber, TTL)] payload
DNSLookupError DNSPeersKind (Maybe DNSLookupType) Domain DNSError	`DNS` lookup error
SRVLookupResult DNSPeersKind Domain [(Domain, Word16, Word16, Word16, TTL)]
SRVLookupError	`SRV` resolution errors, all dns errors are traced with `DNSLookupError`
Fields DNSPeersKind Domain SRV domain

Instances

Instances details

Show DNSTrace Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods showsPrec :: Int -> DNSTrace -> ShowS # show :: DNSTrace -> String # showList :: [DNSTrace] -> ShowS #

retryResource :: forall (m :: Type -> Type) e a. MonadDelay m => Tracer m e -> NonEmpty DiffTime -> Resource m (Either e a) -> Resource m a Source #

A Resource which will exhibit the given Resource but retry it with a given delay until a success. On first success it will reset the delays.

constantResource :: forall (m :: Type -> Type) a. Applicative m => a -> Resource m a Source #

dispatchLookupWithTTL :: MonadAsync m => DNSLookupType -> (resolver -> resolvConf -> Domain -> TYPE -> m (Maybe (Either DNSError DNSMessage))) -> Tracer m DNSTrace -> (IP -> PortNumber -> peerAddr) -> DNSPeersKind -> RelayAccessPoint -> resolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr) Source #

data DNSPeersKind Source #

Bundled with DNS lookup trace for observability

Constructors

DNSLocalPeer
DNSPublicPeer
DNSLedgerPeer LedgerPeersKind

Instances

Instances details

Show DNSPeersKind Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods showsPrec :: Int -> DNSPeersKind -> ShowS # show :: DNSPeersKind -> String # showList :: [DNSPeersKind] -> ShowS #

newLedgerAndPublicRootDNSSemaphore :: MonadSTM m => m (DNSSemaphore m) Source #

Create a DNSSemaphore for root and ledger peers.

newDNSLocalRootSemaphore :: forall (m :: Type -> Type). MonadSTM m => STM m (DNSSemaphore m) Source #

Create a DNSSemaphore for local root peers.

withDNSSemaphore :: (MonadSTM m, MonadThrow m) => DNSSemaphore m -> m a -> m a Source #

Run a computation by attempting to acquire the semaphore first. On termination or failure free the semaphore

localRootPeersProvider Source #

Arguments

:: forall m extraFlags peerAddr resolver. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, Ord peerAddr, Eq extraFlags)
=> Tracer m (TraceLocalRootPeers extraFlags peerAddr)
-> PeerActionsDNS peerAddr resolver m
-> ResolvConf
-> StdGen
-> STM m [(HotValency, WarmValency, Map RelayAccessPoint (LocalRootConfig extraFlags))]	input
-> StrictTVar m [(HotValency, WarmValency, Map peerAddr (LocalRootConfig extraFlags))]	output `TVar`
-> m Void

Resolve RelayAddress-es of local root peers using dns if needed. Local roots are provided wrapped in a StrictTVar, which value might change (re-read form a config file). The resolved dns names are available through the output StrictTVar.

data TraceLocalRootPeers extraFlags peerAddr Source #

Constructors

TraceLocalRootDomains (Config extraFlags RelayAccessPoint)	`Int` is the configured valency for the local producer groups
TraceLocalRootWaiting RelayAccessPoint DiffTime
TraceLocalRootGroups (Config extraFlags peerAddr)	This traces the results of the local root peer provider
TraceLocalRootDNSMap (Map RelayAccessPoint [peerAddr])	This traces the results of the domain name resolution
TraceLocalRootReconfigured
Fields (Config extraFlags RelayAccessPoint) Old value (Config extraFlags RelayAccessPoint) New value
TraceLocalRootFailure RelayAccessPoint DNSorIOError
TraceLocalRootError Domain SomeException

Instances

Instances details

(Show extraFlags, Show peerAddr) => Show (TraceLocalRootPeers extraFlags peerAddr) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.LocalRootPeers Methods showsPrec :: Int -> TraceLocalRootPeers extraFlags peerAddr -> ShowS # show :: TraceLocalRootPeers extraFlags peerAddr -> String # showList :: [TraceLocalRootPeers extraFlags peerAddr] -> ShowS #

publicRootPeersProvider :: forall peerAddr resolver a m. (MonadThrow m, MonadAsync m, Ord peerAddr) => Tracer m TracePublicRootPeers -> (IP -> PortNumber -> peerAddr) -> DNSSemaphore m -> ResolvConf -> STM m (Map RelayAccessPoint PeerAdvertise) -> DNSActions peerAddr resolver m -> StdGen -> ((Int -> m (Map peerAddr PeerAdvertise, DiffTime)) -> m a) -> m a Source #

fulfills a request from requestPublicRootPeers

data TracePublicRootPeers Source #

Constructors

TracePublicRootRelayAccessPoint (Map RelayAccessPoint PeerAdvertise)
TracePublicRootDomains [RelayAccessPoint]

Instances

Instances details

Show TracePublicRootPeers Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.PublicRootPeers Methods showsPrec :: Int -> TracePublicRootPeers -> ShowS # show :: TracePublicRootPeers -> String # showList :: [TracePublicRootPeers] -> ShowS #

data KnownPeerInfo Source #

Constructors

KnownPeerInfo

Fields

knownPeerFailCount :: !Int
The current number of consecutive connection attempt failures. This is reset as soon as there is a successful connection.
It is used to implement the exponential backoff strategy and may also be used by policies to select peers to forget.
knownPeerTepid :: !Bool
Indicates if the peer was hot but then got demoted.
It is set on the hot to warm promotion and reset on cold to warm, thus it can be present for warm or cold peers. It's purpose is to provide information to demotion policies.
It is also used as useful information for the Peer Selection Governor when deciding which peers to share when Peer Sharing.
knownPeerSharing :: !(StrictMaybe PeerSharing)
Indicates current remote Peer Willingness information.
If a connection with this address hasn't been established we won't have any information about this particular flag
It is used by the Peer Sharing logic to decide if we should share/ask about/to this peer's address to others.
knownPeerAdvertise :: !(StrictMaybe PeerAdvertise)
Indicates current local Peer Willingness information.
If this address didn't come from a local configuration then this value is set to DoAdvertise by default.
It is used by the Peer Sharing logic to decide if we should share about this peer's address to others.
knownSuccessfulConnection :: !Bool
Indicates if the node managed to connect to the peer at some point in time.
This differs from the tepid flag in a way that this flag will be set/enabled if we established a successful connection with this peer. It won't be unset after this.

Instances

Instances details

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

data LocalRootPeers extraFlags peeraddr Source #

Instances

Instances details

(Show extraFlags, Show peeraddr, Ord peeraddr) => Show (LocalRootPeers extraFlags peeraddr) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods showsPrec :: Int -> LocalRootPeers extraFlags peeraddr -> ShowS # show :: LocalRootPeers extraFlags peeraddr -> String # showList :: [LocalRootPeers extraFlags peeraddr] -> ShowS #
(Eq peeraddr, Eq extraFlags) => Eq (LocalRootPeers extraFlags peeraddr) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods (==) :: LocalRootPeers extraFlags peeraddr -> LocalRootPeers extraFlags peeraddr -> Bool # (/=) :: LocalRootPeers extraFlags peeraddr -> LocalRootPeers extraFlags peeraddr -> Bool #

newtype HotValency Source #

Newtype wrapper representing hot valency value from local root group configuration

Constructors

HotValency
Fields getHotValency :: Int

Instances

Instances details

Num HotValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods (+) :: HotValency -> HotValency -> HotValency # (-) :: HotValency -> HotValency -> HotValency # (*) :: HotValency -> HotValency -> HotValency # negate :: HotValency -> HotValency # abs :: HotValency -> HotValency # signum :: HotValency -> HotValency # fromInteger :: Integer -> HotValency #
Show HotValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods showsPrec :: Int -> HotValency -> ShowS # show :: HotValency -> String # showList :: [HotValency] -> ShowS #
Eq HotValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods (==) :: HotValency -> HotValency -> Bool # (/=) :: HotValency -> HotValency -> Bool #
Ord HotValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods compare :: HotValency -> HotValency -> Ordering # (<) :: HotValency -> HotValency -> Bool # (<=) :: HotValency -> HotValency -> Bool # (>) :: HotValency -> HotValency -> Bool # (>=) :: HotValency -> HotValency -> Bool # max :: HotValency -> HotValency -> HotValency # min :: HotValency -> HotValency -> HotValency #

data LocalRootConfig extraFlags Source #

Constructors

LocalRootConfig
Fields peerAdvertise :: !PeerAdvertise diffusionMode :: !DiffusionMode extraLocalRootFlags :: !extraFlags

Instances

Instances details

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

newtype WarmValency Source #

Newtype wrapper representing warm valency value from local root group configuration

Constructors

WarmValency
Fields getWarmValency :: Int

Instances

Instances details

Num WarmValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods (+) :: WarmValency -> WarmValency -> WarmValency # (-) :: WarmValency -> WarmValency -> WarmValency # (*) :: WarmValency -> WarmValency -> WarmValency # negate :: WarmValency -> WarmValency # abs :: WarmValency -> WarmValency # signum :: WarmValency -> WarmValency # fromInteger :: Integer -> WarmValency #
Show WarmValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods showsPrec :: Int -> WarmValency -> ShowS # show :: WarmValency -> String # showList :: [WarmValency] -> ShowS #
Eq WarmValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods (==) :: WarmValency -> WarmValency -> Bool # (/=) :: WarmValency -> WarmValency -> Bool #
Ord WarmValency Source #
Instance details Defined in Ouroboros.Network.PeerSelection.State.LocalRootPeers Methods compare :: WarmValency -> WarmValency -> Ordering # (<) :: WarmValency -> WarmValency -> Bool # (<=) :: WarmValency -> WarmValency -> Bool # (>) :: WarmValency -> WarmValency -> Bool # (>=) :: WarmValency -> WarmValency -> Bool # max :: WarmValency -> WarmValency -> WarmValency # min :: WarmValency -> WarmValency -> WarmValency #