NameResolverProvider.NameResolverSpec (reactor-netty 1.2.0-M1)

Enclosing class:: NameResolverProvider

public static interface NameResolverProvider.NameResolverSpec

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NameResolverProvider.NameResolverSpec`	`bindAddressSupplier(Supplier<? extends SocketAddress> bindAddressSupplier)` Set a new local address supplier that supply the address to bind to.
`NameResolverProvider`	`build()` Build a new `NameResolverProvider`.
`NameResolverProvider.NameResolverSpec`	`cacheMaxTimeToLive(Duration cacheMaxTimeToLive)` Sets the max time to live of the cached DNS resource records (resolution: seconds).
`NameResolverProvider.NameResolverSpec`	`cacheMinTimeToLive(Duration cacheMinTimeToLive)` Sets the min time to live of the cached DNS resource records (resolution: seconds).
`NameResolverProvider.NameResolverSpec`	`cacheNegativeTimeToLive(Duration cacheNegativeTimeToLive)` Sets the time to live of the cache for the failed DNS queries (resolution: seconds).
`NameResolverProvider.NameResolverSpec`	`completeOncePreferredResolved(boolean enable)` If `true`, the resolver notifies the returned `Future` as soon as all queries for the preferred address type are complete.
`NameResolverProvider.NameResolverSpec`	`disableOptionalRecord(boolean disable)` Disables the automatic inclusion of an optional record that tries to hint the remote DNS server about how much data the resolver can read per response.
`NameResolverProvider.NameResolverSpec`	`disableRecursionDesired(boolean disable)` Specifies whether this resolver has to send a DNS query with the recursion desired (RD) flag set.
`NameResolverProvider.NameResolverSpec`	`dnsAddressResolverGroupProvider(Function<DnsNameResolverBuilder,DnsAddressResolverGroup> dnsAddressResolverGroupProvider)` Sets the custom function to build the `DnsAddressResolverGroup` given a `DnsNameResolverBuilder`.
`NameResolverProvider.NameResolverSpec`	`hostsFileEntriesResolver(HostsFileEntriesResolver hostsFileEntriesResolver)` Specifies a custom `HostsFileEntriesResolver` to be used for hosts file entries.
`NameResolverProvider.NameResolverSpec`	`maxPayloadSize(int maxPayloadSize)` Sets the capacity of the datagram packet buffer (in bytes).
`NameResolverProvider.NameResolverSpec`	`maxQueriesPerResolve(int maxQueriesPerResolve)` Sets the maximum allowed number of DNS queries to send when resolving a host name.
`NameResolverProvider.NameResolverSpec`	`ndots(int ndots)` Sets the number of dots which must appear in a name before an initial absolute query is made.
`NameResolverProvider.NameResolverSpec`	`queryTimeout(Duration queryTimeout)` Sets the timeout of each DNS query performed by this resolver (resolution: milliseconds).
`NameResolverProvider.NameResolverSpec`	`resolveCache(DnsCache resolveCache)` Sets the resolve cache to use for DNS resolution.
`NameResolverProvider.NameResolverSpec`	`resolvedAddressTypes(ResolvedAddressTypes resolvedAddressTypes)` Sets the list of the protocol families of the address resolved.
`NameResolverProvider.NameResolverSpec`	`retryTcpOnTimeout(boolean enable)` Specifies whether this resolver will also fallback to TCP if a timeout is detected.
`NameResolverProvider.NameResolverSpec`	`roundRobinSelection(boolean enable)` Enables an `AddressResolverGroup` of `DnsNameResolver`s that supports random selection of destination addresses if multiple are provided by the nameserver.
`NameResolverProvider.NameResolverSpec`	`runOn(EventLoopGroup eventLoopGroup)` Performs the communication with the DNS servers on the given `EventLoopGroup`.
`NameResolverProvider.NameResolverSpec`	`runOn(LoopResources loopResources)` Performs the communication with the DNS servers on a supplied `EventLoopGroup` from the `LoopResources` container.
`NameResolverProvider.NameResolverSpec`	`runOn(LoopResources loopResources, boolean preferNative)` Performs the communication with the DNS servers on a supplied `EventLoopGroup` from the `LoopResources` container.
`NameResolverProvider.NameResolverSpec`	`searchDomains(List<String> searchDomains)` Sets the list of search domains of the resolver.
`NameResolverProvider.NameResolverSpec`	`trace(String category, LogLevel level)` Sets a specific category and log level to be used by this resolver when generating a detailed trace information in case of resolution failure.

- Method Detail
  - bindAddressSupplier
```
NameResolverProvider.NameResolverSpec bindAddressSupplier(Supplier<? extends SocketAddress> bindAddressSupplier)
```
    Set a new local address supplier that supply the address to bind to. By default, the host is configured for any local address, and the system picks up an ephemeral port.
    
    Parameters:
    
    bindAddressSupplier - A supplier of local address to bind to
    
    Returns:
    
    this
    
    Since:
    
    1.0.14
  - build
```
NameResolverProvider build()
```
    Build a new NameResolverProvider.
    
    Returns:
    
    a new NameResolverProvider
  - cacheMaxTimeToLive
```
NameResolverProvider.NameResolverSpec cacheMaxTimeToLive(Duration cacheMaxTimeToLive)
```
    Sets the max time to live of the cached DNS resource records (resolution: seconds). If the time to live of the DNS resource record returned by the DNS server is greater than this max time to live, this resolver will ignore the time to live from the DNS server and will use this max time to live. Default to Build#DEFAULT_CACHE_MAX_TIME_TO_LIVE.
    
    Parameters:
    
    cacheMaxTimeToLive - the maximum time to live (resolution: seconds)
    
    Returns:
    
    this
  - cacheMinTimeToLive
```
NameResolverProvider.NameResolverSpec cacheMinTimeToLive(Duration cacheMinTimeToLive)
```
    Sets the min time to live of the cached DNS resource records (resolution: seconds). If the time to live of the DNS resource record returned by the DNS server is less than this min time to live, this resolver will ignore the time to live from the DNS server and will use this min time to live. Default to Build#DEFAULT_CACHE_MIN_TIME_TO_LIVE.
    
    Parameters:
    
    cacheMinTimeToLive - the minimum time to live (resolution: seconds)
    
    Returns:
    
    this
  - cacheNegativeTimeToLive
```
NameResolverProvider.NameResolverSpec cacheNegativeTimeToLive(Duration cacheNegativeTimeToLive)
```
    Sets the time to live of the cache for the failed DNS queries (resolution: seconds). Default to Build#DEFAULT_CACHE_NEGATIVE_TIME_TO_LIVE.
    
    Parameters:
    
    cacheNegativeTimeToLive - the time to live of the cache for the failed DNS queries (resolution: seconds)
    
    Returns:
    
    this
  - completeOncePreferredResolved
```
NameResolverProvider.NameResolverSpec completeOncePreferredResolved(boolean enable)
```
    If true, the resolver notifies the returned Future as soon as all queries for the preferred address type are complete. If false, the resolver notifies the returned Future when all possible address types are complete. This configuration is applicable for SimpleNameResolver.resolveAll(String). By default, this is enabled.
    
    Parameters:
    
    enable - true to enable, false to disable
    
    Returns:
    
    this
  - disableOptionalRecord
```
NameResolverProvider.NameResolverSpec disableOptionalRecord(boolean disable)
```
    Disables the automatic inclusion of an optional record that tries to hint the remote DNS server about how much data the resolver can read per response. By default, this is enabled.
    
    Parameters:
    
    disable - true if an optional record is not included
    
    Returns:
    
    this
  - disableRecursionDesired
```
NameResolverProvider.NameResolverSpec disableRecursionDesired(boolean disable)
```
    Specifies whether this resolver has to send a DNS query with the recursion desired (RD) flag set. By default, this is enabled.
    
    Parameters:
    
    disable - true if RD flag is not set
    
    Returns:
    
    this
  - dnsAddressResolverGroupProvider
```
NameResolverProvider.NameResolverSpec dnsAddressResolverGroupProvider(Function<DnsNameResolverBuilder,DnsAddressResolverGroup> dnsAddressResolverGroupProvider)
```
    Sets the custom function to build the DnsAddressResolverGroup given a DnsNameResolverBuilder.
    
    Parameters:
    
    dnsAddressResolverGroupProvider - the DnsAddressResolverGroup provider function
    
    Returns:
    
    this
    
    Since:
    
    1.1.6
  - hostsFileEntriesResolver
```
NameResolverProvider.NameResolverSpec hostsFileEntriesResolver(HostsFileEntriesResolver hostsFileEntriesResolver)
```
    Specifies a custom HostsFileEntriesResolver to be used for hosts file entries. Default to DefaultHostsFileEntriesResolver.
    
    Parameters:
    
    hostsFileEntriesResolver - the HostsFileEntriesResolver to be used for hosts file entries
    
    Returns:
    
    this
    
    Since:
    
    1.0.12
  - maxPayloadSize
```
NameResolverProvider.NameResolverSpec maxPayloadSize(int maxPayloadSize)
```
    Sets the capacity of the datagram packet buffer (in bytes). Default to Build#DEFAULT_MAX_PAYLOAD_SIZE.
    
    Parameters:
    
    maxPayloadSize - the capacity of the datagram packet buffer
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if maxPayloadSize is not positive
  - maxQueriesPerResolve
```
NameResolverProvider.NameResolverSpec maxQueriesPerResolve(int maxQueriesPerResolve)
```
    Sets the maximum allowed number of DNS queries to send when resolving a host name. Default to Build#DEFAULT_MAX_QUERIES_PER_RESOLVE.
    
    Parameters:
    
    maxQueriesPerResolve - the max number of queries
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if maxQueriesPerResolve is not positive
  - ndots
```
NameResolverProvider.NameResolverSpec ndots(int ndots)
```
    Sets the number of dots which must appear in a name before an initial absolute query is made. Default to Build#DEFAULT_NDOTS which determines the value from the OS on Unix or uses the value 1.
    
    Parameters:
    
    ndots - the ndots value
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if ndots is less than -1
  - queryTimeout
```
NameResolverProvider.NameResolverSpec queryTimeout(Duration queryTimeout)
```
    Sets the timeout of each DNS query performed by this resolver (resolution: milliseconds). Default to Build#DEFAULT_QUERY_TIMEOUT.
    
    Parameters:
    
    queryTimeout - the query timeout (resolution: milliseconds)
    
    Returns:
    
    this
  - resolveCache
```
NameResolverProvider.NameResolverSpec resolveCache(DnsCache resolveCache)
```
    Sets the resolve cache to use for DNS resolution.
    
    Parameters:
    
    resolveCache - the resolution DNS cache
    
    Returns:
    
    this
    
    Since:
    
    1.0.27
  - resolvedAddressTypes
```
NameResolverProvider.NameResolverSpec resolvedAddressTypes(ResolvedAddressTypes resolvedAddressTypes)
```
    Sets the list of the protocol families of the address resolved.
    
    Parameters:
    
    resolvedAddressTypes - the address types
    
    Returns:
    
    this
  - retryTcpOnTimeout
```
NameResolverProvider.NameResolverSpec retryTcpOnTimeout(boolean enable)
```
    Specifies whether this resolver will also fallback to TCP if a timeout is detected. By default, the resolver will only try to use TCP if the response is marked as truncated.
    
    Parameters:
    
    enable - if true this resolver will also fallback to TCP if a timeout is detected, if false the resolver will only try to use TCP if the response is marked as truncated.
    
    Returns:
    
    this
    
    Since:
    
    1.1.17
  - roundRobinSelection
```
NameResolverProvider.NameResolverSpec roundRobinSelection(boolean enable)
```
    Enables an AddressResolverGroup of DnsNameResolvers that supports random selection of destination addresses if multiple are provided by the nameserver. See RoundRobinDnsAddressResolverGroup. Default to DnsAddressResolverGroup.
    
    Parameters:
    
    enable - true to enable, false to disable
    
    Returns:
    
    this
  - runOn
```
NameResolverProvider.NameResolverSpec runOn(EventLoopGroup eventLoopGroup)
```
    Performs the communication with the DNS servers on the given EventLoopGroup.
    
    Parameters:
    
    eventLoopGroup - the EventLoopGroup
    
    Returns:
    
    this
  - runOn
```
NameResolverProvider.NameResolverSpec runOn(LoopResources loopResources)
```
    Performs the communication with the DNS servers on a supplied EventLoopGroup from the LoopResources container. Will prefer native (epoll/kqueue) implementation if available unless the environment property reactor.netty.native is set to false.
    
    Parameters:
    
    loopResources - the LoopResources
    
    Returns:
    
    this
  - runOn
```
NameResolverProvider.NameResolverSpec runOn(LoopResources loopResources,
                                            boolean preferNative)
