BackoffPolicy

A RetryPolicy used to gradually back-off from retries of an operation. This class is flexible enough to handle most common retry schemes, such as constantly retrying for a given amount of time or exponentially backing-off.

Examples

Retry every 30 seconds for up to 5 minutes

BackoffPolicy(30.seconds, BackoffMultiplier.Constant, maxTime = Some(5.minutes), immediateFirstAttempt = false)

Immediately retry once, then backoff exponentially starting at 100 milliseconds, doubling with every attempt until the interval in between attempts is 5 seconds

BackoffPolicy(100.milliseconds, BackoffMultiplier.Exponential(5.seconds))

baseBackoff: The base value to use for backing off. This may be used by the multiplier
multiplier: The multiplier that will be applied to the baseBackoff
maxTime: The maximim amount of time to allow for retrying
maxTries: The maximum number of attempts to make
immediateFirstAttempt: Whether the first retry attempt should be immediate or use the given backoff and multiplier

Linear Supertypes

Serializable, Serializable, Product, Equals, RetryPolicy, AnyRef, Any

Instance Constructors

new BackoffPolicy(baseBackoff: FiniteDuration, multiplier: BackoffMultiplier, maxTime: Option[FiniteDuration] = scala.None, maxTries: Option[Int] = scala.None, immediateFirstAttempt: Boolean = true)

baseBackoff
The base value to use for backing off. This may be used by the multiplier
multiplier
The multiplier that will be applied to the baseBackoff
maxTime
The maximim amount of time to allow for retrying
maxTries
The maximum number of attempts to make
immediateFirstAttempt
Whether the first retry attempt should be immediate or use the given backoff and multiplier

Type Members

class BackoffIncident extends RetryIncident

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val baseBackoff: FiniteDuration

The base value to use for backing off.
The base value to use for backing off. This may be used by the multiplier
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val immediateFirstAttempt: Boolean

Whether the first retry attempt should be immediate or use the given backoff and multiplier
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxTime: Option[FiniteDuration]

The maximim amount of time to allow for retrying
val maxTries: Option[Int]

The maximum number of attempts to make
val multiplier: BackoffMultiplier

The multiplier that will be applied to the baseBackoff
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def start(): BackoffIncident

Definition Classes
BackoffPolicy → RetryPolicy
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

case class BackoffPolicy(baseBackoff: FiniteDuration, multiplier: BackoffMultiplier, maxTime: Option[FiniteDuration] = scala.None, maxTries: Option[Int] = scala.None, immediateFirstAttempt: Boolean = true) extends RetryPolicy with Product with Serializable

Examples

Instance Constructors

new BackoffPolicy(baseBackoff: FiniteDuration, multiplier: BackoffMultiplier, maxTime: Option[FiniteDuration] = scala.None, maxTries: Option[Int] = scala.None, immediateFirstAttempt: Boolean = true)

Type Members

class BackoffIncident extends RetryIncident

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val baseBackoff: FiniteDuration

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val immediateFirstAttempt: Boolean

final def isInstanceOf[T0]: Boolean

val maxTime: Option[FiniteDuration]

val maxTries: Option[Int]

val multiplier: BackoffMultiplier

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def start(): BackoffIncident

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RetryPolicy

Inherited from AnyRef

Inherited from Any

Ungrouped