Package com.linecorp.armeria.client.endpoint.dns

Class DnsServiceEndpointGroup

java.lang.Object

com.linecorp.armeria.common.util.AbstractListenable<List<Endpoint>>

com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

com.linecorp.armeria.client.endpoint.dns.DnsServiceEndpointGroup

All Implemented Interfaces:

DnsCacheListener, EndpointGroup, EndpointSelector, AsyncCloseable, Listenable<List<Endpoint>>, ListenableAsyncCloseable, AutoCloseable

public final class DnsServiceEndpointGroup
extends DynamicEndpointGroup

DynamicEndpointGroup which resolves targets using DNS SRV records. This is useful for environments where service discovery is handled using DNS, e.g. Kubernetes DNS-based service discovery.

Method Summary

Modifier and Type	Method	Description
static DnsServiceEndpointGroupBuilder	builder(String hostname)	Returns a new DnsServiceEndpointGroupBuilder with the specified hostname.
protected final void	doCloseAsync(CompletableFuture<?> future)	Stops polling DNS servers for service updates.
static DnsServiceEndpointGroup	of(String hostname)	Creates a DnsServiceEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().
void	onEviction(DnsQuestion question, @Nullable List<DnsRecord> records, @Nullable UnknownHostException cause)	Invoked when an eviction occurred for the DnsRecords.
final void	onRemoval(DnsQuestion question, @Nullable List<DnsRecord> records, @Nullable UnknownHostException cause)	Invoked when the DnsRecords expired due to TTL or negative TTL.
String	toString()

Methods inherited from class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

addEndpoint, allowsEmptyEndpoints, builder, close, closeAsync, endpoints, isClosed, isClosing, latestValue, removeEndpoint, select, select, selectionStrategy, selectionTimeoutMillis, selectNow, setEndpoints, toString, toStringSelector, whenClosed, whenReady

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable

addListener, addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.endpoint.EndpointGroup

addListener, addListener, orElse, removeListener

Method Details

of

public static DnsServiceEndpointGroup of(String hostname)

Creates a DnsServiceEndpointGroup that schedules queries on a random EventLoop from CommonPools.workerGroup().

Parameters:

hostname - the hostname to query DNS queries for.

builder

public static DnsServiceEndpointGroupBuilder builder(String hostname)

Returns a new DnsServiceEndpointGroupBuilder with the specified hostname.

Parameters:

hostname - the hostname to query DNS queries for

onRemoval

public final void onRemoval(DnsQuestion question,
 @Nullable
 @Nullable List<DnsRecord> records,
 @Nullable
 @Nullable UnknownHostException cause)

Description copied from interface: DnsCacheListener

Invoked when the DnsRecords expired due to TTL or negative TTL.

Specified by:

onRemoval in interface DnsCacheListener

Parameters:

question - the DNS question.

records - the result of a successful DNS resolution. null if failed.

cause - the cause of a failed DNS resolution. null if succeeded.

onEviction

public void onEviction(DnsQuestion question,
 @Nullable
 @Nullable List<DnsRecord> records,
 @Nullable
 @Nullable UnknownHostException cause)

Description copied from interface: DnsCacheListener

Invoked when an eviction occurred for the DnsRecords. The eviction occurs due to exceeding the maximum size.

Specified by:

onEviction in interface DnsCacheListener

Parameters:

question - the DNS question.

records - the result of a successful DNS resolution. null if failed.

cause - the cause of a failed DNS resolution. null if succeeded.

doCloseAsync

protected final void doCloseAsync(CompletableFuture<?> future)

Stops polling DNS servers for service updates.

Overrides:

doCloseAsync in class DynamicEndpointGroup

toString

public String toString()

Overrides:

toString in class DynamicEndpointGroup