Safe Haskell	None
Language	Haskell2010

Cardano.Node.Configuration.Topology

Synopsis

newtype TopologyError = NodeIdNotFoundInToplogyFile FilePath
data NetworkTopology
- = MockNodeTopology ![NodeSetup]
- | RealNodeTopology ![RemoteAddress]
newtype NodeHostIPAddress = NodeHostIPAddress {
- unNodeHostIPAddress :: IP
}
newtype NodeHostIPv4Address = NodeHostIPv4Address {
- unNodeHostIPv4Address :: IPv4
}
newtype NodeHostIPv6Address = NodeHostIPv6Address {
- unNodeHostIPv6Address :: IPv6
}
data NodeSetup = NodeSetup {
- nodeId :: !Word64
- nodeIPv4Address :: !(Maybe NodeIPv4Address)
- nodeIPv6Address :: !(Maybe NodeIPv6Address)
- producers :: ![RemoteAddress]
}
data RemoteAddress = RemoteAddress {
- raAddress :: !Text
- raPort :: !PortNumber
- raValency :: !Int
}
nodeAddressToSockAddr :: NodeIPAddress -> SockAddr
readTopologyFile :: NodeConfiguration -> IO (Either Text NetworkTopology)
remoteAddressToNodeAddress :: RemoteAddress -> Maybe (Either NodeIPAddress (NodeDnsAddress, Int))

Documentation

newtype TopologyError Source #

Constructors

NodeIdNotFoundInToplogyFile FilePath

Instances

Instances details

Show TopologyError Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods showsPrec :: Int -> TopologyError -> ShowS # show :: TopologyError -> String # showList :: [TopologyError] -> ShowS #

data NetworkTopology Source #

Constructors

MockNodeTopology ![NodeSetup]
RealNodeTopology ![RemoteAddress]

Instances

Instances details

Eq NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods (==) :: NetworkTopology -> NetworkTopology -> Bool # (/=) :: NetworkTopology -> NetworkTopology -> Bool #
Show NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods showsPrec :: Int -> NetworkTopology -> ShowS # show :: NetworkTopology -> String # showList :: [NetworkTopology] -> ShowS #
ToJSON NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods toJSON :: NetworkTopology -> Value Source # toEncoding :: NetworkTopology -> Encoding Source # toJSONList :: [NetworkTopology] -> Value Source # toEncodingList :: [NetworkTopology] -> Encoding Source #
FromJSON NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods parseJSON :: Value -> Parser NetworkTopology Source # parseJSONList :: Value -> Parser [NetworkTopology] Source #

newtype NodeHostIPAddress Source #

Constructors

NodeHostIPAddress
Fields unNodeHostIPAddress :: IP

Instances

Instances details

Eq NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Types Methods (==) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool # (/=) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool #
Ord NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Types Methods compare :: NodeHostIPAddress -> NodeHostIPAddress -> Ordering # (<) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool # (<=) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool # (>) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool # (>=) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool # max :: NodeHostIPAddress -> NodeHostIPAddress -> NodeHostIPAddress # min :: NodeHostIPAddress -> NodeHostIPAddress -> NodeHostIPAddress #
Show NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeHostIPAddress -> ShowS # show :: NodeHostIPAddress -> String # showList :: [NodeHostIPAddress] -> ShowS #
ToJSON NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: NodeHostIPAddress -> Value Source # toEncoding :: NodeHostIPAddress -> Encoding Source # toJSONList :: [NodeHostIPAddress] -> Value Source # toEncodingList :: [NodeHostIPAddress] -> Encoding Source #
FromJSON NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser NodeHostIPAddress Source # parseJSONList :: Value -> Parser [NodeHostIPAddress] Source #

newtype NodeHostIPv4Address Source #

Constructors

NodeHostIPv4Address
Fields unNodeHostIPv4Address :: IPv4

Instances

Instances details

Eq NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Types Methods (==) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool # (/=) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool #
Ord NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Types Methods compare :: NodeHostIPv4Address -> NodeHostIPv4Address -> Ordering # (<) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool # (<=) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool # (>) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool # (>=) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool # max :: NodeHostIPv4Address -> NodeHostIPv4Address -> NodeHostIPv4Address # min :: NodeHostIPv4Address -> NodeHostIPv4Address -> NodeHostIPv4Address #
Show NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeHostIPv4Address -> ShowS # show :: NodeHostIPv4Address -> String # showList :: [NodeHostIPv4Address] -> ShowS #
ToJSON NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: NodeHostIPv4Address -> Value Source # toEncoding :: NodeHostIPv4Address -> Encoding Source # toJSONList :: [NodeHostIPv4Address] -> Value Source # toEncodingList :: [NodeHostIPv4Address] -> Encoding Source #
FromJSON NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser NodeHostIPv4Address Source # parseJSONList :: Value -> Parser [NodeHostIPv4Address] Source #

