Object

akka.stream.javadsl

RestartSource

Related Doc: package javadsl

Permalink

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
Restart.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RestartSource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. def onFailuresWithBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, maxRestarts: Int, sourceFactory: Creator[Source[T, _]]): Source[T, NotUsed]

    Permalink

    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 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.Backoff.

    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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

    maxRestarts

    the amount of restarts is capped to this amount within a time frame of minBackoff. Passing 0 will cause no restarts and a negative number will not cap the amount of restarts.

    sourceFactory

    A factory for producing the Source to wrap.

  16. def onFailuresWithBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, sourceFactory: Creator[Source[T, _]]): Source[T, NotUsed]

    Permalink

    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 never emit a failure, since the failure of the wrapped Source is always handled by restarting. 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.Backoff.

    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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

    sourceFactory

    A factory for producing the Source to wrap.

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def withBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, maxRestarts: Int, sourceFactory: Creator[Source[T, _]]): Source[T, NotUsed]

    Permalink

    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.Backoff.

    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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

    maxRestarts

    the amount of restarts is capped to this amount within a time frame of minBackoff. Passing 0 will cause no restarts and a negative number will not cap the amount of restarts.

    sourceFactory

    A factory for producing the Source to wrap.

  23. def withBackoff[T](minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, sourceFactory: Creator[Source[T, _]]): Source[T, NotUsed]

    Permalink

    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.Backoff.

    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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

    sourceFactory

    A factory for producing the Source to wrap.

Inherited from AnyRef

Inherited from Any

Ungrouped