Package akka.stream.scaladsl

Class RestartSourceWithContext

java.lang.Object

akka.stream.scaladsl.RestartSourceWithContext

public class RestartSourceWithContext
extends java.lang.Object

A RestartSourceWithContext wraps a SourceWithContext that gets restarted when it completes or fails.

They are useful for graphs that need to run for longer than the SourceWithContext can necessarily guarantee it will, e.g. for SourceWithContext streams that depend on a remote service to which connectivity may be lost (crash or partition). The RestartSourceWithContext ensures that the graph can continue running while the SourceWithContext restarts.

Constructor Summary

Constructors

Constructor	Description
RestartSourceWithContext()

Method Summary

Modifier and Type	Method	Description
static <T,C> SourceWithContext<T,C,NotUsed>	onFailuresWithBackoff(RestartSettings settings, scala.Function0<SourceWithContext<T,C,?>> sourceFactory)	Wrap the given SourceWithContext with a SourceWithContext that will restart it when it fails using an exponential backoff.
static <T,C> SourceWithContext<T,C,NotUsed>	withBackoff(RestartSettings settings, scala.Function0<SourceWithContext<T,C,?>> sourceFactory)	Wrap the given SourceWithContext with a SourceWithContext that will restart it when it fails or completes using an exponential backoff.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestartSourceWithContext

public RestartSourceWithContext()

Method Detail

withBackoff

public static <T,C> SourceWithContext<T,C,NotUsed> withBackoff(RestartSettings settings,
                                                                                 scala.Function0<SourceWithContext<T,C,?>> sourceFactory)

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

The returned SourceWithContext will not emit a complete or failure as long as maxRestarts is not reached, since the completion or failure of the wrapped SourceWithContext is handled by restarting it. The wrapped SourceWithContext can however be canceled by canceling the returned SourceWithContext. When that happens, the wrapped SourceWithContext if currently running will be canceled and will not be restarted.

Parameters:

settings - RestartSettings defining restart configuration

sourceFactory - A factory for producing the SourceWithContext to wrap

onFailuresWithBackoff

public static <T,C> SourceWithContext<T,C,NotUsed> onFailuresWithBackoff(RestartSettings settings,
                                                                                           scala.Function0<SourceWithContext<T,C,?>> sourceFactory)

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

The returned SourceWithContext will not emit a failure as long as maxRestarts is not reached, since the failure of the wrapped SourceWithContext is handled by restarting it. The wrapped SourceWithContext can however be canceled by canceling the returned SourceWithContext. When that happens, the wrapped SourceWithContext if currently running will be canceled and will not be restarted.

Parameters:

settings - RestartSettings defining restart configuration

sourceFactory - A factory for producing the SourceWithContext to wrap