Netty 5.0.0.Alpha5 · io.netty5.resolver.dns.DnsNameResolver

Modifier and Type	Class and Description
private static class	DnsNameResolver.AddressedEnvelopeAdapter
private class	DnsNameResolver.DnsResponseHandler

Modifier and Type	Field and Description
private final AuthoritativeDnsServerCache	authoritativeDnsServerCache
pack-priv final Channel	ch
pack-priv final Promise<Channel>	channelReadyPromise
private final DnsCnameCache	cnameCache
private final boolean	completeOncePreferredResolved
private static final DatagramDnsResponseDecoder	DATAGRAM_DECODER
private static final DatagramDnsQueryEncoder	DATAGRAM_ENCODER
private final boolean	decodeIdn
private static final UnixResolverOptions	DEFAULT_OPTIONS
pack-priv static final ResolvedAddressTypes	DEFAULT_RESOLVE_ADDRESS_TYPES
pack-priv static final String[]	DEFAULT_SEARCH_DOMAINS
private final DnsQueryLifecycleObserverFactory	dnsQueryLifecycleObserverFactory
private final DnsServerAddressStreamProvider	dnsServerAddressStreamProvider
private static final DnsRecord[]	EMPTY_ADDITIONALS
private final HostsFileEntriesResolver	hostsFileEntriesResolver
private static final ProtocolFamily[]	IPV4_ONLY_RESOLVED_PROTOCOL_FAMILIES
private static final DnsRecordType[]	IPV4_ONLY_RESOLVED_RECORD_TYPES
private static final ProtocolFamily[]	IPV4_PREFERRED_RESOLVED_PROTOCOL_FAMILIES
private static final DnsRecordType[]	IPV4_PREFERRED_RESOLVED_RECORD_TYPES
private static final ProtocolFamily[]	IPV6_ONLY_RESOLVED_PROTOCOL_FAMILIES
private static final DnsRecordType[]	IPV6_ONLY_RESOLVED_RECORD_TYPES
private static final ProtocolFamily[]	IPV6_PREFERRED_RESOLVED_PROTOCOL_FAMILIES
private static final DnsRecordType[]	IPV6_PREFERRED_RESOLVED_RECORD_TYPES
private static final String	LOCALHOST
private static final InetAddress	LOCALHOST_ADDRESS
private static final InternalLogger	logger
private final int	maxPayloadSize
private final int	maxQueriesPerResolve
private final FastThreadLocal<DnsServerAddressStream>	nameServerAddrStream
private final Comparator<InetSocketAddress>	nameServerComparator
private final int	ndots
private final boolean	optResourceEnabled
private final ProtocolFamily	preferredAddressType
pack-priv final DnsQueryContextManager	queryContextManager Manages the `DnsQueryContext`s in progress and their query IDs.
private final long	queryTimeoutMillis
private final boolean	recursionDesired
private final DnsCache	resolveCache Cache for `doResolve(String, Promise)` and `doResolveAll(String, Promise)`.
private final ResolvedAddressTypes	resolvedAddressTypes
private final ProtocolFamily[]	resolvedProtocolFamilies
private final DnsRecordType[]	resolveRecordTypes
private final String[]	searchDomains
private final ChannelFactory<? extends SocketChannel>	socketChannelFactory
private final boolean	supportsAAAARecords
private final boolean	supportsARecords
private static final TcpDnsQueryEncoder	TCP_ENCODER
private static final String	WINDOWS_HOST_NAME

Constructor Summary