newtype NodeHostIPv6Address Source #

Constructors

NodeHostIPv6Address
Fields unNodeHostIPv6Address :: IPv6

Instances

Instances details

Eq NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Types Methods (==) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool # (/=) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool #
Ord NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Types Methods compare :: NodeHostIPv6Address -> NodeHostIPv6Address -> Ordering # (<) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool # (<=) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool # (>) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool # (>=) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool # max :: NodeHostIPv6Address -> NodeHostIPv6Address -> NodeHostIPv6Address # min :: NodeHostIPv6Address -> NodeHostIPv6Address -> NodeHostIPv6Address #
Show NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeHostIPv6Address -> ShowS # show :: NodeHostIPv6Address -> String # showList :: [NodeHostIPv6Address] -> ShowS #
ToJSON NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: NodeHostIPv6Address -> Value Source # toEncoding :: NodeHostIPv6Address -> Encoding Source # toJSONList :: [NodeHostIPv6Address] -> Value Source # toEncodingList :: [NodeHostIPv6Address] -> Encoding Source #
FromJSON NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser NodeHostIPv6Address Source # parseJSONList :: Value -> Parser [NodeHostIPv6Address] Source #

data NodeSetup Source #

Constructors

NodeSetup
Fields nodeId :: !Word64 nodeIPv4Address :: !(Maybe NodeIPv4Address) nodeIPv6Address :: !(Maybe NodeIPv6Address) producers :: ![RemoteAddress]

Instances

Instances details

Eq NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods (==) :: NodeSetup -> NodeSetup -> Bool # (/=) :: NodeSetup -> NodeSetup -> Bool #
Show NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods showsPrec :: Int -> NodeSetup -> ShowS # show :: NodeSetup -> String # showList :: [NodeSetup] -> ShowS #
ToJSON NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods toJSON :: NodeSetup -> Value Source # toEncoding :: NodeSetup -> Encoding Source # toJSONList :: [NodeSetup] -> Value Source # toEncodingList :: [NodeSetup] -> Encoding Source #
FromJSON NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods parseJSON :: Value -> Parser NodeSetup Source # parseJSONList :: Value -> Parser [NodeSetup] Source #

data RemoteAddress Source #

Domain name with port number

Constructors

RemoteAddress
Fields raAddress :: !Text Either a dns address or an ip address. raPort :: !PortNumber Port number of the destination. raValency :: !Int If a DNS address is given valency governs to how many resolved IP addresses should we maintain active (hot) connection; if an IP address is given valency is used as a Boolean value, `0` means to ignore the address;

Instances

Instances details

Eq RemoteAddress Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods (==) :: RemoteAddress -> RemoteAddress -> Bool # (/=) :: RemoteAddress -> RemoteAddress -> Bool #
Ord RemoteAddress Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods compare :: RemoteAddress -> RemoteAddress -> Ordering # (<) :: RemoteAddress -> RemoteAddress -> Bool # (<=) :: RemoteAddress -> RemoteAddress -> Bool # (>) :: RemoteAddress -> RemoteAddress -> Bool # (>=) :: RemoteAddress -> RemoteAddress -> Bool # max :: RemoteAddress -> RemoteAddress -> RemoteAddress # min :: RemoteAddress -> RemoteAddress -> RemoteAddress #
Show RemoteAddress Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods showsPrec :: Int -> RemoteAddress -> ShowS # show :: RemoteAddress -> String # showList :: [RemoteAddress] -> ShowS #
ToJSON RemoteAddress Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods toJSON :: RemoteAddress -> Value Source # toEncoding :: RemoteAddress -> Encoding Source # toJSONList :: [RemoteAddress] -> Value Source # toEncodingList :: [RemoteAddress] -> Encoding Source #
FromJSON RemoteAddress Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods parseJSON :: Value -> Parser RemoteAddress Source # parseJSONList :: Value -> Parser [RemoteAddress] Source #
Condense RemoteAddress Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods condense :: RemoteAddress -> String Source #

nodeAddressToSockAddr :: NodeIPAddress -> SockAddr Source #

readTopologyFile :: NodeConfiguration -> IO (Either Text NetworkTopology) Source #

Read the NetworkTopology configuration from the specified file. While running a real protocol, this gives your node its own address and other remote peers it will attempt to connect to.

remoteAddressToNodeAddress :: RemoteAddress -> Maybe (Either NodeIPAddress (NodeDnsAddress, Int)) Source #

Parse raAddress field as an IP address; if it parses and the valency is non zero return corresponding NodeAddress.