Package com.linecorp.armeria.client.consul

Class ConsulEndpointGroup

java.lang.Object

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

com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

com.linecorp.armeria.client.consul.ConsulEndpointGroup

All Implemented Interfaces:

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

@UnstableApi
public final class ConsulEndpointGroup
extends DynamicEndpointGroup

A Consul-based EndpointGroup implementation that retrieves the list of Endpoints from Consul using Consul's HTTP API and updates the Endpoints periodically.

Method Summary

Modifier and Type	Method	Description
static ConsulEndpointGroupBuilder	builder(URI consulUri, String serviceName)	Returns a newly-created ConsulEndpointGroupBuilder with the specified consulUri and serviceName to build ConsulEndpointGroupBuilder.
protected void	doCloseAsync(CompletableFuture<?> future)	Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.
protected final List<Endpoint>	latestValue()	Returns the latest value notified before.
static ConsulEndpointGroup	of(URI consulUri, String serviceName)	Returns a ConsulEndpointGroup with the specified serviceName.
String	toString()

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

addEndpoint, allowsEmptyEndpoints, builder, close, closeAsync, endpoints, isClosed, isClosing, removeEndpoint, select, select, selectionStrategy, selectionTimeoutMillis, selectNow, setEndpoints, toString, 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 ConsulEndpointGroup of(URI consulUri,
 String serviceName)

Returns a ConsulEndpointGroup with the specified serviceName. The returned ConsulEndpointGroup will retrieve the list of Endpoints from a local Consul agent at the default Consul service port.

Parameters:

consulUri - the URI of Consul API service

serviceName - the service name to register

builder

public static ConsulEndpointGroupBuilder builder(URI consulUri,
 String serviceName)

Returns a newly-created ConsulEndpointGroupBuilder with the specified consulUri and serviceName to build ConsulEndpointGroupBuilder.

Parameters:

consulUri - the URI of Consul API service

serviceName - the service name to register

doCloseAsync

protected void doCloseAsync(CompletableFuture<?> future)

Description copied from class: DynamicEndpointGroup

Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.

Overrides:

doCloseAsync in class DynamicEndpointGroup

toString

public String toString()

Overrides:

toString in class DynamicEndpointGroup

latestValue

protected final List<Endpoint> latestValue()

Description copied from class: AbstractListenable

Returns the latest value notified before. null if the value has not been initialized yet or the implementation of this class cannot cache it.

Overrides:

latestValue in class AbstractListenable<List<Endpoint>>