Package com.linecorp.armeria.client.endpoint

Class AbstractEndpointSelector

java.lang.Object

com.linecorp.armeria.client.endpoint.AbstractEndpointSelector

All Implemented Interfaces:

EndpointSelector

public abstract class AbstractEndpointSelector
extends Object
implements EndpointSelector

A skeletal EndpointSelector implementation. This abstract class implements the select(ClientRequestContext, ScheduledExecutorService) method by listening to the change events emitted by EndpointGroup specified at construction time.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEndpointSelector(EndpointGroup endpointGroup)	Creates a new instance that selects an Endpoint from the specified EndpointGroup.

Method Summary

Modifier and Type	Method	Description
protected final EndpointGroup	group()	Returns the EndpointGroup being selected by this EndpointSelector.
protected final void	initialize()	Initialize this EndpointSelector to listen to the new endpoints emitted by the EndpointGroup.
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.
protected void	updateNewEndpoints(List<Endpoint> endpoints)	Invoked when the EndpointGroup has been updated.

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

selectNow

Constructor Details

AbstractEndpointSelector

protected AbstractEndpointSelector(EndpointGroup endpointGroup)

Creates a new instance that selects an Endpoint from the specified EndpointGroup.

Method Details

group

protected final EndpointGroup group()

Returns the EndpointGroup being selected by this EndpointSelector.

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.

initialize

@UnstableApi
protected final void initialize()

Initialize this EndpointSelector to listen to the new endpoints emitted by the EndpointGroup. The new endpoints will be passed to updateNewEndpoints(List).

updateNewEndpoints

@UnstableApi
protected void updateNewEndpoints(List<Endpoint> endpoints)

Invoked when the EndpointGroup has been updated.