Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Ouroboros.Network.Diffusion.Node

Contents

run a node
node types
extra types used by the node
configuration constants

Synopsis

data BlockGeneratorArgs block s = BlockGeneratorArgs {
- bgaSlotDuration :: DiffTime
- bgaBlockGenerator :: s -> Anchor block -> SlotNo -> (Maybe block, s)
- bgaSeed :: s
}
data LimitsAndTimeouts header block = LimitsAndTimeouts {
- chainSyncLimits :: MiniProtocolLimits
- chainSyncSizeLimits :: ProtocolSizeLimits (ChainSync header (Point block) (Tip block)) ByteString
- chainSyncTimeLimits :: ProtocolTimeLimits (ChainSync header (Point block) (Tip block))
- blockFetchLimits :: MiniProtocolLimits
- blockFetchSizeLimits :: ProtocolSizeLimits (BlockFetch block (Point block)) ByteString
- blockFetchTimeLimits :: ProtocolTimeLimits (BlockFetch block (Point block))
- keepAliveLimits :: MiniProtocolLimits
- keepAliveSizeLimits :: ProtocolSizeLimits KeepAlive ByteString
- keepAliveTimeLimits :: ProtocolTimeLimits KeepAlive
- pingPongLimits :: MiniProtocolLimits
- pingPongSizeLimits :: ProtocolSizeLimits PingPong ByteString
- pingPongTimeLimits :: ProtocolTimeLimits PingPong
- handshakeLimits :: MiniProtocolLimits
- handshakeTimeLimits :: ProtocolTimeLimits (Handshake NtNVersion NtNVersionData)
- handhsakeSizeLimits :: ProtocolSizeLimits (Handshake NtNVersion NtNVersionData) ByteString
- peerSharingLimits :: MiniProtocolLimits
- peerSharingTimeLimits :: ProtocolTimeLimits (PeerSharing NtNAddr)
- peerSharingSizeLimits :: ProtocolSizeLimits (PeerSharing NtNAddr) ByteString
}
data Interfaces m = Interfaces {
- iNtnSnocket :: Snocket m (NtNFD m) NtNAddr
- iNtnBearer :: MakeBearer m (NtNFD m)
- iAcceptVersion :: NtNVersionData -> NtNVersionData -> Accept NtNVersionData
- iNtnDomainResolver :: DNSLookupType -> [DomainAccessPoint] -> m (Map DomainAccessPoint (Set NtNAddr))
- iNtcSnocket :: Snocket m (NtCFD m) NtCAddr
- iNtcBearer :: MakeBearer m (NtCFD m)
- iRng :: StdGen
- iDomainMap :: StrictTVar m (Map Domain [(IP, TTL)])
- iLedgerPeersConsensusInterface :: LedgerPeersConsensusInterface m
}
data Arguments m = Arguments {
- aIPAddress :: NtNAddr
- aAcceptedLimits :: AcceptedConnectionsLimit
- aDiffusionMode :: DiffusionMode
- aKeepAliveInterval :: DiffTime
- aPingPongInterval :: DiffTime
- aShouldChainSyncExit :: BlockHeader -> m Bool
- aChainSyncEarlyExit :: Bool
- aPeerSelectionTargets :: PeerSelectionTargets
- aReadLocalRootPeers :: STM m [(HotValency, WarmValency, Map RelayAccessPoint PeerAdvertise)]
- aReadPublicRootPeers :: STM m (Map RelayAccessPoint PeerAdvertise)
- aOwnPeerSharing :: PeerSharing
- aReadUseLedgerAfter :: STM m UseLedgerAfter
- aProtocolIdleTimeout :: DiffTime
- aTimeWaitTimeout :: DiffTime
- aDNSTimeoutScript :: Script DNSTimeout
- aDNSLookupDelayScript :: Script DNSLookupDelay
- aDebugTracer :: Tracer m String
}
run :: forall resolver m. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadEvaluate m, MonadFix m, MonadFork m, MonadLabelledSTM m, MonadTraceSTM m, MonadMask m, MonadSay m, MonadST m, MonadTime m, MonadTimer m, MonadThrow m, MonadThrow (STM m), MonadMVar m, resolver ~ (), forall a. Semigroup a => Semigroup (m a), Eq (Async m Void)) => BlockGeneratorArgs Block StdGen -> LimitsAndTimeouts BlockHeader Block -> Interfaces m -> Arguments m -> TracersExtra NtNAddr NtNVersion NtNVersionData NtCAddr NtCVersion NtCVersionData ResolverException m -> Tracer m (TraceLabelPeer NtNAddr (TraceFetchClientState BlockHeader)) -> m Void
type NtNAddr = TestAddress NtNAddr_
type NtNFD m = FD m NtNAddr
type NtCAddr = TestAddress Int
type NtCFD m = FD m NtCAddr
data AcceptedConnectionsLimit = AcceptedConnectionsLimit {
- acceptedConnectionsHardLimit :: !Word32
- acceptedConnectionsSoftLimit :: !Word32
- acceptedConnectionsDelay :: !DiffTime
}
data DiffusionMode
- = InitiatorOnlyDiffusionMode
- | InitiatorAndResponderDiffusionMode
data PeerAdvertise
- = DoNotAdvertisePeer
- | DoAdvertisePeer
data PeerSelectionTargets = PeerSelectionTargets {
- targetNumberOfRootPeers :: !Int
- targetNumberOfKnownPeers :: !Int
- targetNumberOfEstablishedPeers :: !Int
- targetNumberOfActivePeers :: !Int
- targetNumberOfKnownBigLedgerPeers :: !Int
- targetNumberOfEstablishedBigLedgerPeers :: !Int
- targetNumberOfActiveBigLedgerPeers :: !Int
}
config_RECONNECT_DELAY :: ReconnectDelay

