Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Diffusion.Topology

Synopsis

data NetworkTopology extraConfig extraFlags = NetworkTopology {
- localRootPeersGroups :: !(LocalRootPeersGroups extraFlags)
- publicRootPeers :: ![PublicRootPeers]
- useLedgerPeers :: !UseLedgerPeers
- peerSnapshotPath :: !(Maybe FilePath)
- extraConfig :: !extraConfig
}
newtype LocalRootPeersGroups extraFlags = LocalRootPeersGroups {
- groups :: [LocalRootPeersGroup extraFlags]
}
data LocalRootPeersGroup extraFlags = LocalRootPeersGroup {
- localRoots :: RootConfig
- hotValency :: HotValency
- warmValency :: WarmValency
- rootDiffusionMode :: DiffusionMode
- extraFlags :: extraFlags
}
newtype PublicRootPeers = PublicRootPeers {
- publicRoots :: RootConfig
}
data RootConfig = RootConfig {
- rootAccessPoints :: [RelayAccessPoint]
- rootAdvertise :: PeerAdvertise
}
rootConfigToRelayAccessPoint :: RootConfig -> [(RelayAccessPoint, PeerAdvertise)]
producerAddresses :: NetworkTopology extraConfig extraFlags -> ([(HotValency, WarmValency, Map RelayAccessPoint (LocalRootConfig extraFlags))], Map RelayAccessPoint PeerAdvertise)

Documentation

data NetworkTopology extraConfig extraFlags Source #

Constructors

NetworkTopology
Fields localRootPeersGroups :: !(LocalRootPeersGroups extraFlags) publicRootPeers :: ![PublicRootPeers] useLedgerPeers :: !UseLedgerPeers peerSnapshotPath :: !(Maybe FilePath) extraConfig :: !extraConfig

Instances

Instances details

(Show extraFlags, Show extraConfig) => Show (NetworkTopology extraConfig extraFlags) Source #
Instance details Defined in Ouroboros.Network.Diffusion.Topology Methods showsPrec :: Int -> NetworkTopology extraConfig extraFlags -> ShowS # show :: NetworkTopology extraConfig extraFlags -> String # showList :: [NetworkTopology extraConfig extraFlags] -> ShowS #
(Eq extraFlags, Eq extraConfig) => Eq (NetworkTopology extraConfig extraFlags) Source #
Instance details Defined in Ouroboros.Network.Diffusion.Topology Methods (==) :: NetworkTopology extraConfig extraFlags -> NetworkTopology extraConfig extraFlags -> Bool # (/=) :: NetworkTopology extraConfig extraFlags -> NetworkTopology extraConfig extraFlags -> Bool #

newtype LocalRootPeersGroups extraFlags Source #

Constructors

LocalRootPeersGroups
Fields groups :: [LocalRootPeersGroup extraFlags]

Instances

Instances details

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

data LocalRootPeersGroup extraFlags Source #

A local root peers group. Local roots are treated by the outbound governor in a special way. The node will make sure that a node has the requested number (valency/hotValency) of connections to the local root peer group. warmValency value is the value of warm/established connections that the node will attempt to maintain. By default this value will be equal to hotValency.

Constructors

LocalRootPeersGroup
Fields localRoots :: RootConfig hotValency :: HotValency warmValency :: WarmValency rootDiffusionMode :: DiffusionMode diffusion mode; used for local root peers. extraFlags :: extraFlags

Instances

Instances details

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

newtype PublicRootPeers Source #

Constructors

PublicRootPeers
Fields publicRoots :: RootConfig

Instances

Instances details

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

data RootConfig Source #

Each root peer consists of a list of access points and a shared PeerAdvertise field.

Constructors

RootConfig
Fields rootAccessPoints :: [RelayAccessPoint] a list of relay access points, each of which is either an ip address or domain name and a port number. rootAdvertise :: PeerAdvertise `advertise` configures whether the root should be advertised through peer sharing.

Instances

Instances details

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

rootConfigToRelayAccessPoint :: RootConfig -> [(RelayAccessPoint, PeerAdvertise)] Source #

Transforms a RootConfig into a pair of RelayAccessPoint and its corresponding PeerAdvertise value.

producerAddresses Source #

Arguments

:: NetworkTopology extraConfig extraFlags
-> ([(HotValency, WarmValency, Map RelayAccessPoint (LocalRootConfig extraFlags))], Map RelayAccessPoint PeerAdvertise)	local roots & public roots