alluxio.retry

Class RetryUtils

java.lang.Object

alluxio.retry.RetryUtils

public final class RetryUtils
extends Object

Utilities for performing retries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RetryUtils.RunnableThrowsIOException Interface for methods which return nothing and may throw IOException.

Method Summary

Modifier and Type	Method and Description
static RetryPolicy	defaultActiveSyncClientRetry(long activeUfsPollTimeoutMs)
static RetryPolicy	defaultBlockReadRetry(java.time.Duration maxRetryDuration, java.time.Duration baseSleepMs, java.time.Duration maxSleepMs) Gives a ClientRetry based on the given parameters.
static RetryPolicy	defaultClientRetry(java.time.Duration maxRetryDuration, java.time.Duration baseSleepMs, java.time.Duration maxSleepMs) Gives a ClientRetry based on the given parameters.
static RetryPolicy	defaultFileWriteInitRetry(java.time.Duration maxRetryDuration, java.time.Duration baseSleepMs, java.time.Duration maxSleepMs) Gives a RetryPolicy for initialization of writing a file.
static RetryPolicy	defaultMetricsClientRetry()
static RetryPolicy	defaultWorkerMasterClientRetry(java.time.Duration workerMasterConnectRetryTimeout)
static RetryPolicy	noRetryPolicy()
static void	retry(String action, RetryUtils.RunnableThrowsIOException f, RetryPolicy policy) Retries the given method until it doesn't throw an IO exception or the retry policy expires.

Methods inherited from class java.lang.Object

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

Method Detail

retry

public static void retry(String action,
                         RetryUtils.RunnableThrowsIOException f,
                         RetryPolicy policy)
                  throws IOException

Retries the given method until it doesn't throw an IO exception or the retry policy expires. If the retry policy expires, the last exception generated will be rethrown.

Parameters:

action - a description of the action that fits the phrase "Failed to ${action}"

f - the function to retry

policy - the retry policy to use

Throws:

IOException

noRetryPolicy

public static RetryPolicy noRetryPolicy()

Returns:

the best effort policy with no retry

defaultClientRetry

public static RetryPolicy defaultClientRetry(java.time.Duration maxRetryDuration,
                                             java.time.Duration baseSleepMs,
                                             java.time.Duration maxSleepMs)

Gives a ClientRetry based on the given parameters.

Parameters:

maxRetryDuration - the maximum total duration to retry for

baseSleepMs - initial sleep time in milliseconds

maxSleepMs - max sleep time in milliseconds

Returns:

the default client retry

defaultWorkerMasterClientRetry

public static RetryPolicy defaultWorkerMasterClientRetry(java.time.Duration workerMasterConnectRetryTimeout)

Parameters:

workerMasterConnectRetryTimeout - the max duration to wait between retrying for worker and master

Returns:

the default worker to master client retry

defaultMetricsClientRetry

public static RetryPolicy defaultMetricsClientRetry()

Returns:

the default metrics client retry

defaultActiveSyncClientRetry

public static RetryPolicy defaultActiveSyncClientRetry(long activeUfsPollTimeoutMs)

Parameters:

activeUfsPollTimeoutMs - the max time in milliseconds to wait for active ufs sync retries

Returns:

the default active sync retry behavior

defaultBlockReadRetry

public static RetryPolicy defaultBlockReadRetry(java.time.Duration maxRetryDuration,
                                                java.time.Duration baseSleepMs,
                                                java.time.Duration maxSleepMs)

Gives a ClientRetry based on the given parameters.

Parameters:

maxRetryDuration - the maximum total duration to retry for

baseSleepMs - initial sleep time in milliseconds

maxSleepMs - max sleep time in milliseconds

Returns:

the default block-read retry

defaultFileWriteInitRetry

public static RetryPolicy defaultFileWriteInitRetry(java.time.Duration maxRetryDuration,
                                                    java.time.Duration baseSleepMs,
                                                    java.time.Duration maxSleepMs)

Gives a RetryPolicy for initialization of writing a file.

Parameters:

maxRetryDuration - the maximum total duration to retry for

baseSleepMs - initial sleep time in milliseconds

maxSleepMs - max sleep time in milliseconds

Returns:

the default block-read retry