run a node

data BlockGeneratorArgs block s Source #

Constructors

BlockGeneratorArgs
Fields bgaSlotDuration :: DiffTime slot duration bgaBlockGenerator :: s -> Anchor block -> SlotNo -> (Maybe block, s) block generator bgaSeed :: s

data LimitsAndTimeouts header block Source #

Limits and protocol timeouts

Constructors

LimitsAndTimeouts

Fields

chainSyncLimits :: MiniProtocolLimits
chainSyncSizeLimits :: ProtocolSizeLimits (ChainSync header (Point block) (Tip block)) ByteString
chainSyncTimeLimits :: ProtocolTimeLimits (ChainSync header (Point block) (Tip block))
blockFetchLimits :: MiniProtocolLimits
blockFetchSizeLimits :: ProtocolSizeLimits (BlockFetch block (Point block)) ByteString
blockFetchTimeLimits :: ProtocolTimeLimits (BlockFetch block (Point block))
keepAliveLimits :: MiniProtocolLimits
keepAliveSizeLimits :: ProtocolSizeLimits KeepAlive ByteString
keepAliveTimeLimits :: ProtocolTimeLimits KeepAlive
pingPongLimits :: MiniProtocolLimits
pingPongSizeLimits :: ProtocolSizeLimits PingPong ByteString
pingPongTimeLimits :: ProtocolTimeLimits PingPong
handshakeLimits :: MiniProtocolLimits
handshakeTimeLimits :: ProtocolTimeLimits (Handshake NtNVersion NtNVersionData)
handhsakeSizeLimits :: ProtocolSizeLimits (Handshake NtNVersion NtNVersionData) ByteString
peerSharingLimits :: MiniProtocolLimits
peerSharingTimeLimits :: ProtocolTimeLimits (PeerSharing NtNAddr)
peerSharingSizeLimits :: ProtocolSizeLimits (PeerSharing NtNAddr) ByteString

data Interfaces m Source #

Constructors

Interfaces

Fields

iNtnSnocket :: Snocket m (NtNFD m) NtNAddr
iNtnBearer :: MakeBearer m (NtNFD m)
iAcceptVersion :: NtNVersionData -> NtNVersionData -> Accept NtNVersionData
iNtnDomainResolver :: DNSLookupType -> [DomainAccessPoint] -> m (Map DomainAccessPoint (Set NtNAddr))
iNtcSnocket :: Snocket m (NtCFD m) NtCAddr
iNtcBearer :: MakeBearer m (NtCFD m)
iRng :: StdGen
iDomainMap :: StrictTVar m (Map Domain [(IP, TTL)])
iLedgerPeersConsensusInterface :: LedgerPeersConsensusInterface m

data Arguments m Source #

Constructors

Arguments

Fields

aIPAddress :: NtNAddr
aAcceptedLimits :: AcceptedConnectionsLimit
aDiffusionMode :: DiffusionMode
aKeepAliveInterval :: DiffTime
aPingPongInterval :: DiffTime
aShouldChainSyncExit :: BlockHeader -> m Bool
aChainSyncEarlyExit :: Bool
aPeerSelectionTargets :: PeerSelectionTargets
aReadLocalRootPeers :: STM m [(HotValency, WarmValency, Map RelayAccessPoint PeerAdvertise)]
aReadPublicRootPeers :: STM m (Map RelayAccessPoint PeerAdvertise)
aOwnPeerSharing :: PeerSharing
aReadUseLedgerAfter :: STM m UseLedgerAfter
aProtocolIdleTimeout :: DiffTime
aTimeWaitTimeout :: DiffTime
aDNSTimeoutScript :: Script DNSTimeout
aDNSLookupDelayScript :: Script DNSLookupDelay
aDebugTracer :: Tracer m String

