io.servicetalk.dns.discovery.netty

Class DefaultDnsServiceDiscovererBuilder

Object

DefaultDnsServiceDiscovererBuilder

public final class DefaultDnsServiceDiscovererBuilder
extends Object

Builder for DNS ServiceDiscoverer which will attempt to resolve A, AAAA, CNAME, and SRV type queries.

Constructor Summary

Constructors

Constructor and Description
DefaultDnsServiceDiscovererBuilder()

Method Summary

Modifier and Type	Method and Description
ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>>	buildARecordDiscoverer() Build a new ServiceDiscoverer which targets host addresses (e.g.
ServiceDiscoverer<String,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>>	buildSrvDiscoverer() Build a new ServiceDiscoverer which queries SRV Resource Records corresponding to serviceName.
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	ioExecutor(IoExecutor ioExecutor) Sets the IoExecutor.
DefaultDnsServiceDiscovererBuilder	maxUdpPayloadSize(int maxUdpPayloadSize) Set the maximum size of the receiving UDP datagram (in bytes).
DefaultDnsServiceDiscovererBuilder	minTTL(int minTTLSeconds) The minimum allowed TTL.
DefaultDnsServiceDiscovererBuilder	missingRecordStatus(ServiceDiscovererEvent.Status status) Sets which ServiceDiscovererEvent.Status to use in ServiceDiscovererEvent.status() when a record for a previously seen address is missing in the response.
DefaultDnsServiceDiscovererBuilder	ndots(int ndots) Set the number of dots which must appear in a name before an initial absolute query is made.
DefaultDnsServiceDiscovererBuilder	observer(DnsServiceDiscovererObserver observer) Sets a DnsServiceDiscovererObserver that provides visibility into DNS ServiceDiscoverer built by this builder.
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.
DefaultDnsServiceDiscovererBuilder	ttlJitter(Duration ttlJitter) The jitter to apply to schedule the next query after TTL.

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.

ttlJitter

public DefaultDnsServiceDiscovererBuilder ttlJitter(Duration ttlJitter)

The jitter to apply to schedule the next query after TTL.

The jitter value will be added on top of the TTL value returned from the DNS server to help spread out subsequent DNS queries.

Parameters:

ttlJitter - The jitter to apply to schedule the next query after TTL.

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.

maxUdpPayloadSize

public DefaultDnsServiceDiscovererBuilder maxUdpPayloadSize(int maxUdpPayloadSize)

Set the maximum size of the receiving UDP datagram (in bytes).

If the DNS response exceeds this amount the request will be automatically retried via TCP.

Parameters:

maxUdpPayloadSize - the maximum size of the receiving UDP datagram (in bytes)

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.

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.

ioExecutor

public DefaultDnsServiceDiscovererBuilder ioExecutor(IoExecutor ioExecutor)

Sets the IoExecutor.

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

observer

public DefaultDnsServiceDiscovererBuilder observer(DnsServiceDiscovererObserver observer)

Sets a DnsServiceDiscovererObserver that provides visibility into DNS ServiceDiscoverer built by this builder.

Parameters:

observer - a DnsServiceDiscovererObserver that provides visibility into DNS ServiceDiscoverer built by this builder

Returns:

this.

missingRecordStatus

public DefaultDnsServiceDiscovererBuilder missingRecordStatus(ServiceDiscovererEvent.Status status)

Sets which ServiceDiscovererEvent.Status to use in ServiceDiscovererEvent.status() when a record for a previously seen address is missing in the response.

Parameters:

status - a ServiceDiscovererEvent.Status for missing records.

Returns:

this.

buildSrvDiscoverer

public ServiceDiscoverer<String,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> buildSrvDiscoverer()

Build a new ServiceDiscoverer which queries SRV Resource Records corresponding to serviceName. For each SRV answer capture the Port and resolve the Target.

Returns:

a new ServiceDiscoverer which queries SRV Resource Records corresponding to serviceName. For each SRV answer capture the Port and resolve the Target.

buildARecordDiscoverer

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

Build a new ServiceDiscoverer which targets host addresses (e.g. A or AAAA records) and uses a fixed port derived from the HostAndPort.

Returns:

a new ServiceDiscoverer which targets host addresses (e.g. A or AAAA records) and uses a fixed port derived from the HostAndPort.