Package com.linecorp.armeria.client.retry

Class RetryConfig<T extends Response>

java.lang.Object

com.linecorp.armeria.client.retry.RetryConfig<T>

public final class RetryConfig<T extends Response>
extends Object

Holds retry config used by a RetryingClient. A RetryConfig instance encapsulates the used RetryRule, maxTotalAttempts, and responseTimeoutMillisForEachAttempt.

Method Summary

Modifier and Type	Method	Description
static RetryConfigBuilder<HttpResponse>	builder(RetryRule retryRule)	Returns a new RetryConfigBuilder with the specified RetryRule.
static RetryConfigBuilder<HttpResponse>	builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent)	Returns a new RetryConfigBuilder with the specified RetryRuleWithContent.
static RetryConfigBuilder<RpcResponse>	builderForRpc(RetryRule retryRule)	Returns a new RetryConfigBuilder with the specified RetryRule.
static RetryConfigBuilder<RpcResponse>	builderForRpc(RetryRuleWithContent<RpcResponse> retryRuleWithContent)	Returns a new RetryConfigBuilder with the specified RetryRuleWithContent.
int	maxContentLength()	Returns the maxContentLength, which is non-zero only if a RetryRuleWithContent is used.
int	maxTotalAttempts()	Returns the maximum allowed number of total attempts made by a RetryingClient.
boolean	needsContentInRule()	Returns whether a RetryRuleWithContent is being used.
boolean	requiresResponseTrailers()	Returns whether the associated RetryRule or RetryRuleWithContent requires response trailers.
long	responseTimeoutMillisForEachAttempt()	Returns the response timeout for each attempt in milliseconds.
@Nullable RetryRule	retryRule()	Returns the RetryRule which was specified with builder(RetryRule).
@Nullable RetryRuleWithContent<T>	retryRuleWithContent()	Returns the RetryRuleWithContent which was specified with builder(RetryRuleWithContent).
RetryConfigBuilder<T>	toBuilder()	Converts this RetryConfig to a mutable RetryConfigBuilder.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static RetryConfigBuilder<HttpResponse> builder(RetryRule retryRule)

Returns a new RetryConfigBuilder with the specified RetryRule.

builder

public static RetryConfigBuilder<HttpResponse> builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent)

Returns a new RetryConfigBuilder with the specified RetryRuleWithContent.

builderForRpc

public static RetryConfigBuilder<RpcResponse> builderForRpc(RetryRule retryRule)

Returns a new RetryConfigBuilder with the specified RetryRule.

builderForRpc

public static RetryConfigBuilder<RpcResponse> builderForRpc(RetryRuleWithContent<RpcResponse> retryRuleWithContent)

Returns a new RetryConfigBuilder with the specified RetryRuleWithContent.

toBuilder

public RetryConfigBuilder<T> toBuilder()

Converts this RetryConfig to a mutable RetryConfigBuilder.

maxTotalAttempts

public int maxTotalAttempts()

Returns the maximum allowed number of total attempts made by a RetryingClient.

responseTimeoutMillisForEachAttempt

public long responseTimeoutMillisForEachAttempt()

Returns the response timeout for each attempt in milliseconds. When requests in RetryingClient are made, corresponding responses are timed out by this value.

retryRule

@Nullable
public @Nullable RetryRule retryRule()

Returns the RetryRule which was specified with builder(RetryRule).

retryRuleWithContent

@Nullable
public @Nullable RetryRuleWithContent<T> retryRuleWithContent()

Returns the RetryRuleWithContent which was specified with builder(RetryRuleWithContent).

maxContentLength

public int maxContentLength()

Returns the maxContentLength, which is non-zero only if a RetryRuleWithContent is used.

needsContentInRule

public boolean needsContentInRule()

Returns whether a RetryRuleWithContent is being used.

requiresResponseTrailers

public boolean requiresResponseTrailers()

Returns whether the associated RetryRule or RetryRuleWithContent requires response trailers.