Class RestartSink$
- java.lang.Object
-
- akka.stream.javadsl.RestartSink$
-
public class RestartSink$ extends java.lang.Object
Wrap the givenSink
with aSink
that will restart it when it fails or complete using an exponential backoff.This
Sink
will never cancel, since cancellation by the wrappedSink
is always handled by restarting it. The wrappedSink
can however be completed by feeding a completion or error into thisSink
. When that happens, theSink
, if currently running, will terminate and will not be restarted. This can be triggered simply by the upstream completing, or externally by introducing aKillSwitch
right before thisSink
in the graph.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. When the wrapped
Sink
does cancel, thisSink
will backpressure, however any elements already sent may have been lost.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 to20%
delay. In order to skip this additional delay pass in0
. param: sinkFactory A factory for producing theSink
to wrap.
-
-
Field Summary
Fields Modifier and Type Field Description static RestartSink$
MODULE$
Static reference to the singleton instance of this Scala object.
-
Constructor Summary
Constructors Constructor Description RestartSink$()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description <T> Sink<T,NotUsed>
withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Sink<T,?>> sinkFactory)
<T> Sink<T,NotUsed>
withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Sink<T,?>> sinkFactory)
<T> Sink<T,NotUsed>
withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Sink<T,?>> sinkFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.<T> Sink<T,NotUsed>
withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Sink<T,?>> sinkFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.
-
-
-
Field Detail
-
MODULE$
public static final RestartSink$ MODULE$
Static reference to the singleton instance of this Scala object.
-
-
Method Detail
-
withBackoff
public <T> Sink<T,NotUsed> withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, Creator<Sink<T,?>> sinkFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.
-
withBackoff
public <T> Sink<T,NotUsed> withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Creator<Sink<T,?>> sinkFactory)
Wrap the givenSink
with aSink
that will restart it when it fails or complete using an exponential backoff.This
Sink
will never cancel, since cancellation by the wrappedSink
is always handled by restarting it. The wrappedSink
can however be completed by feeding a completion or error into thisSink
. When that happens, theSink
, if currently running, will terminate and will not be restarted. This can be triggered simply by the upstream completing, or externally by introducing aKillSwitch
right before thisSink
in the graph.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. When the wrapped
Sink
does cancel, thisSink
will backpressure, however any elements already sent may have been lost.This uses the same exponential backoff algorithm as
Backoff
.- 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
.sinkFactory
- A factory for producing theSink
to wrap.- Returns:
- (undocumented)
-
withBackoff
public <T> Sink<T,NotUsed> withBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxRestarts, Creator<Sink<T,?>> sinkFactory)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.Wrap the givenSink
with aSink
that will restart it when it fails or complete using an exponential backoff.This
Sink
will not cancel as long as maxRestarts is not reached, since cancellation by the wrappedSink
is handled by restarting it. The wrappedSink
can however be completed by feeding a completion or error into thisSink
. When that happens, theSink
, if currently running, will terminate and will not be restarted. This can be triggered simply by the upstream completing, or externally by introducing aKillSwitch
right before thisSink
in the graph.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. When the wrapped
Sink
does cancel, thisSink
will backpressure, however any elements already sent may have been lost.This uses the same exponential backoff algorithm as
Backoff
.- 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.sinkFactory
- A factory for producing theSink
to wrap.- Returns:
- (undocumented)
-
withBackoff
public <T> Sink<T,NotUsed> withBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxRestarts, Creator<Sink<T,?>> sinkFactory)
Wrap the givenSink
with aSink
that will restart it when it fails or complete using an exponential backoff.This
Sink
will not cancel as long as maxRestarts is not reached, since cancellation by the wrappedSink
is handled by restarting it. The wrappedSink
can however be completed by feeding a completion or error into thisSink
. When that happens, theSink
, if currently running, will terminate and will not be restarted. This can be triggered simply by the upstream completing, or externally by introducing aKillSwitch
right before thisSink
in the graph.The restart process is inherently lossy, since there is no coordination between cancelling and the sending of messages. When the wrapped
Sink
does cancel, thisSink
will backpressure, however any elements already sent may have been lost.This uses the same exponential backoff algorithm as
Backoff
.- 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.sinkFactory
- A factory for producing theSink
to wrap.- Returns:
- (undocumented)
-
-