@NonNullByDefault

Package com.linecorp.armeria.client

Client core.

Starting points

• Clients
• ClientBuilder

Interface Summary

Interface	Description
Client<I extends Request,O extends Response>	Sends a Request to a remote Endpoint.
ClientBuilderParams	Provides the construction parameters of a client.
ClientFactory	Creates and manages clients.
ClientFactoryProvider	Creates a new ClientFactory dynamically via Java SPI (Service Provider Interface).
ClientRequestContext	Provides information about a Request, its Response and its related utilities.
ClientRequestContextCaptor	Captures the ClientRequestContexts created by the current thread.
ConnectionPoolListener	Listens to the client connection pool events.
DecoratingHttpClientFunction	A functional interface that enables building a SimpleDecoratingHttpClient with ClientBuilder.decorator(DecoratingHttpClientFunction).
DecoratingRpcClientFunction	A functional interface that enables building a SimpleDecoratingRpcClient with ClientBuilder.rpcDecorator(DecoratingRpcClientFunction).
EventLoopScheduler	A scheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
HttpClient	Sends an HttpRequest to a remote Endpoint.
RpcClient	Sends an RpcRequest to a remote Endpoint.
WebClient	An asynchronous web client.

Class Summary

Class	Description
AbstractClientOptionsBuilder	A skeletal builder implementation for ClientOptions.
AbstractRuleBuilder	A skeletal builder implementation for RetryRule, RetryRuleWithContent, CircuitBreakerRule and CircuitBreakerRuleWithContent.
AbstractRuleWithContentBuilder<T extends Response>	A skeletal builder implementation for RetryRuleWithContent and CircuitBreakerRuleWithContent.
AbstractWebClientBuilder	A skeletal builder implementation for WebClient.
ClientBuilder	Creates a new client that connects to the specified URI using the builder pattern.
ClientDecoration	A set of Functions that transforms a Client into another.
ClientDecorationBuilder	Creates a new ClientDecoration using the builder pattern.
ClientFactoryBuilder	Builds a new ClientFactory.
ClientFactoryOption<T>	A ClientFactory option.
ClientFactoryOptions	A set of ClientFactoryOptions and their respective values.
ClientFactoryOptionValue<T>	A value of a ClientFactoryOption.
ClientOption<T>	A client option.
ClientOptions	A set of ClientOptions and their respective values.
ClientOptionsBuilder	Creates a new ClientOptions using the builder pattern.
ClientOptionValue<T>	A value of a ClientOption.
ClientRequestContextBuilder	Builds a new ClientRequestContext.
ClientRequestContextWrapper	Wraps an existing ClientRequestContext.
Clients	Creates a new client that connects to a specified URI.
ConnectionPoolListenerAdapter	A skeletal ConnectionPoolListener implementation in order for a user to implement only the methods what he or she really needs.
ConnectionPoolListenerWrapper	A ConnectionPoolListener that wraps an existing ConnectionPoolListener.
DecoratingClient<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response>	Decorates a Client.
DecoratingClientFactory	A ClientFactory that delegates the creation of Clients to another ClientFactory.
DefaultClientRequestContext	Default ClientRequestContext implementation.
DnsResolverGroupBuilder	Builds an AddressResolverGroup which builds AddressResolvers that update DNS caches automatically.
Endpoint	A remote endpoint that refers to a single host.
SessionProtocolNegotiationCache	Keeps the recent SessionProtocol negotiation failures.
SimpleDecoratingClient<I extends Request,O extends Response>	Decorates a Client.
SimpleDecoratingHttpClient	Decorates an HttpClient.
SimpleDecoratingRpcClient	Decorates an RpcClient.
UserClient<I extends Request,O extends Response>	A base class for implementing a user's entry point for sending a Request.
WebClientBuilder	Creates a new web client that connects to the specified URI using the builder pattern.

Exception Summary

Exception	Description
DnsTimeoutException	A TimeoutException raised when a response has not been received from a DNS server within timeout.
GoAwayReceivedException	A RuntimeException raised when a server sent an HTTP/2 GOAWAY frame with the lastStreamId less then the stream ID of the request.
InvalidResponseException	A RuntimeException raised when a client received an invalid response.
InvalidResponseHeadersException	An InvalidResponseException raised when a client received a response with invalid headers.
RefusedStreamException	A RuntimeException raised when a server set HTTP/2 MAX_CONCURRENT_STREAMS to 0, which means a client can't send anything.
ResponseTimeoutException	A TimeoutException raised when a response has not been received from a server within timeout.
SessionProtocolNegotiationException	An exception triggered when failed to negotiate the desired SessionProtocol with a server.
UnprocessedRequestException	A RuntimeException raised when it is certain that a request has not been handled by a server and thus can be retried safely.
WriteTimeoutException	A TimeoutException raised when a client failed to send a request to the wire within timeout.