Package com.linecorp.armeria.client
Client core.
Starting points
-
Interface Summary Interface Description Client<I extends Request,O extends Response> ClientBuilderParams Provides the construction parameters of a client.ClientFactory Creates and manages clients.ClientFactoryProvider Creates a newClientFactory
dynamically via Java SPI (Service Provider Interface).ClientRequestContext ClientRequestContextCaptor Captures theClientRequestContext
s created by the current thread.ConnectionPoolListener Listens to the client connection pool events.DecoratingHttpClientFunction A functional interface that enables building aSimpleDecoratingHttpClient
withClientBuilder.decorator(DecoratingHttpClientFunction)
.DecoratingRpcClientFunction A functional interface that enables building aSimpleDecoratingRpcClient
withClientBuilder.rpcDecorator(DecoratingRpcClientFunction)
.EventLoopScheduler HttpClient Sends anHttpRequest
to a remoteEndpoint
.RequestOptions ARequestOptions
for anHttpRequest
.RpcClient Sends anRpcRequest
to a remoteEndpoint
.WebClient An asynchronous web client. -
Class Summary Class Description AbstractClientOptionsBuilder A skeletal builder implementation forClientOptions
.AbstractRuleBuilder A skeletal builder implementation forRetryRule
,RetryRuleWithContent
,CircuitBreakerRule
andCircuitBreakerRuleWithContent
.AbstractRuleWithContentBuilder<T extends Response> A skeletal builder implementation forRetryRuleWithContent
andCircuitBreakerRuleWithContent
.AbstractWebClientBuilder A skeletal builder implementation forWebClient
.ClientBuilder Creates a new client that connects to the specifiedURI
using the builder pattern.ClientDecoration ClientDecorationBuilder Creates a newClientDecoration
using the builder pattern.ClientFactoryBuilder Builds a newClientFactory
.ClientFactoryOption<T> AClientFactory
option.ClientFactoryOptions A set ofClientFactoryOption
s and their respective values.ClientFactoryOptionValue<T> A value of aClientFactoryOption
.ClientOption<T> A client option.ClientOptions A set ofClientOption
s and their respective values.ClientOptionsBuilder Creates a newClientOptions
using the builder pattern.ClientOptionValue<T> A value of aClientOption
.ClientRequestContextBuilder Builds a newClientRequestContext
.ClientRequestContextWrapper Wraps an existingClientRequestContext
.Clients Creates a new client that connects to a specifiedURI
.ConnectionPoolListenerAdapter A skeletalConnectionPoolListener
implementation in order for a user to implement only the methods what he or she really needs.ConnectionPoolListenerWrapper AConnectionPoolListener
that wraps an existingConnectionPoolListener
.DecoratingClient<T_I extends Request,T_O extends Response,R_I extends Request,R_O extends Response> Decorates aClient
.DecoratingClientFactory DefaultClientRequestContext DefaultClientRequestContext
implementation.DnsResolverGroupBuilder Builds anAddressResolverGroup
which buildsAddressResolver
s that update DNS caches automatically.Endpoint A remote endpoint that refers to a single host.RequestOptionsBuilder A builder for creating a newRequestOptions
.SessionProtocolNegotiationCache Keeps the recentSessionProtocol
negotiation failures.SimpleDecoratingClient<I extends Request,O extends Response> Decorates aClient
.SimpleDecoratingHttpClient Decorates anHttpClient
.SimpleDecoratingRpcClient Decorates anRpcClient
.UserClient<I extends Request,O extends Response> A base class for implementing a user's entry point for sending aRequest
.WebClientBuilder Creates a new web client that connects to the specifiedURI
using the builder pattern.WebClientRequestPreparation Prepares and executes a newHttpRequest
forWebClient
. -
Exception Summary Exception Description DnsTimeoutException ATimeoutException
raised when a response has not been received from a DNS server within timeout.GoAwayReceivedException ARuntimeException
raised when a server sent an HTTP/2 GOAWAY frame with thelastStreamId
less then the stream ID of the request.InvalidResponseException ARuntimeException
raised when a client received an invalid response.InvalidResponseHeadersException AnInvalidResponseException
raised when a client received a response with invalid headers.RefusedStreamException ARuntimeException
raised when a server set HTTP/2MAX_CONCURRENT_STREAMS
to 0, which means a client can't send anything.ResponseCancellationException ACancellationException
raised when a response is cancelled by the user.ResponseTimeoutException ATimeoutException
raised when a response has not been received from a server within timeout.SessionProtocolNegotiationException An exception triggered when failed to negotiate the desiredSessionProtocol
with a server.UnprocessedRequestException ARuntimeException
raised when it is certain that a request has not been handled by a server and thus can be retried safely.WriteTimeoutException ATimeoutException
raised when a client failed to send a request to the wire within timeout.