com.rt.storage.api.client.util.BackOff Maven / Gradle / Ivy
package com.rt.storage.api.client.util;
import java.io.IOException;
/**
* Back-off policy when retrying an operation.
*
* @since 1.15
* @author Ravi Mistry
*/
public interface BackOff {
/** Indicates that no more retries should be made for use in {@link #nextBackOffMillis()}. */
static final long STOP = -1L;
/** Reset to initial state. */
void reset() throws IOException;
/**
* Gets the number of milliseconds to wait before retrying the operation or {@link #STOP} to
* indicate that no retries should be made.
*
* Example usage:
*
*
* long backOffMillis = backoff.nextBackOffMillis();
* if (backOffMillis == Backoff.STOP) {
* // do not retry operation
* } else {
* // sleep for backOffMillis milliseconds and retry operation
* }
*
*/
long nextBackOffMillis() throws IOException;
/**
* Fixed back-off policy whose back-off time is always zero, meaning that the operation is retried
* immediately without waiting.
*/
BackOff ZERO_BACKOFF =
new BackOff() {
public void reset() throws IOException {}
public long nextBackOffMillis() throws IOException {
return 0;
}
};
/**
* Fixed back-off policy that always returns {@code #STOP} for {@link #nextBackOffMillis()},
* meaning that the operation should not be retried.
*/
BackOff STOP_BACKOFF =
new BackOff() {
public void reset() throws IOException {}
public long nextBackOffMillis() throws IOException {
return STOP;
}
};
}