Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions

Contents

DNS based actions for local and public root providers
DNSActions IO
Utils
Tracing types

Synopsis

data DNSActions peerAddr resolver (m :: Type -> Type) = DNSActions {
- dnsResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError resolver))
- dnsAsyncResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError resolver))
- dnsLookupWithTTL :: DNSPeersKind -> RelayAccessPoint -> ResolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr)
}
data PeerActionsDNS peeraddr resolver (m :: Type -> Type) = PeerActionsDNS {
- paToPeerAddr :: IP -> PortNumber -> peeraddr
- paDnsActions :: DNSActions peeraddr resolver m
}
type SRVPrefix = Domain
ioDNSActions :: Tracer IO DNSTrace -> DNSLookupType -> (IP -> PortNumber -> peerAddr) -> DNSActions peerAddr Resolver IO
data DNSLookupType
type DNSLookupResult peerAddr = Either [DNSError] [(peerAddr, TTL)]
newtype Resource (m :: Type -> Type) a = Resource {
- withResource :: m (a, Resource m a)
}
retryResource :: forall (m :: Type -> Type) e a. MonadDelay m => Tracer m e -> NonEmpty DiffTime -> Resource m (Either e a) -> Resource m a
constantResource :: forall (m :: Type -> Type) a. Applicative m => a -> Resource m a
dispatchLookupWithTTL :: MonadAsync m => DNSLookupType -> (resolver -> resolvConf -> Domain -> TYPE -> m (Maybe (Either DNSError DNSMessage))) -> Tracer m DNSTrace -> (IP -> PortNumber -> peerAddr) -> DNSPeersKind -> RelayAccessPoint -> resolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr)
data DNSorIOError
- = DNSError !DNSError
- | IOError !IOError
data DNSTrace
- = DNSLookupResult DNSPeersKind Domain (Maybe Domain) [(IP, PortNumber, TTL)]
- | DNSLookupError DNSPeersKind (Maybe DNSLookupType) Domain DNSError
- | SRVLookupResult DNSPeersKind Domain [(Domain, Word16, Word16, Word16, TTL)]
- | SRVLookupError DNSPeersKind Domain
data DNSPeersKind

DNS based actions for local and public root providers

data DNSActions peerAddr resolver (m :: Type -> Type) Source #

Dictionary of DNS actions vocabulary

Constructors

DNSActions

Fields

dnsResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError resolver))
TODO: it could be useful for publicRootPeersProvider.
dnsAsyncResolverResource :: ResolvConf -> m (Resource m (Either DNSorIOError 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 :: DNSPeersKind -> RelayAccessPoint -> ResolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr)
Like lookupA but also return the TTL for the results.
DNS library timeouts do not work reliably on Windows (#1873), hence the additional timeout.

data PeerActionsDNS peeraddr resolver (m :: Type -> Type) Source #

Record of some parameters that are commonly used together

TODO: rename as PeerDNSActions; can we bundle paToPeerAddr with DNSActions?

Constructors

PeerActionsDNS
Fields paToPeerAddr :: IP -> PortNumber -> peeraddr paDnsActions :: DNSActions peeraddr resolver m

type SRVPrefix = Domain #

Type of a DNS SRV prefix as defined by CIP#0155

DNSActions IO

ioDNSActions :: Tracer IO DNSTrace -> DNSLookupType -> (IP -> PortNumber -> peerAddr) -> DNSActions peerAddr Resolver IO Source #

IO DNSActions which resolve domain names with Resolver.

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.

It guarantees that returned TTLs are strictly greater than 0.

data DNSLookupType Source #

Constructors

LookupReqAOnly
LookupReqAAAAOnly
LookupReqAAndAAAA

Instances

Instances details

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

type DNSLookupResult peerAddr = Either [DNSError] [(peerAddr, TTL)] Source #

Wraps lookup result for client code

Utils

Resource

newtype Resource (m :: Type -> Type) a Source #

Evolving resource; We use it to reinitialise the DNS library if the `etcresolv.conf` file was modified.

Note: constantResource and retryResource are written using a simplified approach inspired by _"The Different Aspects of Monads and Mixins"_, by Bruno C. d S. Oliveira, see https://www.youtube.com/watch?v=pfwP4hXM5hA.

Constructors

Resource
Fields withResource :: m (a, Resource m a)

Instances

Instances details

Functor m => Functor (Resource m) Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods fmap :: (a -> b) -> Resource m a -> Resource m b # (<$) :: a -> Resource m b -> Resource m a #

retryResource :: forall (m :: Type -> Type) e a. MonadDelay m => Tracer m e -> NonEmpty DiffTime -> Resource m (Either e a) -> Resource m a Source #

A Resource which will exhibit the given Resource but retry it with a given delay until a success. On first success it will reset the delays.

constantResource :: forall (m :: Type -> Type) a. Applicative m => a -> Resource m a Source #

Exposed for testing purposes

dispatchLookupWithTTL :: MonadAsync m => DNSLookupType -> (resolver -> resolvConf -> Domain -> TYPE -> m (Maybe (Either DNSError DNSMessage))) -> Tracer m DNSTrace -> (IP -> PortNumber -> peerAddr) -> DNSPeersKind -> RelayAccessPoint -> resolvConf -> resolver -> StdGen -> m (DNSLookupResult peerAddr) Source #

Error type

data DNSorIOError Source #

Constructors

DNSError !DNSError
IOError !IOError

Instances

Instances details

Exception DNSorIOError Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods toException :: DNSorIOError -> SomeException # fromException :: SomeException -> Maybe DNSorIOError # displayException :: DNSorIOError -> String # backtraceDesired :: DNSorIOError -> Bool #
Show DNSorIOError Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions Methods showsPrec :: Int -> DNSorIOError -> ShowS # show :: DNSorIOError -> String # showList :: [DNSorIOError] -> ShowS #

Tracing types

data DNSTrace Source #

Provides DNS lookup trace information

Constructors

DNSLookupResult	DNS lookup result
Fields DNSPeersKind Domain source of addresses (Maybe Domain) SRV domain, if relevant [(IP, PortNumber, TTL)] payload
DNSLookupError DNSPeersKind (Maybe DNSLookupType) Domain DNSError	`DNS` lookup error
SRVLookupResult DNSPeersKind Domain [(Domain, Word16, Word16, Word16, TTL)]
SRVLookupError	`SRV` resolution errors, all dns errors are traced with `DNSLookupError`
Fields DNSPeersKind Domain SRV domain

Instances

Instances details

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

data DNSPeersKind Source #

Bundled with DNS lookup trace for observability

Constructors

DNSLocalPeer
DNSPublicPeer
DNSLedgerPeer LedgerPeersKind

Instances

Instances details

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