Safe Haskell	Safe-Inferred
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)
readTopologyFileOrError :: NodeConfiguration -> IO 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 Source # show :: TopologyError -> String Source # showList :: [TopologyError] -> ShowS Source #

data NetworkTopology Source #

Constructors

MockNodeTopology ![NodeSetup]
RealNodeTopology ![RemoteAddress]

Instances

Instances details

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

newtype NodeHostIPAddress Source #

Constructors

NodeHostIPAddress
Fields unNodeHostIPAddress :: IP

Instances

Instances details

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

newtype NodeHostIPv4Address Source #

Constructors

NodeHostIPv4Address
Fields unNodeHostIPv4Address :: IPv4

Instances

Instances details

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

newtype NodeHostIPv6Address Source #

Constructors

NodeHostIPv6Address
Fields unNodeHostIPv6Address :: IPv6

Instances

Instances details

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

data NodeSetup Source #

Constructors

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

Instances

Instances details

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

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

readTopologyFileOrError :: NodeConfiguration -> IO NetworkTopology Source #

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.