Package com.linecorp.armeria.client.endpoint

Class DynamicEndpointGroup

java.lang.Object

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

com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

ConsulEndpointGroup, DnsAddressEndpointGroup, DnsServiceEndpointGroup, DnsTextEndpointGroup, EurekaEndpointGroup, HealthCheckedEndpointGroup, PropertiesEndpointGroup, ZooKeeperEndpointGroup

public class DynamicEndpointGroup
extends AbstractListenable<List<Endpoint>>
implements ListenableAsyncCloseable

A dynamic EndpointGroup. The list of Endpoints can be updated dynamically.

Constructor Summary

Constructors

Modifier	Constructor	Description
	DynamicEndpointGroup()	Creates a new empty instance, using EndpointSelectionStrategy.weightedRoundRobin() and allowing an empty Endpoint list.
protected	DynamicEndpointGroup(boolean allowEmptyEndpoints)	Creates a new empty instance, using EndpointSelectionStrategy.weightedRoundRobin().
protected	DynamicEndpointGroup(boolean allowEmptyEndpoints, long selectionTimeoutMillis)	Creates a new empty instance, using EndpointSelectionStrategy.weightedRoundRobin().
	DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy)	Creates a new empty instance, allowing an empty Endpoint list.
protected	DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy, boolean allowEmptyEndpoints)	Creates a new empty instance.
protected	DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy, boolean allowEmptyEndpoints, long selectionTimeoutMillis)	Creates a new empty instance.

Method Summary

Modifier and Type	Method	Description
protected final void	addEndpoint(Endpoint e)	Adds the specified Endpoint to current Endpoint list.
boolean	allowsEmptyEndpoints()	Returns whether this EndpointGroup allows an empty Endpoint list.
static DynamicEndpointGroupBuilder	builder()	Returns a newly created builder.
final void	close()	Releases any underlying resources held by this object synchronously.
final CompletableFuture<?>	closeAsync()	Releases any underlying resources held by this object asynchronously.
protected void	doCloseAsync(CompletableFuture<?> future)	Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.
final List<Endpoint>	endpoints()	Returns the endpoints held by this EndpointGroup.
final boolean	isClosed()	Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.
final boolean	isClosing()	Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.
protected final List<Endpoint>	latestValue()	Returns the latest value notified before.
protected final void	removeEndpoint(Endpoint e)	Removes the specified Endpoint from current Endpoint list.
final CompletableFuture<Endpoint>	select(ClientRequestContext ctx, ScheduledExecutorService executor)	Selects an Endpoint asynchronously from the EndpointGroup associated with the specified ClientRequestContext, waiting up to the specified timeoutMillis.
final CompletableFuture<Endpoint>	select(ClientRequestContext ctx, ScheduledExecutorService executor, long timeoutMillis)	Deprecated.
final EndpointSelectionStrategy	selectionStrategy()	Returns the EndpointSelectionStrategy of this EndpointGroup.
long	selectionTimeoutMillis()	Returns the timeout to wait until a successful Endpoint selection.
final Endpoint	selectNow(ClientRequestContext ctx)	Selects an Endpoint from this EndpointGroup.
protected final void	setEndpoints(Iterable<Endpoint> endpoints)	Sets the specified Endpoints as current Endpoint list.
String	toString()
final CompletableFuture<?>	whenClosed()	Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.
final CompletableFuture<List<Endpoint>>	whenReady()	Returns the CompletableFuture which is completed when the initial Endpoints are ready.

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

Constructor Details

DynamicEndpointGroup

public DynamicEndpointGroup()

Creates a new empty instance, using EndpointSelectionStrategy.weightedRoundRobin() and allowing an empty Endpoint list.

DynamicEndpointGroup

public DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy)

Creates a new empty instance, allowing an empty Endpoint list.

Parameters:

selectionStrategy - the EndpointSelectionStrategy of this EndpointGroup

DynamicEndpointGroup

protected DynamicEndpointGroup(boolean allowEmptyEndpoints)

Creates a new empty instance, using EndpointSelectionStrategy.weightedRoundRobin().

Parameters:

allowEmptyEndpoints - whether to allow an empty Endpoint list

DynamicEndpointGroup

protected DynamicEndpointGroup(boolean allowEmptyEndpoints,
 long selectionTimeoutMillis)

Creates a new empty instance, using EndpointSelectionStrategy.weightedRoundRobin().

Parameters:

allowEmptyEndpoints - whether to allow an empty Endpoint list

selectionTimeoutMillis - the timeout to wait until a successful Endpoint selection. 0 disables the timeout. If unspecified, Flags.defaultConnectTimeoutMillis() is used by default.

DynamicEndpointGroup

protected DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy,
 boolean allowEmptyEndpoints)

Creates a new empty instance.

Parameters:

selectionStrategy - the EndpointSelectionStrategy of this EndpointGroup

allowEmptyEndpoints - whether to allow an empty Endpoint list

