com.linecorp.armeria.client.endpoint.dns

Class DnsTextEndpointGroup

java.lang.Object

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

com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

com.linecorp.armeria.client.endpoint.dns.DnsTextEndpointGroup

All Implemented Interfaces:

EndpointGroup, Listenable<List<Endpoint>>, SafeCloseable, AutoCloseable

public final class DnsTextEndpointGroup
extends DynamicEndpointGroup

DynamicEndpointGroup which resolves targets using DNS TXT records. This is useful for environments where service discovery is handled using DNS.

Method Summary

Modifier and Type	Method and Description
static DnsTextEndpointGroupBuilder	builder(String hostname, Function<byte[],Endpoint> mapping) Returns a new DnsTextEndpointGroupBuilder with the specified hostname and Function mapping.
void	close() Stops polling DNS servers for service updates.
static DnsTextEndpointGroup	of(String hostname, Function<byte[],Endpoint> mapping) Creates a DnsTextEndpointGroup 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 DnsTextEndpointGroup of(String hostname,
                                      Function<byte[],Endpoint> mapping)

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

Parameters:

hostname - the hostname to query DNS queries for

mapping - the Function that maps the content of a TXT record into an Endpoint. The Function is expected to return null if the record contains unsupported content.

builder

public static DnsTextEndpointGroupBuilder builder(String hostname,
                                                  Function<byte[],Endpoint> mapping)

Returns a new DnsTextEndpointGroupBuilder with the specified hostname and Function mapping.

Parameters:

hostname - the hostname to query DNS queries for

mapping - the Function that maps the content of a TXT record into an Endpoint. The Function is expected to return null if the record contains unsupported content.

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