object RestartSink
A RestartSink wraps a Sink that gets restarted when it completes or fails.
They are useful for graphs that need to run for longer than the Sink can necessarily guarantee it will, for example, for Sink streams that depend on a remote server that may crash or become partitioned. The RestartSink ensures that the graph can continue running while the Sink restarts.
- Source
- RestartSink.scala
- Alphabetic
- By Inheritance
- RestartSink
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withBackoff[T](settings: RestartSettings)(sinkFactory: () => Sink[T, _]): Sink[T, NotUsed]
Wrap the given Sink with a Sink that will restart it when it fails or complete using an exponential backoff.
Wrap the given Sink with a Sink 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 wrapped Sink is handled by restarting it. The wrapped Sink can however be completed by feeding a completion or error into this Sink. When that happens, the Sink, if currently running, will terminate and will not be restarted. This can be triggered simply by the upstream completing, or externally by introducing a KillSwitch right before this Sink 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, this Sink will backpressure, however any elements already sent may have been lost.
This uses the same exponential backoff algorithm as akka.pattern.BackoffOpts.
- settings
RestartSettings defining restart configuration
- sinkFactory
A factory for producing the Sink to wrap.
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def withBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, maxRestarts: Int)(sinkFactory: () => Sink[T, _]): Sink[T, NotUsed]
Wrap the given Sink with a Sink that will restart it when it fails or complete using an exponential backoff.
Wrap the given Sink with a Sink 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 wrapped Sink is handled by restarting it. The wrapped Sink can however be completed by feeding a completion or error into this Sink. When that happens, the Sink, if currently running, will terminate and will not be restarted. This can be triggered simply by the upstream completing, or externally by introducing a KillSwitch right before this Sink 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, this Sink will backpressure, however any elements already sent may have been lost.
This uses the same exponential backoff algorithm as akka.pattern.BackoffOpts.
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds 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. Passing
0will cause no restarts and a negative number will not cap the amount of restarts.- sinkFactory
A factory for producing the Sink to wrap.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.6.10) Use the overloaded method which accepts akka.stream.RestartSettings instead.
- def withBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double)(sinkFactory: () => Sink[T, _]): Sink[T, NotUsed]
Wrap the given Sink with a Sink that will restart it when it fails or complete using an exponential backoff.
Wrap the given Sink with a Sink that will restart it when it fails or complete using an exponential backoff.
This Sink will never cancel, since cancellation by the wrapped Sink is always handled by restarting it. The wrapped Sink can however be completed by feeding a completion or error into this Sink. When that happens, the Sink, if currently running, will terminate and will not be restarted. This can be triggered simply by the upstream completing, or externally by introducing a KillSwitch right before this Sink 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, this Sink will backpressure, however any elements already sent may have been lost.
This uses the same exponential backoff algorithm as akka.pattern.BackoffOpts.
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds up to20%delay. In order to skip this additional delay pass in0.- sinkFactory
A factory for producing the Sink to wrap.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.6.10) Use the overloaded method which accepts akka.stream.RestartSettings instead.