Class RestartFlow

A RestartFlow wraps a Flow 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, for Flow streams that depend on a remote server that may crash or become partitioned. The RestartFlow ensures that the graph can continue running while the Flow restarts.

Inheritance

Object

RestartFlow

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Streams.Dsl

Assembly: Akka.Streams.dll

Syntax

public static class RestartFlow

Methods

| Improve this Doc View Source

OnFailuresWithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>>, RestartSettings)

Wrap the given Flow with a Flow that will restart it when it fails using an exponential backoff. Notice that this Flow will not restart on completion of the wrapped flow.

This Flow will not emit any failure The failures by the wrapped Flow will be handled by restarting the wrapping Flow as long as maxRestarts is not reached. Any termination signals sent to this Flow however will terminate the wrapped Flow, if it's running, and then the Flow 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, nd any in transit messages will be lost. During backoff, this Flow will backpressure.

This uses the same exponential backoff algorithm as BackoffOptions.

Declaration

public static Flow<TIn, TOut, NotUsed> OnFailuresWithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>> flowFactory, RestartSettings settings)

Parameters

Type	Name	Description
Func<Flow<TIn, TOut, TMat>>	flowFactory	A factory for producing the Flow] to wrap.
RestartSettings	settings	RestartSettings defining restart configuration

Returns

Type	Description
Flow<TIn, TOut, NotUsed>

Type Parameters

Name	Description
TIn
TOut
TMat

| Improve this Doc View Source

OnFailuresWithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>>, TimeSpan, TimeSpan, Double)

Wrap the given Flow with a Flow that will restart it when it fails using an exponential backoff. Notice that this Flow will not restart on completion of the wrapped flow.

This uses the same exponential backoff algorithm as BackoffOptions.

Declaration

[Obsolete("Use the overloaded method which accepts Akka.Stream.RestartSettings instead.")]
public static Flow<TIn, TOut, NotUsed> OnFailuresWithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>> flowFactory, TimeSpan minBackoff, TimeSpan maxBackoff, double randomFactor)

Parameters

Type	Name	Description
Func<Flow<TIn, TOut, TMat>>	flowFactory	A factory for producing the Flow] to wrap.
TimeSpan	minBackoff	Minimum (initial) duration until the child actor will started again, if it is terminated
TimeSpan	maxBackoff	The exponential back-off is capped to this duration
Double	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`.

Returns

Type	Description
Flow<TIn, TOut, NotUsed>

Type Parameters

Name	Description
TIn
TOut
TMat

| Improve this Doc View Source

OnFailuresWithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>>, TimeSpan, TimeSpan, Double, Int32)

Wrap the given Flow with a Flow that will restart it when it fails using an exponential backoff. Notice that this Flow will not restart on completion of the wrapped flow.

This uses the same exponential backoff algorithm as BackoffOptions.

Declaration

[Obsolete("Use the overloaded method which accepts Akka.Stream.RestartSettings instead.")]
public static Flow<TIn, TOut, NotUsed> OnFailuresWithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>> flowFactory, TimeSpan minBackoff, TimeSpan maxBackoff, double randomFactor, int maxRestarts)

Parameters

Type	Name	Description
Func<Flow<TIn, TOut, TMat>>	flowFactory	A factory for producing the Flow] to wrap.
TimeSpan	minBackoff	Minimum (initial) duration until the child actor will started again, if it is terminated
TimeSpan	maxBackoff	The exponential back-off is capped to this duration
Double	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`.
Int32	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.

Returns

Type	Description
Flow<TIn, TOut, NotUsed>

Type Parameters

Name	Description
TIn
TOut
TMat

| Improve this Doc View Source

WithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>>, RestartSettings)

Wrap the given Flow with a Flow 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 the Flow before that time will be handled by restarting it. Any termination signals sent to this Flow however will terminate the wrapped Flow, if it's running, and then the Flow 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, this Flow will backpressure.

This uses the same exponential backoff algorithm as BackoffOptions.

Declaration

public static Flow<TIn, TOut, NotUsed> WithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>> flowFactory, RestartSettings settings)

Parameters

Type	Name	Description
Func<Flow<TIn, TOut, TMat>>	flowFactory	A factory for producing the Flow] to wrap.
RestartSettings	settings	RestartSettings defining restart configuration

Returns

Type	Description
Flow<TIn, TOut, NotUsed>

Type Parameters

Name	Description
TIn
TOut
TMat

| Improve this Doc View Source

WithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>>, TimeSpan, TimeSpan, Double)

Wrap the given Flow with a Flow that will restart it when it fails or complete using an exponential backoff.

This uses the same exponential backoff algorithm as BackoffOptions.

Declaration

[Obsolete("Use the overloaded method which accepts Akka.Stream.RestartSettings instead.")]
public static Flow<TIn, TOut, NotUsed> WithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>> flowFactory, TimeSpan minBackoff, TimeSpan maxBackoff, double randomFactor)

Parameters

Type	Name	Description
Func<Flow<TIn, TOut, TMat>>	flowFactory	A factory for producing the Flow] to wrap.
TimeSpan	minBackoff	Minimum (initial) duration until the child actor will started again, if it is terminated
TimeSpan	maxBackoff	The exponential back-off is capped to this duration
Double	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`.

Returns

Type	Description
Flow<TIn, TOut, NotUsed>

Type Parameters

Name	Description
TIn
TOut
TMat

| Improve this Doc View Source

WithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>>, TimeSpan, TimeSpan, Double, Int32)

Wrap the given Flow with a Flow that will restart it when it fails or complete using an exponential backoff.

This uses the same exponential backoff algorithm as BackoffOptions.

Declaration

[Obsolete("Use the overloaded method which accepts Akka.Stream.RestartSettings instead.")]
public static Flow<TIn, TOut, NotUsed> WithBackoff<TIn, TOut, TMat>(Func<Flow<TIn, TOut, TMat>> flowFactory, TimeSpan minBackoff, TimeSpan maxBackoff, double randomFactor, int maxRestarts)

Parameters

Type	Name	Description
Func<Flow<TIn, TOut, TMat>>	flowFactory	A factory for producing the Flow] to wrap.
TimeSpan	minBackoff	Minimum (initial) duration until the child actor will started again, if it is terminated
TimeSpan	maxBackoff	The exponential back-off is capped to this duration
Double	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`.
Int32	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.

Returns

Type	Description
Flow<TIn, TOut, NotUsed>

Type Parameters

Name	Description
TIn
TOut
TMat