Class RestartFlow
- java.lang.Object
-
- akka.stream.javadsl.RestartFlow
-
public class RestartFlow extends java.lang.Object
A RestartFlow wraps aFlow
that gets restarted when it completes or fails.They are useful for graphs that need to run for longer than the
Flow
can necessarily guarantee it will, for example, forFlow
streams that depend on a remote server that may crash or become partitioned. The RestartFlow ensures that the graph can continue running while theFlow
restarts.
-
-
Constructor Summary
Constructors Constructor Description RestartFlow()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <In,Out>
Flow<In,Out,NotUsed>onFailuresWithBackoff(RestartSettings settings, Creator<Flow<In,Out,?>> flowFactory)
static <In,Out>
Flow<In,Out,NotUsed>onFailuresWithBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead.static <In,Out>
Flow<In,Out,NotUsed>onFailuresWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static <In,Out>
Flow<In,Out,NotUsed>withBackoff(RestartSettings settings, Creator<Flow<In,Out,?>> flowFactory)
static <In,Out>
Flow<In,Out,NotUsed>withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead.static <In,Out>
Flow<In,Out,NotUsed>withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead.static <In,Out>
Flow<In,Out,NotUsed>withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static <In,Out>
Flow<In,Out,NotUsed>withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.
-
-
-
Method Detail
-
withBackoff
public static <In,Out> Flow<In,Out,NotUsed> withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenFlow
with aFlow
that will restart it when it fails or complete using an exponential backoff.This
Flow
will not cancel, complete or emit a failure, until the opposite end of it has been cancelled or completed. Any termination by theFlow
before that time will be handled by restarting it. Any termination signals sent to thisFlow
however will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.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
.flowFactory
- A factory for producing theFlow
to wrap.
-
withBackoff
public static <In,Out> Flow<In,Out,NotUsed> withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead. Since 2.6.10.Wrap the givenFlow
with aFlow
that will restart it when it fails or complete using an exponential backoff.This
Flow
will not cancel, complete or emit a failure, until the opposite end of it has been cancelled or completed. Any termination by theFlow
before that time will be handled by restarting it. Any termination signals sent to thisFlow
however will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.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
.flowFactory
- A factory for producing theFlow
to wrap.
-
withBackoff
public static <In,Out> Flow<In,Out,NotUsed> withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenFlow
with aFlow
that will restart it when it fails or complete using an exponential backoff.This
Flow
will not cancel, complete or emit a failure, until the opposite end of it has been cancelled or completed. Any termination by theFlow
before that time will be handled by restarting it as long as maxRestarts is not reached. Any termination signals sent to thisFlow
however will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.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.flowFactory
- A factory for producing theFlow
to wrap.
-
withBackoff
public static <In,Out> Flow<In,Out,NotUsed> withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead. Since 2.6.10.Wrap the givenFlow
with aFlow
that will restart it when it fails or complete using an exponential backoff.This
Flow
will not cancel, complete or emit a failure, until the opposite end of it has been cancelled or completed. Any termination by theFlow
before that time will be handled by restarting it as long as maxRestarts is not reached. Any termination signals sent to thisFlow
however will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.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.flowFactory
- A factory for producing theFlow
to wrap.
-
withBackoff
public static <In,Out> Flow<In,Out,NotUsed> withBackoff(RestartSettings settings, Creator<Flow<In,Out,?>> flowFactory)
Wrap the givenFlow
with aFlow
that will restart it when it fails or complete using an exponential backoff.This
Flow
will not cancel, complete or emit a failure, until the opposite end of it has been cancelled or completed. Any termination by theFlow
before that time will be handled by restarting it as long as maxRestarts is not reached. Any termination signals sent to thisFlow
however will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
settings
-RestartSettings
defining restart configurationflowFactory
- A factory for producing theFlow
to wrap.
-
onFailuresWithBackoff
public static <In,Out> Flow<In,Out,NotUsed> onFailuresWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenFlow
with aFlow
that will restart only when it fails that restarts using an exponential backoff.This new
Flow
will not emit failures. Any failure by the originalFlow
(the wrapped one) before that time will be handled by restarting it as long as maxRestarts is not reached. However, any termination signals, completion or cancellation sent to thisFlow
will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.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.flowFactory
- A factory for producing theFlow
to wrap.
-
onFailuresWithBackoff
public static <In,Out> Flow<In,Out,NotUsed> onFailuresWithBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Flow<In,Out,?>> flowFactory)
Deprecated.Use the overloaded method which accepts akka.stream.RestartSettings instead. Since 2.6.10.Wrap the givenFlow
with aFlow
that will restart only when it fails that restarts using an exponential backoff.This new
Flow
will not emit failures. Any failure by the originalFlow
(the wrapped one) before that time will be handled by restarting it as long as maxRestarts is not reached. However, any termination signals, completion or cancellation sent to thisFlow
will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.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.flowFactory
- A factory for producing theFlow
to wrap.
-
onFailuresWithBackoff
public static <In,Out> Flow<In,Out,NotUsed> onFailuresWithBackoff(RestartSettings settings, Creator<Flow<In,Out,?>> flowFactory)
Wrap the givenFlow
with aFlow
that will restart only when it fails that restarts using an exponential backoff.This new
Flow
will not emit failures. Any failure by the originalFlow
(the wrapped one) before that time will be handled by restarting it as long as maxRestarts is not reached. However, any termination signals, completion or cancellation sent to thisFlow
will terminate the wrappedFlow
, if it's running, and then theFlow
will be allowed to terminate without being restarted.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. A termination signal from either end of the wrapped
Flow
will cause the other end to be terminated, and any in transit messages will be lost. During backoff, thisFlow
will backpressure.This uses the same exponential backoff algorithm as
BackoffOpts
.- Parameters:
settings
-RestartSettings
defining restart configurationflowFactory
- A factory for producing theFlow
to wrap.
-
-