com.linecorp.armeria.client.retry

Interface RetryStrategy<I extends Request,O extends Response>

Type Parameters:

I - the request type

O - the response type

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RetryStrategy<I extends Request,O extends Response>

Determines whether a failed request should be retried.

Method Summary

Modifier and Type	Method and Description
static <I extends Request,O extends Response> RetryStrategy<I,O>	never() A RetryStrategy that defines a retry should not be performed.
static RetryStrategy<HttpRequest,HttpResponse>	onStatus(HttpStatus... retryStatuses) Returns the RetryStrategy that decides to retry the request using HTTP statuses.
static RetryStrategy<HttpRequest,HttpResponse>	onStatus(Iterable<HttpStatus> retryStatuses) Returns the RetryStrategy that decides to retry the request using HTTP statuses.
CompletableFuture<Boolean>	shouldRetry(I request, O response) Returns CompletableFuture that contains a Boolean flag which indicates whether RetryingClient needs to retry or not.
default boolean	shouldRetry(I request, Throwable thrown) Returns whether an exception should be retried according to the given request and response.

Method Detail

never

static <I extends Request,O extends Response> RetryStrategy<I,O> never()

A RetryStrategy that defines a retry should not be performed.

onStatus

static RetryStrategy<HttpRequest,HttpResponse> onStatus(HttpStatus... retryStatuses)

Returns the RetryStrategy that decides to retry the request using HTTP statuses.

onStatus

static RetryStrategy<HttpRequest,HttpResponse> onStatus(Iterable<HttpStatus> retryStatuses)

Returns the RetryStrategy that decides to retry the request using HTTP statuses.

shouldRetry

CompletableFuture<Boolean> shouldRetry(I request,
                                       O response)

Returns CompletableFuture that contains a Boolean flag which indicates whether RetryingClient needs to retry or not.

If an Exception occurs while processing Request and Response, this method should not complete the CompletableFuture with the Exception. The Exception needs to be dealt in the shouldRetry(Request, Throwable) method, and the CompletableFuture has to be completed with false.

shouldRetry

default boolean shouldRetry(I request,
                            Throwable thrown)

Returns whether an exception should be retried according to the given request and response.