Package com.linecorp.armeria.client.retry

Class RetryingRpcClient

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<T_I,T_O>>

com.linecorp.armeria.client.DecoratingClient<I,O,I,O>

com.linecorp.armeria.client.SimpleDecoratingClient<I,O>

com.linecorp.armeria.client.retry.AbstractRetryingClient<RpcRequest,RpcResponse>

com.linecorp.armeria.client.retry.RetryingRpcClient

All Implemented Interfaces:

Client<RpcRequest,RpcResponse>, RpcClient, Unwrappable

public final class RetryingRpcClient
extends AbstractRetryingClient<RpcRequest,RpcResponse>
implements RpcClient

An RpcClient decorator that handles failures of an invocation and retries RPC requests.

Field Summary

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

ARMERIA_RETRY_COUNT

Method Summary

Modifier and Type	Method	Description
static RetryingRpcClientBuilder	builder(RetryConfig<RpcResponse> retryConfig)	Returns a new RetryingRpcClientBuilder with the specified RetryConfig.
static RetryingRpcClientBuilder	builder(RetryConfigMapping<RpcResponse> mapping)	Returns a new RetryingRpcClientBuilder with the specified RetryConfigMapping.
static RetryingRpcClientBuilder	builder(RetryRuleWithContent<RpcResponse> retryRuleWithContent)	Returns a new RetryingRpcClientBuilder with the specified RetryRuleWithContent.
protected RpcResponse	doExecute(ClientRequestContext ctx, RpcRequest req)	Invoked by AbstractRetryingClient.execute(ClientRequestContext, Request) after the deadline for response timeout is set.
static Function<? super RpcClient,RetryingRpcClient>	newDecorator(RetryConfig<RpcResponse> retryConfig)	Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.
static Function<? super RpcClient,RetryingRpcClient>	newDecorator(RetryConfigMapping<RpcResponse> mapping)	Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.
static Function<? super RpcClient,RetryingRpcClient>	newDecorator(RetryRuleWithContent<RpcResponse> retryRuleWithContent)	Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.
static Function<? super RpcClient,RetryingRpcClient>	newDecorator(RetryRuleWithContent<RpcResponse> retryRuleWithContent, int maxTotalAttempts)	Deprecated. Use newDecorator(RetryConfig) instead.
static Function<? super RpcClient,RetryingRpcClient>	newDecorator(RetryRuleWithContent<RpcResponse> retryRuleWithContent, int maxTotalAttempts, long responseTimeoutMillisForEachAttempt)	Deprecated. Use newDecorator(RetryConfig) instead.

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

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

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

as, toString, unwrap, unwrapAll

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.RpcClient

execute

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

newDecorator

public static Function<? super RpcClient,RetryingRpcClient> newDecorator(RetryRuleWithContent<RpcResponse> retryRuleWithContent)

Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.

Parameters:

retryRuleWithContent - the retry rule

newDecorator

@Deprecated
public static Function<? super RpcClient,RetryingRpcClient> newDecorator(RetryRuleWithContent<RpcResponse> retryRuleWithContent,
 int maxTotalAttempts)

Deprecated.

Use newDecorator(RetryConfig) instead.

Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.

Parameters:

retryRuleWithContent - the retry rule

maxTotalAttempts - the maximum number of total attempts

newDecorator

@Deprecated
public static Function<? super RpcClient,RetryingRpcClient> newDecorator(RetryRuleWithContent<RpcResponse> retryRuleWithContent,
 int maxTotalAttempts,
 long responseTimeoutMillisForEachAttempt)

Deprecated.

Use newDecorator(RetryConfig) instead.

Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.

Parameters:

retryRuleWithContent - 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 RpcClient,RetryingRpcClient> newDecorator(RetryConfig<RpcResponse> retryConfig)

Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests. The RetryConfig object encapsulates RetryRuleWithContent, maxContentLength, maxTotalAttempts and responseTimeoutMillisForEachAttempt.

newDecorator

public static Function<? super RpcClient,RetryingRpcClient> newDecorator(RetryConfigMapping<RpcResponse> mapping)

Creates a new RpcClient decorator that handles failures of an invocation and retries RPC requests.

Parameters:

mapping - the mapping that returns a RetryConfig for a given ClientRequestContext and Request.

builder

public static RetryingRpcClientBuilder builder(RetryRuleWithContent<RpcResponse> retryRuleWithContent)

Returns a new RetryingRpcClientBuilder with the specified RetryRuleWithContent.

builder

public static RetryingRpcClientBuilder builder(RetryConfig<RpcResponse> retryConfig)

Returns a new RetryingRpcClientBuilder with the specified RetryConfig. The RetryConfig encapsulates RetryRuleWithContent, maxContentLength, maxTotalAttempts and responseTimeoutMillisForEachAttempt.

builder

public static RetryingRpcClientBuilder builder(RetryConfigMapping<RpcResponse> mapping)

Returns a new RetryingRpcClientBuilder with the specified RetryConfigMapping.

doExecute

protected RpcResponse doExecute(ClientRequestContext ctx,
 RpcRequest 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<RpcRequest,RpcResponse>

Throws:

Exception