Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.PeerSelection.RootPeersDNS

Contents

DNS based actions for local and public root providers
DNS resolver IO auxiliar functions
- DNSActions IO
DNS based provider for local root peers
DNS based provider for public root peers
DNS type re-exports
Socket type re-exports

Synopsis

data DNSActions resolver exception m = DNSActions {
- dnsResolverResource :: ResolvConf -> m ( Resource m ( DNSorIOError exception) resolver)
- dnsAsyncResolverResource :: ResolvConf -> m ( Resource m ( DNSorIOError exception) resolver)
- dnsLookupWithTTL :: ResolvConf -> resolver -> Domain -> m ([ DNSError ], [( IP , TTL )])
}
constantResource :: Applicative m => a -> Resource m err a
ioDNSActions :: LookupReqs -> DNSActions Resolver IOException IO
data LookupReqs
- = LookupReqAOnly
- | LookupReqAAAAOnly
- | LookupReqAAndAAAA
localRootPeersProvider :: forall m peerAddr resolver exception. ( MonadAsync m, MonadDelay m, Eq ( Async m Void ), Ord peerAddr) => Tracer m ( TraceLocalRootPeers peerAddr exception) -> ( IP -> PortNumber -> peerAddr) -> ResolvConf -> DNSActions resolver exception m -> STM m [( Int , Map RelayAccessPoint PeerAdvertise )] -> StrictTVar m ( Seq ( Int , Map peerAddr PeerAdvertise )) -> m Void
data DomainAccessPoint = DomainAccessPoint {
- dapDomain :: ! Domain
- dapPortNumber :: ! PortNumber
}
data RelayAccessPoint where
- RelayAccessDomain ! Domain ! PortNumber
- RelayAccessAddress ! IP ! PortNumber
- pattern RelayDomainAccessPoint :: DomainAccessPoint -> RelayAccessPoint
data IP
- = IPv4 {
  - ipv4 :: IPv4
  }
- | IPv6 {
  - ipv6 :: IPv6
  }
data TraceLocalRootPeers peerAddr exception
- = TraceLocalRootDomains [( Int , Map RelayAccessPoint PeerAdvertise )]
- | TraceLocalRootWaiting DomainAccessPoint DiffTime
- | TraceLocalRootResult DomainAccessPoint [( IP , TTL )]
- | TraceLocalRootGroups ( Seq ( Int , Map peerAddr PeerAdvertise ))
- | TraceLocalRootFailure DomainAccessPoint ( DNSorIOError exception)
- | TraceLocalRootError DomainAccessPoint SomeException
publicRootPeersProvider :: forall peerAddr resolver exception a m. ( MonadThrow m, MonadAsync m, Exception exception, Ord peerAddr) => Tracer m TracePublicRootPeers -> ( IP -> PortNumber -> peerAddr) -> ResolvConf -> STM m [ RelayAccessPoint ] -> DNSActions resolver exception m -> (( Int -> m ( Set peerAddr, DiffTime )) -> m a) -> m a
data TracePublicRootPeers
- = TracePublicRootRelayAccessPoint [ RelayAccessPoint ]
- | TracePublicRootDomains [ DomainAccessPoint ]
- | TracePublicRootResult Domain [( IP , TTL )]
- | TracePublicRootFailure Domain DNSError
resolveDomainAccessPoint :: forall exception resolver m. ( MonadThrow m, MonadAsync m, Exception exception) => Tracer m TracePublicRootPeers -> ResolvConf -> DNSActions resolver exception m -> [ DomainAccessPoint ] -> m ( Map DomainAccessPoint ( Set SockAddr ))
data ResolvConf
type Domain = ByteString
type TTL = Word32
data PortNumber

DNS based actions for local and public root providers

data DNSActions resolver exception m Source #

Dictionary of DNS actions vocabulary

Constructors

DNSActions

Fields

dnsResolverResource :: ResolvConf -> m ( Resource m ( DNSorIOError exception) resolver)