Access	Constructor and Description
public	DnsNameResolver(EventLoop the `EventLoop` which will perform the communication with the DNS servers eventLoop, ChannelFactory<? extends DatagramChannel> the `ChannelFactory` that will create a `DatagramChannel` channelFactory, final DnsCache the DNS resolved entries cache resolveCache, final DnsCache the cache used to find the authoritative DNS server for a domain authoritativeDnsServerCache, DnsQueryLifecycleObserverFactory used to generate new instances of `DnsQueryLifecycleObserver` which can be used to track metrics for DNS servers. dnsQueryLifecycleObserverFactory, long timeout of each DNS query in millis queryTimeoutMillis, ResolvedAddressTypes the preferred address types resolvedAddressTypes, boolean if recursion desired flag must be set recursionDesired, int the maximum allowed number of DNS queries for a given name resolution maxQueriesPerResolve, int the capacity of the datagram packet buffer maxPayloadSize, boolean if automatic inclusion of a optional records is enabled optResourceEnabled, HostsFileEntriesResolver the `HostsFileEntriesResolver` used to check for local aliases hostsFileEntriesResolver, DnsServerAddressStreamProvider The `DnsServerAddressStreamProvider` used to determine the name servers for each hostname lookup. dnsServerAddressStreamProvider, String[] the list of search domain (can be null, if so, will try to default to the underlying platform ones) searchDomains, int the ndots value ndots, boolean `true` if domain / host names should be decoded to unicode when received. See rfc3492. decodeIdn) Deprecated Use `DnsNameResolverBuilder`. Creates a new DNS-based name resolver that communicates with the specified list of DNS servers.
public	DnsNameResolver(EventLoop the `EventLoop` which will perform the communication with the DNS servers eventLoop, ChannelFactory<? extends DatagramChannel> the `ChannelFactory` that will create a `DatagramChannel` channelFactory, final DnsCache the DNS resolved entries cache resolveCache, final AuthoritativeDnsServerCache the cache used to find the authoritative DNS server for a domain authoritativeDnsServerCache, DnsQueryLifecycleObserverFactory used to generate new instances of `DnsQueryLifecycleObserver` which can be used to track metrics for DNS servers. dnsQueryLifecycleObserverFactory, long timeout of each DNS query in millis queryTimeoutMillis, ResolvedAddressTypes the preferred address types resolvedAddressTypes, boolean if recursion desired flag must be set recursionDesired, int the maximum allowed number of DNS queries for a given name resolution maxQueriesPerResolve, int the capacity of the datagram packet buffer maxPayloadSize, boolean if automatic inclusion of a optional records is enabled optResourceEnabled, HostsFileEntriesResolver the `HostsFileEntriesResolver` used to check for local aliases hostsFileEntriesResolver, DnsServerAddressStreamProvider The `DnsServerAddressStreamProvider` used to determine the name servers for each hostname lookup. dnsServerAddressStreamProvider, String[] the list of search domain (can be null, if so, will try to default to the underlying platform ones) searchDomains, int the ndots value ndots, boolean `true` if domain / host names should be decoded to unicode when received. See rfc3492. decodeIdn) Deprecated Use `DnsNameResolverBuilder`. Creates a new DNS-based name resolver that communicates with the specified list of DNS servers.
pack-priv	DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, ChannelFactory<? extends SocketChannel> socketChannelFactory, final DnsCache resolveCache, final DnsCnameCache cnameCache, final AuthoritativeDnsServerCache authoritativeDnsServerCache, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, String[] searchDomains, int ndots, boolean decodeIdn, boolean completeOncePreferredResolved)
pack-priv	DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, ChannelFactory<? extends SocketChannel> socketChannelFactory, final DnsCache resolveCache, final DnsCnameCache cnameCache, final AuthoritativeDnsServerCache authoritativeDnsServerCache, SocketAddress localAddress, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, String[] searchDomains, int ndots, boolean decodeIdn, boolean completeOncePreferredResolved)

Method Summary

