com.mapbox.services.android.telemetry.backoff

Class ExponentialBackoff

java.lang.Object

com.mapbox.services.android.telemetry.backoff.ExponentialBackoff

public class ExponentialBackoff
extends java.lang.Object

Simplified version of Google HTTP Client Library for Java's ExponentialBackOff. https://developers.google.com/api-client-library/java/google-http-java-client/backoff In this version, the interval creation is deterministic and has no concept of maxElapsedTimeMillis, it's up to the application to stop. It also adjusts its default values.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INITIAL_INTERVAL_MILLIS The default initial interval value in milliseconds (10 seconds).
static int	DEFAULT_MAX_INTERVAL_MILLIS The default maximum back off time in milliseconds (10 minutes).
static double	DEFAULT_MULTIPLIER The default multiplier value (2.0 which is 100% increase per back off).

Constructor Summary

Constructors

Constructor and Description
ExponentialBackoff()

Method Summary

Modifier and Type	Method and Description
int	getCurrentIntervalMillis() Returns the current retry interval in milliseconds.
long	getElapsedTimeMillis() Returns the elapsed time in milliseconds since an ExponentialBackoff instance is created and is reset when reset() is called.
int	getInitialIntervalMillis() Returns the initial retry interval in milliseconds.
int	getMaxIntervalMillis() Returns the maximum value of the back off period in milliseconds.
double	getMultiplier() Returns the value to multiply the current interval with for each retry attempt.
long	nextBackOffMillis() Get the next back off interval
void	reset() Sets the interval back to the initial retry interval and restarts the timer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INITIAL_INTERVAL_MILLIS

public static final int DEFAULT_INITIAL_INTERVAL_MILLIS

The default initial interval value in milliseconds (10 seconds).

See Also:

Constant Field Values

DEFAULT_MULTIPLIER

public static final double DEFAULT_MULTIPLIER

The default multiplier value (2.0 which is 100% increase per back off).

See Also:

Constant Field Values

DEFAULT_MAX_INTERVAL_MILLIS

public static final int DEFAULT_MAX_INTERVAL_MILLIS

The default maximum back off time in milliseconds (10 minutes).

See Also:

Constant Field Values

Constructor Detail

ExponentialBackoff

public ExponentialBackoff()

Method Detail

reset

public final void reset()

Sets the interval back to the initial retry interval and restarts the timer.

nextBackOffMillis

public long nextBackOffMillis()

Get the next back off interval

getInitialIntervalMillis

public final int getInitialIntervalMillis()

Returns the initial retry interval in milliseconds.

getCurrentIntervalMillis

public final int getCurrentIntervalMillis()

Returns the current retry interval in milliseconds.

getMultiplier

public final double getMultiplier()

Returns the value to multiply the current interval with for each retry attempt.

getMaxIntervalMillis

public final int getMaxIntervalMillis()

Returns the maximum value of the back off period in milliseconds. Once the current interval reaches this value it stops increasing.

getElapsedTimeMillis

public final long getElapsedTimeMillis()

Returns the elapsed time in milliseconds since an ExponentialBackoff instance is created and is reset when reset() is called.

The elapsed time is computed using System.nanoTime().