io.servicetalk.dns.discovery.netty

Class DefaultDnsServiceDiscovererBuilder

Object

DefaultDnsServiceDiscovererBuilder

public final class DefaultDnsServiceDiscovererBuilder
extends Object

Builder use to create objects of type DefaultDnsServiceDiscoverer.

Constructor Summary

Constructors

Constructor and Description
DefaultDnsServiceDiscovererBuilder()

Method Summary

Modifier and Type	Method and Description
DefaultDnsServiceDiscovererBuilder	appendFilter(ServiceDiscovererFilterFactory<String,InetAddress,ServiceDiscovererEvent<InetAddress>> factory) Append the filter to the chain of filters used to decorate the ServiceDiscoverer created by this builder.
ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>>	build() Build a new instance of ServiceDiscoverer<HostAndPort, InetSocketAddress>.
ServiceDiscoverer<String,InetAddress,ServiceDiscovererEvent<InetAddress>>	buildInetDiscoverer() Build a new instance of ServiceDiscoverer<String, InetAddress>.
Predicate<Throwable>	defaultInvalidateHostsOnDnsFailurePredicate() Returns a default value for invalidateHostsOnDnsFailure(Predicate).
DefaultDnsServiceDiscovererBuilder	dnsResolverAddressTypes(DnsResolverAddressTypes dnsResolverAddressTypes) Sets the list of the protocol families of the address resolved.
DefaultDnsServiceDiscovererBuilder	dnsServerAddressStreamProvider(DnsServerAddressStreamProvider dnsServerAddressStreamProvider) Set the DnsServerAddressStreamProvider which determines which DNS server should be used per query.
DefaultDnsServiceDiscovererBuilder	invalidateHostsOnDnsFailure(Predicate<Throwable> invalidateHostsOnDnsFailure) Allows sending 'unavailable' events for all current active hosts for particular DNS errors.
DefaultDnsServiceDiscovererBuilder	ioExecutor(IoExecutor ioExecutor) Sets the IoExecutor.
DefaultDnsServiceDiscovererBuilder	minTTL(int minTTLSeconds) The minimum allowed TTL.
DefaultDnsServiceDiscovererBuilder	ndots(int ndots) Set the number of dots which must appear in a name before an initial absolute query is made.
DefaultDnsServiceDiscovererBuilder	noRetriesOnDnsFailures() Do not perform retries if DNS lookup fails.
DefaultDnsServiceDiscovererBuilder	optResourceEnabled(boolean optResourceEnabled) Enable 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.
DefaultDnsServiceDiscovererBuilder	queryTimeout(Duration queryTimeout) Sets the timeout of each DNS query performed by this service discoverer.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultDnsServiceDiscovererBuilder

public DefaultDnsServiceDiscovererBuilder()

Method Detail

minTTL

public DefaultDnsServiceDiscovererBuilder minTTL(int minTTLSeconds)

The minimum allowed TTL. This will be the minimum poll interval.

Parameters:

minTTLSeconds - The minimum amount of time a cache entry will be considered valid (in seconds).

Returns:

this.

dnsServerAddressStreamProvider

public DefaultDnsServiceDiscovererBuilder dnsServerAddressStreamProvider(@Nullable
                                                                         DnsServerAddressStreamProvider dnsServerAddressStreamProvider)

Set the DnsServerAddressStreamProvider which determines which DNS server should be used per query.

Parameters:

dnsServerAddressStreamProvider - the DnsServerAddressStreamProvider which determines which DNS server should be used per query.

Returns:

this.

optResourceEnabled

public DefaultDnsServiceDiscovererBuilder optResourceEnabled(boolean optResourceEnabled)

Enable 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. Some DNSServer may not support this and so fail to answer queries. If you find problems you may want to disable this.

Parameters:

optResourceEnabled - if optional records inclusion is enabled.

Returns:

this.

ndots

public DefaultDnsServiceDiscovererBuilder ndots(int ndots)

Set the number of dots which must appear in a name before an initial absolute query is made.

Parameters:

ndots - the ndots value.

Returns:

this.

queryTimeout

public DefaultDnsServiceDiscovererBuilder queryTimeout(Duration queryTimeout)

Sets the timeout of each DNS query performed by this service discoverer.

Parameters:

queryTimeout - the query timeout value

Returns:

this.

invalidateHostsOnDnsFailure

public DefaultDnsServiceDiscovererBuilder invalidateHostsOnDnsFailure(Predicate<Throwable> invalidateHostsOnDnsFailure)

Allows sending 'unavailable' events for all current active hosts for particular DNS errors.

Note: The default does not send 'unavailable' events when a DNS lookup times out.

Parameters:

invalidateHostsOnDnsFailure - determines whether or not to send 'unavailable' events.

Returns:

this.

defaultInvalidateHostsOnDnsFailurePredicate

public Predicate<Throwable> defaultInvalidateHostsOnDnsFailurePredicate()

Returns a default value for invalidateHostsOnDnsFailure(Predicate).

Returns:

a default value for invalidateHostsOnDnsFailure(Predicate)

dnsResolverAddressTypes

public DefaultDnsServiceDiscovererBuilder dnsResolverAddressTypes(@Nullable
                                                                  DnsResolverAddressTypes dnsResolverAddressTypes)

Sets the list of the protocol families of the address resolved.

Parameters:

dnsResolverAddressTypes - the address types.

Returns:

this.

noRetriesOnDnsFailures

public DefaultDnsServiceDiscovererBuilder noRetriesOnDnsFailures()

Do not perform retries if DNS lookup fails. Instead, terminate the Publisher with the error.

Returns:

this.

appendFilter

public DefaultDnsServiceDiscovererBuilder appendFilter(ServiceDiscovererFilterFactory<String,InetAddress,ServiceDiscovererEvent<InetAddress>> factory)

Append the filter to the chain of filters used to decorate the ServiceDiscoverer created by this builder.

Note this method will be used to decorate the result of build()/buildInetDiscoverer() before it is returned to the user.

The order of execution of these filters are in order of append. If 3 filters are added as follows:

     builder.append(filter1).append(filter2).append(filter3)
 

making a request to a service discoverer wrapped by this filter chain the order of invocation of these filters will be:

     filter1 => filter2 => filter3 => service discoverer
 

Parameters:

factory - ServiceDiscovererFilterFactory to decorate a ServiceDiscoverer for the purpose of filtering.

Returns:

this

ioExecutor

public DefaultDnsServiceDiscovererBuilder ioExecutor(IoExecutor ioExecutor)

Sets the IoExecutor.

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

buildInetDiscoverer

public ServiceDiscoverer<String,InetAddress,ServiceDiscovererEvent<InetAddress>> buildInetDiscoverer()

Build a new instance of ServiceDiscoverer<String, InetAddress>.

Returns:

a new instance of ServiceDiscoverer<String, InetAddress>.

build

public ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> build()

Build a new instance of ServiceDiscoverer<HostAndPort, InetSocketAddress>.

Returns:

a new instance of ServiceDiscoverer<HostAndPort, InetSocketAddress>.

See Also:

HostAndPort