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:

EndpointGroup, Listenable<List<Endpoint>>, SafeCloseable, 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 and Description
static DnsServiceEndpointGroupBuilder	builder(String hostname) Returns a new DnsServiceEndpointGroupBuilder with the specified hostname.
void	close() 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().

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

addEndpoint, endpoints, initialEndpointsFuture, removeEndpoint, setEndpoints

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

addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object

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

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

addListener, awaitInitialEndpoints, awaitInitialEndpoints, empty, of, of, orElse, removeListener

Method Detail

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

close

public final void close()

Stops polling DNS servers for service updates.

Specified by:

close in interface EndpointGroup

Specified by:

close in interface SafeCloseable

Specified by:

close in interface AutoCloseable

Overrides:

close in class DynamicEndpointGroup