| Package | Description |
|---|---|
| com.linecorp.armeria.client |
Client core.
|
| com.linecorp.armeria.client.endpoint |
Endpoint groups and their registry. |
| com.linecorp.armeria.client.endpoint.dns |
DNS-based
EndpointGroup implementation. |
| com.linecorp.armeria.client.endpoint.healthcheck |
Filters out unhealthy
Endpoints from an existing
EndpointGroup by sending health check requests. |
| com.linecorp.armeria.internal.client |
Various classes used internally.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Endpoint
A remote endpoint that refers to a single host.
|
| Modifier and Type | Field and Description |
|---|---|
static ClientOption<Function<? super Endpoint,? extends EndpointGroup>> |
ClientOption.ENDPOINT_REMAPPER
|
| Modifier and Type | Method and Description |
|---|---|
EndpointGroup |
UserClient.endpointGroup() |
EndpointGroup |
DefaultClientRequestContext.endpointGroup() |
EndpointGroup |
ClientRequestContextWrapper.endpointGroup() |
EndpointGroup |
ClientRequestContext.endpointGroup()
Returns the
EndpointGroup used for the current Request. |
EndpointGroup |
ClientBuilderParams.endpointGroup()
Returns the
EndpointGroup of the client. |
| Modifier and Type | Method and Description |
|---|---|
Function<? super Endpoint,? extends EndpointGroup> |
ClientOptions.endpointRemapper()
|
| Modifier and Type | Method and Description |
|---|---|
static ClientBuilder |
Clients.builder(Scheme scheme,
EndpointGroup endpointGroup)
Returns a new
ClientBuilder that builds the client that connects to the specified
EndpointGroup with the Scheme. |
static WebClientBuilder |
WebClient.builder(SessionProtocol sessionProtocol,
EndpointGroup endpointGroup)
|
static ClientBuilder |
Clients.builder(SessionProtocol protocol,
EndpointGroup endpointGroup)
Returns a new
ClientBuilder that builds the client that connects to the specified
EndpointGroup with the SessionProtocol. |
static ClientBuilder |
Clients.builder(String scheme,
EndpointGroup endpointGroup)
Returns a new
ClientBuilder that builds the client that connects to the specified
EndpointGroup with the scheme. |
protected O |
UserClient.execute(EndpointGroup endpointGroup,
HttpMethod method,
String path,
String query,
String fragment,
I req,
BiFunction<ClientRequestContext,Throwable,O> fallback)
Executes the specified
Request via AbstractUnwrappable.delegate(). |
boolean |
DefaultClientRequestContext.init(EndpointGroup endpointGroup)
Initializes this context with the specified
EndpointGroup. |
static <T> T |
Clients.newClient(ClientFactory factory,
Scheme scheme,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptions options)
|
static <T> T |
Clients.newClient(ClientFactory factory,
Scheme scheme,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptionValue<?>... options)
|
static <T> T |
Clients.newClient(ClientFactory factory,
SessionProtocol protocol,
SerializationFormat format,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptions options)
|
static <T> T |
Clients.newClient(ClientFactory factory,
SessionProtocol protocol,
SerializationFormat format,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptionValue<?>... options)
|
static <T> T |
Clients.newClient(Scheme scheme,
EndpointGroup endpointGroup,
Class<T> clientType)
Creates a new client that connects to the specified
EndpointGroup with the Scheme using
the default ClientFactory. |
static <T> T |
Clients.newClient(Scheme scheme,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptions options)
Deprecated.
|
static <T> T |
Clients.newClient(Scheme scheme,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptionValue<?>... options)
Deprecated.
|
static <T> T |
Clients.newClient(SessionProtocol protocol,
EndpointGroup endpointGroup,
Class<T> clientType)
Creates a new client that connects to the specified
EndpointGroup with
the SessionProtocol using the default ClientFactory. |
static <T> T |
Clients.newClient(SessionProtocol protocol,
SerializationFormat format,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptions options)
Deprecated.
|
static <T> T |
Clients.newClient(SessionProtocol protocol,
SerializationFormat format,
EndpointGroup endpointGroup,
Class<T> clientType,
ClientOptionValue<?>... options)
Deprecated.
|
static <T> T |
Clients.newClient(String scheme,
EndpointGroup endpointGroup,
Class<T> clientType)
Creates a new client that connects to the specified
EndpointGroup with the scheme using
the default ClientFactory. |
static WebClient |
WebClient.of(ClientFactory factory,
SessionProtocol protocol,
EndpointGroup endpointGroup,
ClientOptions options)
|
static WebClient |
WebClient.of(ClientFactory factory,
SessionProtocol protocol,
EndpointGroup endpointGroup,
ClientOptionValue<?>... options)
|
static ClientBuilderParams |
ClientBuilderParams.of(Scheme scheme,
EndpointGroup endpointGroup,
String path,
Class<?> type,
ClientOptions options)
Returns a newly created
ClientBuilderParams from the specified properties. |
static WebClient |
WebClient.of(SessionProtocol protocol,
EndpointGroup endpointGroup)
Returns a new
WebClient that connects to the specified EndpointGroup with
the SessionProtocol using the default ClientFactory and the default
ClientOptions. |
static WebClient |
WebClient.of(SessionProtocol protocol,
EndpointGroup endpointGroup,
ClientOptions options)
Deprecated.
|
static WebClient |
WebClient.of(SessionProtocol protocol,
EndpointGroup endpointGroup,
ClientOptionValue<?>... options)
|
| Modifier and Type | Method and Description |
|---|---|
WebClientBuilder |
WebClientBuilder.endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper) |
ClientOptionsBuilder |
ClientOptionsBuilder.endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper) |
ClientBuilder |
ClientBuilder.endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper) |
| Modifier and Type | Class and Description |
|---|---|
class |
DynamicEndpointGroup
A dynamic
EndpointGroup. |
class |
PropertiesEndpointGroup
A
Properties backed EndpointGroup. |
| Modifier and Type | Method and Description |
|---|---|
static EndpointGroup |
EndpointGroup.empty()
Returns a singleton
EndpointGroup which does not contain any Endpoints. |
static EndpointGroup |
EndpointGroup.of(EndpointGroup... endpointGroups)
|
static EndpointGroup |
EndpointGroup.of(EndpointSelectionStrategy selectionStrategy,
EndpointGroup... endpointGroups)
|
static EndpointGroup |
EndpointGroup.of(EndpointSelectionStrategy selectionStrategy,
Iterable<? extends EndpointGroup> endpointGroups)
|
static EndpointGroup |
EndpointGroup.of(Iterable<? extends EndpointGroup> endpointGroups)
|
default EndpointGroup |
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. |
| Modifier and Type | Method and Description |
|---|---|
EndpointSelector |
StickyEndpointSelectionStrategy.newSelector(EndpointGroup endpointGroup)
Creates a new
StickyEndpointSelector. |
EndpointSelector |
EndpointSelectionStrategy.newSelector(EndpointGroup endpointGroup)
|
static EndpointGroup |
EndpointGroup.of(EndpointGroup... endpointGroups)
|
static EndpointGroup |
EndpointGroup.of(EndpointSelectionStrategy selectionStrategy,
EndpointGroup... endpointGroups)
|
default EndpointGroup |
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. |
| Modifier and Type | Method and Description |
|---|---|
static EndpointGroup |
EndpointGroup.of(EndpointSelectionStrategy selectionStrategy,
Iterable<? extends EndpointGroup> endpointGroups)
|
static EndpointGroup |
EndpointGroup.of(Iterable<? extends EndpointGroup> endpointGroups)
|
| Modifier and Type | Class and Description |
|---|---|
class |
DnsAddressEndpointGroup
|
class |
DnsServiceEndpointGroup
DynamicEndpointGroup which resolves targets using DNS
SRV records. |
class |
DnsTextEndpointGroup
DynamicEndpointGroup which resolves targets using DNS TXT records. |
| Modifier and Type | Class and Description |
|---|---|
class |
HealthCheckedEndpointGroup
An
EndpointGroup that filters out unhealthy Endpoints from an existing EndpointGroup,
by sending periodic health check requests. |
| Modifier and Type | Method and Description |
|---|---|
static HealthCheckedEndpointGroupBuilder |
HealthCheckedEndpointGroup.builder(EndpointGroup delegate,
String path)
Returns a newly created
HealthCheckedEndpointGroupBuilder that builds
a HealthCheckedEndpointGroup which sends HTTP HEAD health check requests. |
static HealthCheckedEndpointGroup |
HealthCheckedEndpointGroup.of(EndpointGroup delegate,
String path)
Returns a newly created
HealthCheckedEndpointGroup that sends HTTP HEAD health check
requests with default options. |
| Constructor and Description |
|---|
AbstractHealthCheckedEndpointGroupBuilder(EndpointGroup delegate)
Creates a new
AbstractHealthCheckedEndpointGroupBuilder. |
| Modifier and Type | Method and Description |
|---|---|
static <I extends Request,O extends Response,U extends Client<I,O>> |
ClientUtil.initContextAndExecuteWithFallback(U delegate,
DefaultClientRequestContext ctx,
EndpointGroup endpointGroup,
BiFunction<ClientRequestContext,Throwable,O> fallback) |
Copyright © 2020 LeanCloud. All rights reserved.