DynamicEndpointGroup

protected DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy,
 boolean allowEmptyEndpoints,
 long selectionTimeoutMillis)

Creates a new empty instance.

Parameters:

selectionStrategy - the EndpointSelectionStrategy of this EndpointGroup

allowEmptyEndpoints - whether to allow an empty Endpoint list

selectionTimeoutMillis - the timeout to wait until a successful Endpoint selection. 0 disables the timeout. If unspecified, Flags.defaultConnectTimeoutMillis() is used by default.

Method Details

builder

@UnstableApi
public static DynamicEndpointGroupBuilder builder()

Returns a newly created builder.

allowsEmptyEndpoints

@UnstableApi
public boolean allowsEmptyEndpoints()

Returns whether this EndpointGroup allows an empty Endpoint list.

endpoints

public final List<Endpoint> endpoints()

Description copied from interface: EndpointGroup

Returns the endpoints held by this EndpointGroup.

Specified by:

endpoints in interface EndpointGroup

selectionStrategy

public final EndpointSelectionStrategy selectionStrategy()

Description copied from interface: EndpointGroup

Returns the EndpointSelectionStrategy of this EndpointGroup.

Specified by:

selectionStrategy in interface EndpointGroup

selectNow

public final Endpoint selectNow(ClientRequestContext ctx)

Description copied from interface: EndpointGroup

Selects an Endpoint from this EndpointGroup.

Specified by:

selectNow in interface 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

public long selectionTimeoutMillis()

Description copied from interface: EndpointGroup

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 EndpointGroup.selectNow(ClientRequestContext) should always return an Endpoint.

Specified by:

selectionTimeoutMillis in interface EndpointGroup

select

@Deprecated
public final CompletableFuture<Endpoint> select(ClientRequestContext ctx,
 ScheduledExecutorService executor,
 long timeoutMillis)

Deprecated.

Description copied from interface: EndpointSelector

Selects an Endpoint asynchronously from the EndpointGroup associated with the specified ClientRequestContext, waiting up to the specified timeoutMillis.

Specified by:

select in interface EndpointSelector

Parameters:

ctx - the ClientRequestContext of the Request being handled.

executor - the ScheduledExecutorService used for notifying the CompletableFuture being returned and scheduling timeout tasks.

timeoutMillis - the amount of milliseconds to wait until a successful Endpoint selection.

Returns:

the CompletableFuture that will be completed with the Endpoint selected by this EndpointSelector's selection strategy, or completed with null if no Endpoint was selected within the specified timeoutMillis, which can happen if the EndpointGroup is empty.

select

public final CompletableFuture<Endpoint> select(ClientRequestContext ctx,
 ScheduledExecutorService executor)

Description copied from interface: EndpointSelector

Selects an Endpoint asynchronously from the EndpointGroup associated with the specified ClientRequestContext, waiting up to the specified timeoutMillis.

Specified by:

select in interface EndpointSelector

Parameters:

ctx - the ClientRequestContext of the Request being handled.

executor - the ScheduledExecutorService used for notifying the CompletableFuture being returned and scheduling timeout tasks.

Returns:

the CompletableFuture that will be completed with the Endpoint selected by this EndpointSelector's selection strategy, or completed with null if no Endpoint was selected within the specified timeoutMillis, which can happen if the EndpointGroup is empty.

whenReady

public final CompletableFuture<List<Endpoint>> whenReady()

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

Specified by:

whenReady in interface EndpointGroup

addEndpoint

protected final void addEndpoint(Endpoint e)

Adds the specified Endpoint to current Endpoint list.

removeEndpoint

protected final void removeEndpoint(Endpoint e)

Removes the specified Endpoint from current Endpoint list.

setEndpoints

protected final void setEndpoints(Iterable<Endpoint> endpoints)

Sets the specified Endpoints as current Endpoint list.

isClosing

public final boolean isClosing()

Description copied from interface: ListenableAsyncCloseable

Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.

Specified by:

isClosing in interface ListenableAsyncCloseable

See Also:

• ListenableAsyncCloseable.isClosed()

isClosed

public final boolean isClosed()

Description copied from interface: ListenableAsyncCloseable

Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.

Specified by:

isClosed in interface ListenableAsyncCloseable

See Also:

• ListenableAsyncCloseable.isClosing()

whenClosed

public final CompletableFuture<?> whenClosed()

Description copied from interface: ListenableAsyncCloseable

Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.

Specified by:

whenClosed in interface ListenableAsyncCloseable

closeAsync

public final CompletableFuture<?> closeAsync()

Description copied from interface: AsyncCloseable

Releases any underlying resources held by this object asynchronously.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

the CompletableFuture which is completed after the resources are released

doCloseAsync

protected void doCloseAsync(CompletableFuture<?> future)

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

close

public final void close()

Description copied from interface: AsyncCloseable

Releases any underlying resources held by this object synchronously.

Specified by:

close in interface AsyncCloseable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

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>>