Package akka.stream.scaladsl

Class RestartWithBackoffSource<T>

java.lang.Object

akka.stream.stage.GraphStageWithMaterializedValue<S,NotUsed>

akka.stream.stage.GraphStage<SourceShape<T>>

akka.stream.scaladsl.RestartWithBackoffSource<T>

All Implemented Interfaces:

Graph<SourceShape<T>,NotUsed>

public final class RestartWithBackoffSource<T>
extends GraphStage<SourceShape<T>>

Wrap the given Source with a Source that will restart it when it fails using an exponential backoff.

This Source will not emit a complete or failure as long as maxRestarts is not reached, since the completion or failure of the wrapped Source is handled by restarting it. The wrapped Source can however be cancelled by cancelling this Source. When that happens, the wrapped Source, if currently running will be cancelled, and it will not be restarted. This can be triggered simply by the downstream cancelling, or externally by introducing a KillSwitch right after this Source in the graph.

This uses the same exponential backoff algorithm as Backoff.

param: minBackoff minimum (initial) duration until the child actor will started again, if it is terminated param: maxBackoff the exponential back-off is capped to this duration param: randomFactor after calculation of the exponential back-off an additional random delay based on this factor is added, e.g. 0.2 adds up to 20% delay. In order to skip this additional delay pass in 0. param: maxRestarts the amount of restarts is capped to this amount within a time frame of minBackoff. Passing 0 will cause no restarts and a negative number will not cap the amount of restarts. param: sourceFactory A factory for producing the Source to wrap.

Constructor Summary

Constructors

Constructor	Description
RestartWithBackoffSource(scala.Function0<Source<T,?>> sourceFactory, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, boolean onlyOnFailures, int maxRestarts)

Method Summary

Modifier and Type	Method	Description
RestartWithBackoffLogic<SourceShape<T>>	createLogic(Attributes inheritedAttributes)
Outlet<T>	out()
SourceShape<T>	shape()	The shape of a graph is all that is externally visible: its inlets and outlets.

Methods inherited from class akka.stream.stage.GraphStage

createLogicAndMaterializedValue

Methods inherited from class akka.stream.stage.GraphStageWithMaterializedValue

createLogicAndMaterializedValue, initialAttributes, traversalBuilder, withAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.stream.Graph

addAttributes, async, async, async, named

Constructor Detail

RestartWithBackoffSource

public RestartWithBackoffSource(scala.Function0<Source<T,?>> sourceFactory,
                                scala.concurrent.duration.FiniteDuration minBackoff,
                                scala.concurrent.duration.FiniteDuration maxBackoff,
                                double randomFactor,
                                boolean onlyOnFailures,
                                int maxRestarts)

Method Detail

createLogic

public RestartWithBackoffLogic<SourceShape<T>> createLogic(Attributes inheritedAttributes)

Specified by:

createLogic in class GraphStage<SourceShape<T>>

out

public Outlet<T> out()

shape

public SourceShape<T> shape()

Description copied from interface: Graph

The shape of a graph is all that is externally visible: its inlets and outlets.

Returns:

(undocumented)