RetrySettings

A Retry Settings class for configuring a Retry

Retry functionality requires each element passing through is uniquely identifiable for retrying, so it requires a Context, of any type carried along with the flow's input and output element as a Tuple2 (Scala) or Pair (Java). The requirement is that either the Context type itself or a mapping from Context should be able to uniquely identify each element passing through flow.

Here are the ways a unique id can be provided:

Context itself is a type that can be used as a unique id, e.g., Int, Long, java.util.UUID
Context extends UniqueId.Provider and implements UniqueId.Provider.uniqueId method
Context is of type UniqueId.Envelope
Context can be mapped to a unique id by calling

uniqueIdMapper

In: the type of elements pulled from upstream along with the Context
Out: the type of the elements that are pushed to downstream along with the Context
Context: the type of the context that is carried along with the elements.
returns: a RetrySettings with specified values

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val delay: FiniteDuration

to delay between retrying each failed element.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val exponentialBackoffFactor: Double

exponential amount the delay duration will be increased upon each retry
val failureDecider: Option[(Try[Out]) ⇒ Boolean]

function to determine if an element passed by the joined Flow is actually a failure or not
def finalize(): Unit

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

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val max: Int

maximum number of retry attempts on any failures before giving up.
val maxDelay: FiniteDuration

maximum delay duration for retry.
val maxWaitingRetries: Option[Int]

maximum number of elements waiting to be retried.
maximum number of elements waiting to be retried. Defaults to stream internal buffer size.
val metricRegistry: Option[MetricRegistry]
val name: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val uniqueIdMapper: Option[(Context) ⇒ Any]

function that maps Context to a unique id
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( ... )
def withDelay(delay: FiniteDuration): RetrySettings[In, Out, Context]
def withExponentialBackoff(exponentialBackoffFactor: Double): RetrySettings[In, Out, Context]
def withFailureDecider(failureDecider: Function[Try[Out], Boolean]): RetrySettings[In, Out, Context]

Java API
def withFailureDecider(failureDecider: (Try[Out]) ⇒ Boolean): RetrySettings[In, Out, Context]
def withMaxDelay(maxDelay: FiniteDuration): RetrySettings[In, Out, Context]
def withMaxWaitingRetries(max: Int): RetrySettings[In, Out, Context]
def withMetrics(name: String)(implicit system: ActorSystem): RetrySettings[In, Out, Context]
def withUniqueIdMapper(uniqueIdMapper: (Context) ⇒ Any): RetrySettings[In, Out, Context]

Related Docs: object RetrySettings | package streams

case class RetrySettings[In, Out, Context] extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val delay: FiniteDuration

final def eq(arg0: AnyRef): Boolean

val exponentialBackoffFactor: Double

val failureDecider: Option[(Try[Out]) ⇒ Boolean]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val max: Int

val maxDelay: FiniteDuration

val maxWaitingRetries: Option[Int]

val metricRegistry: Option[MetricRegistry]

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val uniqueIdMapper: Option[(Context) ⇒ Any]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withDelay(delay: FiniteDuration): RetrySettings[In, Out, Context]

def withExponentialBackoff(exponentialBackoffFactor: Double): RetrySettings[In, Out, Context]

def withFailureDecider(failureDecider: Function[Try[Out], Boolean]): RetrySettings[In, Out, Context]

def withFailureDecider(failureDecider: (Try[Out]) ⇒ Boolean): RetrySettings[In, Out, Context]

def withMaxDelay(maxDelay: FiniteDuration): RetrySettings[In, Out, Context]

def withMaxWaitingRetries(max: Int): RetrySettings[In, Out, Context]

def withMetrics(name: String)(implicit system: ActorSystem): RetrySettings[In, Out, Context]

def withUniqueIdMapper(uniqueIdMapper: (Context) ⇒ Any): RetrySettings[In, Out, Context]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped