Package com.linecorp.armeria.client.endpoint

Interface EndpointGroup

All Superinterfaces:

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

All Known Implementing Classes:

DnsAddressEndpointGroup, DnsServiceEndpointGroup, DnsTextEndpointGroup, DynamicEndpointGroup, Endpoint, HealthCheckedEndpointGroup, PropertiesEndpointGroup

public interface EndpointGroup
extends Listenable<List<Endpoint>>, EndpointSelector, AsyncCloseable

A list of Endpoints.

Method Summary

Modifier and Type	Method	Description
default void	addListener(Consumer<? super List<Endpoint>> listener)	Adds a Consumer that will be invoked when a Listenable changes its value.
default void	addListener(Consumer<? super List<Endpoint>> listener, boolean notifyLatestEndpoints)	Adds a Consumer that will be invoked when this EndpointGroup changes its value.
List<Endpoint>	endpoints()	Returns the endpoints held by this EndpointGroup.
static EndpointGroup	of()	Returns a singleton EndpointGroup which does not contain any Endpoints.
static EndpointGroup	of(EndpointGroup... endpointGroups)	Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
static EndpointGroup	of(EndpointSelectionStrategy selectionStrategy, EndpointGroup... endpointGroups)	Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
static EndpointGroup	of(EndpointSelectionStrategy selectionStrategy, Iterable<? extends EndpointGroup> endpointGroups)	Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
static EndpointGroup	of(Iterable<? extends EndpointGroup> endpointGroups)	Returns an EndpointGroup that combines all the Endpoints of endpointGroups.
default EndpointGroup	orElse(EndpointGroup nextEndpointGroup)	Creates a new EndpointGroup that tries this EndpointGroup first and then the specified EndpointGroup when this EndpointGroup does not have a requested resource.
default void	removeListener(Consumer<?> listener)	Remove a listener.
EndpointSelectionStrategy	selectionStrategy()	Returns the EndpointSelectionStrategy of this EndpointGroup.
long	selectionTimeoutMillis()	Returns the timeout to wait until a successful Endpoint selection.
Endpoint	selectNow(ClientRequestContext ctx)	Selects an Endpoint from this EndpointGroup.
CompletableFuture<List<Endpoint>>	whenReady()	Returns a CompletableFuture which is completed when the initial Endpoints are ready.

Methods inherited from interface com.linecorp.armeria.common.util.AsyncCloseable

close, closeAsync

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

select, select

Method Details

of

static EndpointGroup of()

Returns a singleton EndpointGroup which does not contain any Endpoints.

of

static EndpointGroup of(EndpointGroup... endpointGroups)

Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set. The EndpointGroup returned by this method will use EndpointSelectionStrategy.weightedRoundRobin() for selecting an Endpoint.

of

static EndpointGroup of(EndpointSelectionStrategy selectionStrategy,
 EndpointGroup... endpointGroups)

Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set.

of

static EndpointGroup of(Iterable<? extends EndpointGroup> endpointGroups)

Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set. The EndpointGroup returned by this method will use EndpointSelectionStrategy.weightedRoundRobin() for selecting an Endpoint.

of

static EndpointGroup of(EndpointSelectionStrategy selectionStrategy,
 Iterable<? extends EndpointGroup> endpointGroups)

Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set.

endpoints

List<Endpoint> endpoints()

Returns the endpoints held by this EndpointGroup.

selectionStrategy

EndpointSelectionStrategy selectionStrategy()

Returns the EndpointSelectionStrategy of this EndpointGroup.

selectNow

Endpoint selectNow(ClientRequestContext ctx)

Selects an Endpoint from this EndpointGroup.

Specified by:

selectNow in interface EndpointSelector

Returns:

the Endpoint selected by the EndpointSelectionStrategy, which was specified when constructing this EndpointGroup, or null if this EndpointGroup is empty.

selectionTimeoutMillis

@UnstableApi
long selectionTimeoutMillis()

Returns the timeout to wait until a successful Endpoint selection. If an Endpoint is not resolved by this EndpointGroup within the timeout, a null value will be returned by EndpointSelector.select(ClientRequestContext, ScheduledExecutorService). The null Endpoint may cause a client request end with an EndpointSelectionTimeoutException if no RetryingClient is configured.

0 means selectNow(ClientRequestContext) should always return an Endpoint.

whenReady

CompletableFuture<List<Endpoint>> whenReady()

Returns a CompletableFuture which is completed when the initial Endpoints are ready.

addListener

default void addListener(Consumer<? super List<Endpoint>> listener)

Description copied from interface: Listenable

Adds a Consumer that will be invoked when a Listenable changes its value.

Specified by:

addListener in interface Listenable<List<Endpoint>>

addListener

default void addListener(Consumer<? super List<Endpoint>> listener,
 boolean notifyLatestEndpoints)

Adds a Consumer that will be invoked when this EndpointGroup changes its value. If notifyLatestEndpoints is set to true and the whenReady() is completed already, the Consumer will be invoked immediately with the current endpoints().

removeListener

default void removeListener(Consumer<?> listener)

Description copied from interface: Listenable

Remove a listener.

Specified by:

removeListener in interface Listenable<List<Endpoint>>

orElse

default EndpointGroup orElse(EndpointGroup nextEndpointGroup)

Creates a new EndpointGroup that tries this EndpointGroup first and then the specified EndpointGroup when this EndpointGroup does not have a requested resource.

Parameters:

nextEndpointGroup - the EndpointGroup to try secondly.