run :: forall resolver m. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadEvaluate m, MonadFix m, MonadFork m, MonadLabelledSTM m, MonadTraceSTM m, MonadMask m, MonadSay m, MonadST m, MonadTime m, MonadTimer m, MonadThrow m, MonadThrow (STM m), MonadMVar m, resolver ~ (), forall a. Semigroup a => Semigroup (m a), Eq (Async m Void)) => BlockGeneratorArgs Block StdGen -> LimitsAndTimeouts BlockHeader Block -> Interfaces m -> Arguments m -> TracersExtra NtNAddr NtNVersion NtNVersionData NtCAddr NtCVersion NtCVersionData ResolverException m -> Tracer m (TraceLabelPeer NtNAddr (TraceFetchClientState BlockHeader)) -> m Void Source #

node types

type NtNAddr = TestAddress NtNAddr_ Source #

type NtNFD m = FD m NtNAddr Source #

type NtCAddr = TestAddress Int Source #

type NtCFD m = FD m NtCAddr Source #

extra types used by the node

data AcceptedConnectionsLimit #

Constructors

AcceptedConnectionsLimit
Fields acceptedConnectionsHardLimit :: !Word32 acceptedConnectionsSoftLimit :: !Word32 acceptedConnectionsDelay :: !DiffTime

Instances

Instances details

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

data DiffusionMode #

Constructors

InitiatorOnlyDiffusionMode
InitiatorAndResponderDiffusionMode

Instances

Instances details

Show DiffusionMode
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods showsPrec :: Int -> DiffusionMode -> ShowS Source # show :: DiffusionMode -> String Source # showList :: [DiffusionMode] -> ShowS Source #
Eq DiffusionMode
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods (==) :: DiffusionMode -> DiffusionMode -> Bool Source # (/=) :: DiffusionMode -> DiffusionMode -> Bool Source #
Ord DiffusionMode
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods compare :: DiffusionMode -> DiffusionMode -> Ordering Source # (<) :: DiffusionMode -> DiffusionMode -> Bool Source # (<=) :: DiffusionMode -> DiffusionMode -> Bool Source # (>) :: DiffusionMode -> DiffusionMode -> Bool Source # (>=) :: DiffusionMode -> DiffusionMode -> Bool Source # max :: DiffusionMode -> DiffusionMode -> DiffusionMode Source # min :: DiffusionMode -> DiffusionMode -> DiffusionMode Source #

data PeerAdvertise #

Constructors

DoNotAdvertisePeer
DoAdvertisePeer

Instances

Instances details

Arbitrary PeerAdvertise
Instance details Defined in Test.Ouroboros.Network.PeerSelection.Instances Methods arbitrary :: Gen PeerAdvertise shrink :: PeerAdvertise -> [PeerAdvertise]
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 :: Type -> Type Source # Methods from :: PeerAdvertise -> Rep PeerAdvertise x Source # to :: Rep PeerAdvertise x -> PeerAdvertise Source #
Show PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods showsPrec :: Int -> PeerAdvertise -> ShowS Source # show :: PeerAdvertise -> String Source # showList :: [PeerAdvertise] -> ShowS Source #
Eq PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods (==) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (/=) :: PeerAdvertise -> PeerAdvertise -> Bool Source #
Ord PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods compare :: PeerAdvertise -> PeerAdvertise -> Ordering Source # (<) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (<=) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (>) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (>=) :: PeerAdvertise -> PeerAdvertise -> Bool Source # max :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise Source # min :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise Source #
type Rep PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise type Rep PeerAdvertise = D1 ('MetaData "PeerAdvertise" "Ouroboros.Network.PeerSelection.PeerAdvertise" "ouroboros-network-api-0.6.1.0-BdeO4WCgCxZ61qUyZLLBhX" 'False) (C1 ('MetaCons "DoNotAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type))

data PeerSelectionTargets #

Constructors

PeerSelectionTargets
Fields targetNumberOfRootPeers :: !Int targetNumberOfKnownPeers :: !Int targetNumberOfEstablishedPeers :: !Int targetNumberOfActivePeers :: !Int targetNumberOfKnownBigLedgerPeers :: !Int targetNumberOfEstablishedBigLedgerPeers :: !Int targetNumberOfActiveBigLedgerPeers :: !Int

Instances

Instances details

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

configuration constants

config_RECONNECT_DELAY :: ReconnectDelay Source #