TODO: it could be useful for publicRootPeersProvider .
dnsAsyncResolverResource :: ResolvConf -> m ( Resource m ( DNSorIOError exception) 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 :: ResolvConf -> resolver -> Domain -> m ([ DNSError ], [( IP , TTL )])

Like lookupA but also return the TTL for the results.

DNS library timeouts do not work reliably on Windows (#1873), hence the additional timeout.

DNS resolver IO auxiliar functions

constantResource :: Applicative m => a -> Resource m err a Source #

DNSActions IO

ioDNSActions :: LookupReqs -> DNSActions Resolver IOException IO Source #

Bundle of DNS Actions that runs in IO 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.

data LookupReqs Source #

Constructors

LookupReqAOnly
LookupReqAAAAOnly
LookupReqAAndAAAA

Instances

Instances details

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

DNS based provider for local root peers

localRootPeersProvider Source #

Arguments

:: forall m peerAddr resolver exception. ( MonadAsync m, MonadDelay m, Eq ( Async m Void ), Ord peerAddr)
=> Tracer m ( TraceLocalRootPeers peerAddr exception)
-> ( IP -> PortNumber -> peerAddr)
-> ResolvConf
-> DNSActions resolver exception m
-> STM m [( Int , Map RelayAccessPoint PeerAdvertise )]	input
-> StrictTVar m ( Seq ( Int , Map peerAddr PeerAdvertise ))	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 DomainAccessPoint Source #

A product of a Domain and PortNumber . After resolving the domain we will use the PortNumber to form SockAddr .

Constructors

DomainAccessPoint
Fields dapDomain :: ! Domain dapPortNumber :: ! PortNumber

Instances

Instances details

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

data RelayAccessPoint Source #

A relay can have either an IP address and a port number or a domain with a port number

Constructors

RelayAccessDomain ! Domain ! PortNumber
RelayAccessAddress ! IP ! PortNumber

Bundled Patterns

pattern RelayDomainAccessPoint :: DomainAccessPoint -> RelayAccessPoint

RelayDomainAccessPoint a bidirectional pattern which links RelayAccessDomain and DomainAccessPoint .

Instances

Instances details

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

data IP Source #

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

Enum IP
Instance details Defined in Data.IP.Addr Methods succ :: IP -> IP Source # pred :: IP -> IP Source # toEnum :: Int -> IP Source # fromEnum :: IP -> Int Source # enumFrom :: IP -> [ IP ] Source # enumFromThen :: IP -> IP -> [ IP ] Source # enumFromTo :: IP -> IP -> [ IP ] Source # enumFromThenTo :: IP -> IP -> IP -> [ IP ] Source #
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 Source # (/=) :: IP -> IP -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c IP Source # toConstr :: IP -> Constr Source # dataTypeOf :: IP -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c IP ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c IP ) Source # gmapT :: ( forall b. Data b => b -> b) -> IP -> IP Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> IP -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> IP -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> IP -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> IP -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> IP -> m IP Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> IP -> m IP Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> IP -> m IP Source #
Ord IP
Instance details Defined in Data.IP.Addr Methods compare :: IP -> IP -> Ordering Source # (<) :: IP -> IP -> Bool Source # (<=) :: IP -> IP -> Bool Source # (>) :: IP -> IP -> Bool Source # (>=) :: IP -> IP -> Bool Source # max :: IP -> IP -> IP Source # min :: IP -> IP -> IP Source #
Read IP
Instance details Defined in Data.IP.Addr Methods readsPrec :: Int -> ReadS IP Source # readList :: ReadS [ IP ] Source # readPrec :: ReadPrec IP Source # readListPrec :: ReadPrec [ IP ] Source #
Show IP
Instance details Defined in Data.IP.Addr Methods showsPrec :: Int -> IP -> ShowS Source # show :: IP -> String Source # showList :: [ IP ] -> ShowS Source #
IsString IP
Instance details Defined in Data.IP.Addr Methods fromString :: String -> IP Source #
Generic IP
Instance details Defined in Data.IP.Addr Associated Types type Rep IP :: Type -> Type Source # Methods from :: IP -> Rep IP x Source # to :: Rep IP x -> IP Source #
type Rep IP
Instance details Defined in Data.IP.Addr type Rep IP = D1 (' MetaData "IP" "Data.IP.Addr" "iproute-1.7.12-7531Frr8UW3EGpk43IP3fV" ' 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 TraceLocalRootPeers peerAddr exception Source #

Constructors

TraceLocalRootDomains [( Int , Map RelayAccessPoint PeerAdvertise )]	`Int` is the configured valency for the local producer groups
TraceLocalRootWaiting DomainAccessPoint DiffTime
TraceLocalRootResult DomainAccessPoint [( IP , TTL )]
TraceLocalRootGroups ( Seq ( Int , Map peerAddr PeerAdvertise ))	This traces the results of the local root peer provider
TraceLocalRootFailure DomainAccessPoint ( DNSorIOError exception)
TraceLocalRootError DomainAccessPoint SomeException

Instances

Instances details

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

DNS based provider for public root peers

publicRootPeersProvider :: forall peerAddr resolver exception a m. ( MonadThrow m, MonadAsync m, Exception exception, Ord peerAddr) => Tracer m TracePublicRootPeers -> ( IP -> PortNumber -> peerAddr) -> ResolvConf -> STM m [ RelayAccessPoint ] -> DNSActions resolver exception m -> (( Int -> m ( Set peerAddr, DiffTime )) -> m a) -> m a Source #

TODO track PeerAdvertise

data TracePublicRootPeers Source #

Constructors

TracePublicRootRelayAccessPoint [ RelayAccessPoint ]
TracePublicRootDomains [ DomainAccessPoint ]
TracePublicRootResult Domain [( IP , TTL )]
TracePublicRootFailure Domain DNSError

Instances

Instances details

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

resolveDomainAccessPoint :: forall exception resolver m. ( MonadThrow m, MonadAsync m, Exception exception) => Tracer m TracePublicRootPeers -> ResolvConf -> DNSActions resolver exception m -> [ DomainAccessPoint ] -> m ( Map DomainAccessPoint ( Set SockAddr )) Source #

Provides DNS resolution functionality.

DNS type re-exports

data ResolvConf Source #

Type for resolver configuration. Use defaultResolvConf to create a new value.

An example to use Google's public DNS cache instead of resolv.conf:

>>> let conf = defaultResolvConf { resolvInfo = RCHostName "8.8.8.8" }

An example to use multiple Google's public DNS cache concurrently:

>>> let conf = defaultResolvConf { resolvInfo = RCHostNames ["8.8.8.8","8.8.4.4"], resolvConcurrent = True }

An example to disable EDNS0:

>>> let conf = defaultResolvConf { resolvEDNS = [] }

An example to enable EDNS0 with a 1,280-bytes buffer:

>>> let conf = defaultResolvConf { resolvEDNS = [fromEDNS0 defaultEDNS0 { udpSize = 1280 }] }

An example to enable cache:

>>> let conf = defaultResolvConf { resolvCache = Just defaultCacheConf }

Instances

Instances details

Show ResolvConf
Instance details Defined in Network.DNS.Types.Internal Methods showsPrec :: Int -> ResolvConf -> ShowS Source # show :: ResolvConf -> String Source # showList :: [ ResolvConf ] -> ShowS Source #

type Domain = ByteString Source #

Type for domain.

type TTL = Word32 Source #

Time to live in second.

Socket type re-exports

data PortNumber Source #

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