Class RestartSource
- java.lang.Object
-
- akka.stream.javadsl.RestartSource
-
public class RestartSource extends java.lang.Object
A RestartSource wraps aSource
that gets restarted when it completes or fails.They are useful for graphs that need to run for longer than the
Source
can necessarily guarantee it will, for example, forSource
streams that depend on a remote server that may crash or become partitioned. The RestartSource ensures that the graph can continue running while theSource
restarts.
-
-
Constructor Summary
Constructors Constructor Description RestartSource()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <T> Source<T,NotUsed>
onFailuresWithBackoff(RestartSettings settings, Creator<Source<T,?>> sourceFactory)
static <T> Source<T,NotUsed>
onFailuresWithBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead.static <T> Source<T,NotUsed>
onFailuresWithBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead.static <T> Source<T,NotUsed>
onFailuresWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static <T> Source<T,NotUsed>
onFailuresWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static <T> Source<T,NotUsed>
withBackoff(RestartSettings settings, Creator<Source<T,?>> sourceFactory)
static <T> Source<T,NotUsed>
withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead.static <T> Source<T,NotUsed>
withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead.static <T> Source<T,NotUsed>
withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static <T> Source<T,NotUsed>
withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.
-
-
-
Method Detail
-
withBackoff
public static <T> Source<T,NotUsed> withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenSource
with aSource
that will restart it when it fails or complete using an exponential backoff.This
Source
will never emit a complete or failure, since the completion or failure of the wrappedSource
is always handled by restarting it. The wrappedSource
can however be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.sourceFactory
- A factory for producing theSource
to wrap.
-
withBackoff
public static <T> Source<T,NotUsed> withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead. Since 2.6.10.Wrap the givenSource
with aSource
that will restart it when it fails or complete using an exponential backoff.This
Source
will never emit a complete or failure, since the completion or failure of the wrappedSource
is always handled by restarting it. The wrappedSource
can however be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.sourceFactory
- A factory for producing theSource
to wrap.
-
withBackoff
public static <T> Source<T,NotUsed> withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenSource
with aSource
that will restart it when it fails or complete 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 wrappedSource
is handled by restarting it. The wrappedSource
can however be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.maxRestarts
- the amount of restarts is capped to this amount within a time frame of minBackoff. Passing0
will cause no restarts and a negative number will not cap the amount of restarts.sourceFactory
- A factory for producing theSource
to wrap.
-
withBackoff
public static <T> Source<T,NotUsed> withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead. Since 2.6.10.Wrap the givenSource
with aSource
that will restart it when it fails or complete 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 wrappedSource
is handled by restarting it. The wrappedSource
can however be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.maxRestarts
- the amount of restarts is capped to this amount within a time frame of minBackoff. Passing0
will cause no restarts and a negative number will not cap the amount of restarts.sourceFactory
- A factory for producing theSource
to wrap.
-
withBackoff
public static <T> Source<T,NotUsed> withBackoff(RestartSettings settings, Creator<Source<T,?>> sourceFactory)
Wrap the givenSource
with aSource
that will restart it when it fails or complete 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 wrappedSource
is handled by restarting it. The wrappedSource
can however be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
settings
-RestartSettings
defining restart configurationsourceFactory
- A factory for producing theSource
to wrap.
-
onFailuresWithBackoff
public static <T> Source<T,NotUsed> onFailuresWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenSource
with aSource
that will restart it when it fails using an exponential backoff.This
Source
will never emit a failure, since the failure of the wrappedSource
is always handled by restarting. The wrappedSource
can be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.sourceFactory
- A factory for producing theSource
to wrap.
-
onFailuresWithBackoff
public static <T> Source<T,NotUsed> onFailuresWithBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead. Since 2.6.10.Wrap the givenSource
with aSource
that will restart it when it fails using an exponential backoff.This
Source
will never emit a failure, since the failure of the wrappedSource
is always handled by restarting. The wrappedSource
can be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.sourceFactory
- A factory for producing theSource
to wrap.
-
onFailuresWithBackoff
public static <T> Source<T,NotUsed> onFailuresWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenSource
with aSource
that will restart it when it fails using an exponential backoff.This
Source
will not emit a failure as long as maxRestarts is not reached, since failure of the wrappedSource
is handled by restarting it. The wrappedSource
can be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.maxRestarts
- the amount of restarts is capped to this amount within a time frame of minBackoff. Passing0
will cause no restarts and a negative number will not cap the amount of restarts.sourceFactory
- A factory for producing theSource
to wrap.
-
onFailuresWithBackoff
public static <T> Source<T,NotUsed> onFailuresWithBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Source<T,?>> sourceFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead. Since 2.6.10.Wrap the givenSource
with aSource
that will restart it when it fails using an exponential backoff.This
Source
will not emit a failure as long as maxRestarts is not reached, since failure of the wrappedSource
is handled by restarting it. The wrappedSource
can be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.maxRestarts
- the amount of restarts is capped to this amount within a time frame of minBackoff. Passing0
will cause no restarts and a negative number will not cap the amount of restarts.sourceFactory
- A factory for producing theSource
to wrap.
-
onFailuresWithBackoff
public static <T> Source<T,NotUsed> onFailuresWithBackoff(RestartSettings settings, Creator<Source<T,?>> sourceFactory)
Wrap the givenSource
with aSource
that will restart it when it fails using an exponential backoff.This
Source
will not emit a failure as long as maxRestarts is not reached, since failure of the wrappedSource
is handled by restarting it. The wrappedSource
can be cancelled by cancelling thisSource
. When that happens, the wrappedSource
, 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 aKillSwitch
right after thisSource
in the graph.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
settings
-RestartSettings
defining restart configurationsourceFactory
- A factory for producing theSource
to wrap.
-
-