object RestartSource
A RestartSource wraps a Source 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, for Source streams that depend on a remote server that may crash or become partitioned. The RestartSource ensures that the graph can continue running while the Source restarts.
- Source
- RestartSource.scala
- Alphabetic
- By Inheritance
- RestartSource
- 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()
- def onFailuresWithBackoff[T](settings: RestartSettings)(sourceFactory: () => Source[T, _]): Source[T, NotUsed]
Wrap the given Source with a Source that will restart it when it fails using an exponential backoff.
Wrap the given Source with a Source 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 wrapped Source is handled by restarting it. The wrapped Source can be cancelled by cancelling this Source. When that happens, the wrapped Source, 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 a KillSwitch right after this Source in the graph.
This uses the same exponential backoff algorithm as akka.pattern.BackoffOpts.
- settings
RestartSettings defining restart configuration
- sourceFactory
A factory for producing the Source to wrap.
- 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)(sourceFactory: () => Source[T, _]): Source[T, NotUsed]
Wrap the given Source with a Source that will restart it when it fails or complete using an exponential backoff.
Wrap the given Source with a Source 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 wrapped Source is handled by restarting it. The wrapped Source can however be cancelled by cancelling this Source. When that happens, the wrapped Source, 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 a KillSwitch right after this Source in the graph.
This uses the same exponential backoff algorithm as akka.pattern.BackoffOpts.
- settings
RestartSettings defining restart configuration
- sourceFactory
A factory for producing the Source 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 onFailuresWithBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, maxRestarts: Int)(sourceFactory: () => Source[T, _]): Source[T, NotUsed]
Wrap the given Source with a Source that will restart it when it fails using an exponential backoff.
Wrap the given Source with a Source 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 wrapped Source is handled by restarting it. The wrapped Source can be cancelled by cancelling this Source. When that happens, the wrapped Source, 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 a KillSwitch right after this Source in the graph.
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.- sourceFactory
A factory for producing the Source to wrap.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.6.10) Use the overloaded method which accepts akka.stream.RestartSettings instead.
- def onFailuresWithBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double)(sourceFactory: () => Source[T, _]): Source[T, NotUsed]
Wrap the given Source with a Source that will restart it when it fails using an exponential backoff.
Wrap the given Source with a Source 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 wrapped Source is handled by restarting it. The wrapped Source can be cancelled by cancelling this Source. When that happens, the wrapped Source, 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 a KillSwitch right after this Source in the graph.
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.- sourceFactory
A factory for producing the Source 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, maxRestarts: Int)(sourceFactory: () => Source[T, _]): Source[T, NotUsed]
Wrap the given Source with a Source that will restart it when it fails or complete using an exponential backoff.
Wrap the given Source with a Source 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 wrapped Source is handled by restarting it. The wrapped Source can however be cancelled by cancelling this Source. When that happens, the wrapped Source, 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 a KillSwitch right after this Source in the graph.
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.- sourceFactory
A factory for producing the Source 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)(sourceFactory: () => Source[T, _]): Source[T, NotUsed]
Wrap the given Source with a Source that will restart it when it fails or complete using an exponential backoff.
Wrap the given Source with a Source 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 wrapped Source is always handled by restarting it. The wrapped Source can however be cancelled by cancelling this Source. When that happens, the wrapped Source, 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 a KillSwitch right after this Source in the graph.
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.- sourceFactory
A factory for producing the Source to wrap.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 2.6.10) Use the overloaded method which accepts akka.stream.RestartSettings instead.