com.linecorp.armeria.client.retry.RetryingClient

All Implemented Interfaces:: Client<HttpRequest,HttpResponse>, HttpClient, Unwrappable

public final class RetryingClient
extends AbstractRetryingClient<HttpRequest,HttpResponse>
implements HttpClient

An HttpClient decorator that handles failures of an invocation and retries HTTP requests.

Field Summary

Fields inherited from class com.linecorp.armeria.client.retry.AbstractRetryingClient
ARMERIA_RETRY_COUNT

Method Summary

Modifier and Type	Method	Description
`static RetryingClientBuilder`	`builder(RetryRule retryRule)`	Returns a new `RetryingClientBuilder` with the specified `RetryRule`.
`static RetryingClientBuilder`	`builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent)`	Returns a new `RetryingClientBuilder` with the specified `RetryRuleWithContent`.
`static RetryingClientBuilder`	`builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxContentLength)`	Returns a new `RetryingClientBuilder` with the specified `RetryRuleWithContent` and the specified `maxContentLength`.
`protected HttpResponse`	`doExecute(ClientRequestContext ctx, HttpRequest req)`	Invoked by `AbstractRetryingClient.execute(ClientRequestContext, Request)` after the deadline for response timeout is set.
`static Function<? super HttpClient,RetryingClient>`	`newDecorator(RetryRule retryRule)`	Creates a new `HttpClient` decorator that handles failures of an invocation and retries HTTP requests.
`static Function<? super HttpClient,RetryingClient>`	`newDecorator(RetryRule retryRule, int maxTotalAttempts)`	Creates a new `HttpClient` decorator that handles failures of an invocation and retries HTTP requests.
`static Function<? super HttpClient,RetryingClient>`	`newDecorator(RetryRule retryRule, int maxTotalAttempts, long responseTimeoutMillisForEachAttempt)`	Creates a new `HttpClient` decorator that handles failures of an invocation and retries HTTP requests.
`static Function<? super HttpClient,RetryingClient>`	`newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent)`	Creates a new `HttpClient` decorator with the specified `RetryRuleWithContent` that handles failures of an invocation and retries HTTP requests.
`static Function<? super HttpClient,RetryingClient>`	`newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxTotalAttempts)`	Creates a new `HttpClient` decorator with the specified `RetryRuleWithContent` that handles failures of an invocation and retries HTTP requests.
`static Function<? super HttpClient,RetryingClient>`	`newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxTotalAttempts, long responseTimeoutMillisForEachAttempt)`	Creates a new `HttpClient` decorator with the specified `RetryRuleWithContent` that handles failures of an invocation and retries HTTP requests.

Methods inherited from class com.linecorp.armeria.client.retry.AbstractRetryingClient

execute, getNextDelay, getNextDelay, getTotalAttempts, newDerivedContext, onRetryingComplete, retryRule, retryRuleWithContent, scheduleNextRetry, setResponseTimeout

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.client.Client

as, unwrap

Methods inherited from interface com.linecorp.armeria.client.HttpClient

execute

Method Details
- builder
  
  public static RetryingClientBuilder builder(RetryRule retryRule)
  
  Returns a new RetryingClientBuilder with the specified RetryRule.
- builder
  
  public static RetryingClientBuilder builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent)
  
  Returns a new RetryingClientBuilder with the specified RetryRuleWithContent.
- builder
  
  public static RetryingClientBuilder builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxContentLength)
  
  Returns a new RetryingClientBuilder with the specified RetryRuleWithContent and the specified maxContentLength. The maxContentLength required to determine whether to retry or not. If the total length of content exceeds this length and there's no retry condition matched, it will hand over the stream to the client.
  
  Throws:
  
  IllegalArgumentException - if the specified maxContentLength is equal to or less than 0
- newDecorator
  
  public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRule retryRule)
  
  Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
  
  Parameters:
  
  retryRule - the retry rule
- newDecorator
  
  public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent)
  
  Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.
  
  Parameters:
  
  retryRuleWithContent - the retry rule
- newDecorator
  
  public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRule retryRule, int maxTotalAttempts)
  
  Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
  
  Parameters:
  
  retryRule - the retry rule
  
  maxTotalAttempts - the maximum allowed number of total attempts
- newDecorator
  
  public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxTotalAttempts)
  
  Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.
  
  Parameters:
  
  retryRuleWithContent - the retry rule
  
  maxTotalAttempts - the maximum allowed number of total attempts
- newDecorator
  
  public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRule retryRule, int maxTotalAttempts, long responseTimeoutMillisForEachAttempt)
  
  Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
  
  Parameters:
  
  retryRule - the retry rule
  
  maxTotalAttempts - the maximum number of total attempts
  
  responseTimeoutMillisForEachAttempt - response timeout for each attempt. 0 disables the timeout
- newDecorator
  
  public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxTotalAttempts, long responseTimeoutMillisForEachAttempt)
  
  Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.
  
  Parameters:
  
  retryRuleWithContent - the retry rule
  
  maxTotalAttempts - the maximum number of total attempts
  
  responseTimeoutMillisForEachAttempt - response timeout for each attempt. 0 disables the timeout
- doExecute
  
  protected HttpResponse doExecute(ClientRequestContext ctx, HttpRequest req) throws Exception
  
  Description copied from class: AbstractRetryingClient
  
  Invoked by AbstractRetryingClient.execute(ClientRequestContext, Request) after the deadline for response timeout is set.
  
  Specified by:
  
  doExecute in class AbstractRetryingClient<HttpRequest,HttpResponse>
  
  Throws:
  
  Exception

Class RetryingClient

Field Summary