org.apache.gobblin.util

Class ExponentialBackoff

java.lang.Object

org.apache.gobblin.util.ExponentialBackoff

public class ExponentialBackoff
extends Object

Utility class for exponential backoff. Usage: ExponentialBackoff exponentialBackoff = ExponentialBackoff.builder().build(); exponentialBackoff.awaitNextRetry();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExponentialBackoff.NoMoreRetriesException Thrown if no more retries are available for ExponentialBackoff.

Method Summary

Modifier and Type	Method and Description
void	awaitNextRetry() Block until next retry can be executed.
boolean	awaitNextRetryIfAvailable() Block until next retry can be executed unless max retries has been reached.

Methods inherited from class java.lang.Object

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

Method Detail

awaitNextRetry

public void awaitNextRetry()
                    throws InterruptedException,
                           ExponentialBackoff.NoMoreRetriesException

Block until next retry can be executed. This method throws an exception if the max number of retries has been reached. For an alternative see awaitNextRetryIfAvailable().

Throws:

ExponentialBackoff.NoMoreRetriesException - If maximum number of retries has been reached.

InterruptedException

awaitNextRetryIfAvailable

public boolean awaitNextRetryIfAvailable()
                                  throws InterruptedException

Block until next retry can be executed unless max retries has been reached. This method uses the return value to specify if a retry is allowed, which the caller should respect. For an alternative see awaitNextRetry().

Returns:

true if the next execution can be run, false if the max number of retries has been reached.

Throws:

InterruptedException