```
    Performs the communication with the DNS servers on a supplied EventLoopGroup from the LoopResources container.
    
    Parameters:
    
    loopResources - the LoopResources
    
    preferNative - should prefer running on epoll or kqueue instead of java NIO
    
    Returns:
    
    this
  - searchDomains
```
NameResolverProvider.NameResolverSpec searchDomains(List<String> searchDomains)
```
    Sets the list of search domains of the resolver. By default, the effective search domain list will be populated using the system DNS search domains.
    
    Parameters:
    
    searchDomains - the search domains
    
    Returns:
    
    this
  - trace
```
NameResolverProvider.NameResolverSpec trace(String category,
                                            LogLevel level)
```
    Sets a specific category and log level to be used by this resolver when generating a detailed trace information in case of resolution failure.
    
    Parameters:
    
    category - the logger category
    
    level - the logger level
    
    Returns:
    
    this

Interface NameResolverProvider.NameResolverSpec

Method Summary

Method Detail

bindAddressSupplier

build

cacheMaxTimeToLive

cacheMinTimeToLive

cacheNegativeTimeToLive

completeOncePreferredResolved

disableOptionalRecord

disableRecursionDesired

dnsAddressResolverGroupProvider

hostsFileEntriesResolver

maxPayloadSize

maxQueriesPerResolve

ndots

queryTimeout

resolveCache

resolvedAddressTypes

retryTcpOnTimeout

roundRobinSelection

runOn

runOn

runOn

searchDomains

trace