Modifier and Type	Method and Description
private static boolean	anyInterfaceSupportsIpV6() Returns `true` if any `NetworkInterface` supports `IPv6`, `false` otherwise.
public AuthoritativeDnsServerCache	authoritativeDnsServerCache() Returns the cache used for authoritative DNS servers for a domain.
private static Promise<AddressedEnvelope<DnsResponse, InetSocketAddress>>	cast(Promise<?> promise)
public void	close() Overrides io.netty5.resolver.SimpleNameResolver.close. Implements io.netty5.resolver.NameResolver.close. Closes the internal datagram channel used for sending and receiving DNS messages, and clears all DNS resource records from the cache.
public DnsCnameCache	cnameCache() Returns the `DnsCnameCache`.
pack-priv final DnsQueryLifecycleObserverFactory	dnsQueryLifecycleObserverFactory()
protected void	doResolve(String inetHost, Promise<InetAddress> promise) Implements abstract io.netty5.resolver.SimpleNameResolver.doResolve. Invoked by `resolve(String)` to perform the actual name resolution.
protected void	doResolve(String inetHost, DnsRecord[] additionals, Promise<InetAddress> promise, DnsCache resolveCache) Hook designed for extensibility so one can pass a different cache on each resolution attempt instead of using the global one.
protected void	doResolveAll(String inetHost, Promise<List<InetAddress>> promise) Implements abstract io.netty5.resolver.SimpleNameResolver.doResolveAll. Invoked by `resolveAll(String)` to perform the actual name resolution.
protected void	doResolveAll(String inetHost, DnsRecord[] additionals, Promise<List<InetAddress>> promise, DnsCache resolveCache) Hook designed for extensibility so one can pass a different cache on each resolution attempt instead of using the global one.
pack-priv static boolean	doResolveAllCached(String hostname, DnsRecord[] additionals, Promise<List<InetAddress>> promise, DnsCache resolveCache, ProtocolFamily[] resolvedInternetProtocolFamilies)
private void	doResolveAllUncached(final String hostname, final DnsRecord[] additionals, final Promise<?> originalPromise, final Promise<List<InetAddress>> promise, final DnsCache resolveCache, final boolean completeEarlyIfPossible)
private void	doResolveAllUncached0(String hostname, DnsRecord[] additionals, Promise<?> originalPromise, Promise<List<InetAddress>> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
private boolean	doResolveCached(String hostname, DnsRecord[] additionals, Promise<InetAddress> promise, DnsCache resolveCache)
private void	doResolveUncached(String hostname, DnsRecord[] additionals, final Promise<InetAddress> promise, DnsCache resolveCache)
protected EventLoop	executor() Overrides io.netty5.resolver.SimpleNameResolver.executor. Returns the `EventExecutor` which is used to notify the listeners of the `Future` returned by `resolve(String)`.
pack-priv final void	flushQueries()
private static String	hostname(String inetHost)
public HostsFileEntriesResolver	hostsFileEntriesResolver() Returns the component that tries to resolve hostnames against the hosts file prior to asking to remotes DNS servers.
pack-priv final boolean	isDecodeIdn()
private static boolean	isLocalWindowsHost(String hostname) Checks whether the given hostname is the localhost/host (computer) name on Windows OS.
public boolean	isOptResourceEnabled() Returns the automatic inclusion of a optional records that tries to give the remote DNS server a hint about how much data the resolver can read per response is enabled.
public boolean	isRecursionDesired() Returns `true` if and only if this resolver sends a DNS query with the RD (recursion desired) flag set.
public static boolean	isTimeoutError(Throwable cause) Returns `true` if the `Throwable` was caused by an timeout.
public static boolean	isTransportOrTimeoutError(Throwable cause) Returns `true` if the `Throwable` was caused by an timeout or transport error.
private InetAddress	loopbackAddress()
public int	maxPayloadSize() Returns the capacity of the datagram packet buffer (in bytes).
public int	maxQueriesPerResolve() Returns the maximum allowed number of DNS queries to send when resolving a host name.
pack-priv final int	ndots()
pack-priv final DnsServerAddressStream	newNameServerAddressStream(String hostname)
protected DnsServerAddressStream	Returns: A `DnsServerAddressStream` which will be used to follow the DNS redirect or `null` if none should be followed. newRedirectDnsServerStream(String the hostname. hostname, List<InetSocketAddress> The addresses of the DNS servers which are used in the event of a redirect. This may contain resolved and unresolved addresses so the used `DnsServerAddressStream` must allow unresolved addresses if you want to include these as well. nameservers) Creates a new `DnsServerAddressStream` to following a redirected DNS query.
pack-priv InetSocketAddress	newRedirectServerAddress(InetAddress server)
private InetSocketAddress	nextNameServerAddress()
pack-priv static ProtocolFamily	preferredAddressType(ResolvedAddressTypes resolvedAddressTypes)
pack-priv final ProtocolFamily	preferredAddressType()
public Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query(DnsQuestion question) Sends a DNS query with the specified question.
public Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query(DnsQuestion question, Iterable<DnsRecord> additionals) Sends a DNS query with the specified question with additional records.
public Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query(DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse, InetSocketAddress>> promise) Sends a DNS query with the specified question.
public Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query(InetSocketAddress nameServerAddr, DnsQuestion question) Sends a DNS query with the specified question using the specified name server list.
public Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query(InetSocketAddress nameServerAddr, DnsQuestion question, Iterable<DnsRecord> additionals) Sends a DNS query with the specified question with additional records using the specified name server list.
public Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query(InetSocketAddress nameServerAddr, DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse, InetSocketAddress>> promise) Sends a DNS query with the specified question using the specified name server list.
public Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query(InetSocketAddress nameServerAddr, DnsQuestion question, Iterable<DnsRecord> additionals, Promise<AddressedEnvelope<? extends DnsResponse, InetSocketAddress>> promise) Sends a DNS query with the specified question with additional records using the specified name server list.
pack-priv final Future<AddressedEnvelope<DnsResponse, InetSocketAddress>>	query0(InetSocketAddress nameServerAddr, DnsQuestion question, DnsRecord[] additionals, boolean flush, Promise<Void> writePromise, Promise<AddressedEnvelope<? extends DnsResponse, InetSocketAddress>> promise)
public long	queryTimeoutMillis() Returns the timeout of each DNS query performed by this resolver (in milliseconds).
public final Future<InetAddress>	Returns: the address as the result of the resolution resolve(String the name to resolve inetHost, Iterable<DnsRecord> additional records (`OPT`) additionals) Resolves the specified name into an address.
public final Future<InetAddress>	Returns: the address as the result of the resolution resolve(String the name to resolve inetHost, Iterable<DnsRecord> additional records (`OPT`) additionals, Promise<InetAddress> the `Promise` which will be fulfilled when the name resolution is finished promise) Resolves the specified name into an address.
public final Future<List<InetAddress>>	Returns: the list of the address as the result of the resolution resolveAll(String the name to resolve inetHost, Iterable<DnsRecord> additional records (`OPT`) additionals) Resolves the specified host name and port into a list of address.
public final Future<List<InetAddress>>	Returns: the list of the address as the result of the resolution resolveAll(String the name to resolve inetHost, Iterable<DnsRecord> additional records (`OPT`) additionals, Promise<List<InetAddress>> the `Promise` which will be fulfilled when the name resolution is finished promise) Resolves the specified host name and port into a list of address.
public final Future<List<DnsRecord>>	Returns: the list of the `DnsRecord`s as the result of the resolution resolveAll(DnsQuestion the question question) Resolves the `DnsRecord`s that are matched by the specified `DnsQuestion`.
public final Future<List<DnsRecord>>	Returns: the list of the `DnsRecord`s as the result of the resolution resolveAll(DnsQuestion the question question, Iterable<DnsRecord> additional records (`OPT`) additionals) Resolves the `DnsRecord`s that are matched by the specified `DnsQuestion`.
public final Future<List<DnsRecord>>	Returns: the list of the `DnsRecord`s as the result of the resolution resolveAll(DnsQuestion the question question, Iterable<DnsRecord> additional records (`OPT`) additionals, Promise<List<DnsRecord>> the `Promise` which will be fulfilled when the resolution is finished promise) Resolves the `DnsRecord`s that are matched by the specified `DnsQuestion`.
private Future<List<DnsRecord>>	resolveAll(DnsQuestion question, DnsRecord[] additionals, Promise<List<DnsRecord>> promise)
public DnsCache	resolveCache() Returns the resolution cache.
public ResolvedAddressTypes	resolvedAddressTypes() Returns the `ResolvedAddressTypes` resolved by `resolve(String)`.
pack-priv ProtocolFamily[]	resolvedProtocolFamiliesUnsafe()
private List<InetAddress>	resolveHostsFileEntries(String hostname)
private InetAddress	resolveHostsFileEntry(String hostname)
pack-priv final DnsRecordType[]	resolveRecordTypes()
pack-priv final String[]	searchDomains()
pack-priv final boolean	supportsAAAARecords()
pack-priv final boolean	supportsARecords()
private static DnsRecord[]	toArray(Iterable<DnsRecord> additionals, boolean validateType)
private static void	tryFailure(Promise<?> promise, Throwable cause)
pack-priv static <T> boolean	trySuccess(Promise<T> promise, T result)
private static void	validateAdditional(DnsRecord record, boolean validateType)

Inherited from io.netty5.resolver.InetNameResolver:: asAddressResolver

public Class DnsNameResolver

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary