Package com.linecorp.armeria.client.endpoint

Interface EndpointSelector

All Known Subinterfaces:

EndpointGroup

All Known Implementing Classes:

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

public interface EndpointSelector

Selects an Endpoint from an EndpointGroup.

Method Summary

Modifier and Type	Method	Description
default 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.
CompletableFuture<Endpoint>	select(ClientRequestContext ctx, ScheduledExecutorService executor, long timeoutMillis)	Deprecated. Use select(ClientRequestContext, ScheduledExecutorService) with EndpointGroup.selectionTimeoutMillis().
@Nullable Endpoint	selectNow(ClientRequestContext ctx)	Selects an Endpoint from the EndpointGroup associated with the specified ClientRequestContext.

Method Details

selectNow

@Nullable
@Nullable Endpoint selectNow(ClientRequestContext ctx)

Selects an Endpoint from the EndpointGroup associated with the specified ClientRequestContext.

Returns:

the Endpoint selected by this EndpointSelector's selection strategy, or null if no Endpoint was selected, which can happen if the EndpointGroup is empty.

select

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

Deprecated.

Use select(ClientRequestContext, ScheduledExecutorService) with EndpointGroup.selectionTimeoutMillis().

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

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

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

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.