Class RestartSettings

Inheritance
object
RestartSettings
Inherited Members
Namespace: Akka.Streams
Assembly: Akka.Streams.dll
Syntax
public class RestartSettings

Properties

| Edit this page View Source

MaxBackoff

Declaration
public TimeSpan MaxBackoff { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

MaxRestarts

Declaration
public int MaxRestarts { get; }
Property Value
Type Description
int
| Edit this page View Source

MaxRestartsWithin

Declaration
public TimeSpan MaxRestartsWithin { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

MinBackoff

Declaration
public TimeSpan MinBackoff { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

RandomFactor

Declaration
public double RandomFactor { get; }
Property Value
Type Description
double

Methods

| Edit this page View Source

Create(TimeSpan, TimeSpan, double)

Creates a new instance of RestartSettings class

Declaration
public static RestartSettings Create(TimeSpan minBackoff, TimeSpan maxBackoff, double randomFactor)
Parameters
Type Name Description
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
RestartSettings
| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
| Edit this page View Source

WithMaxBackoff(TimeSpan)

The exponential back-off is capped to this duration

Declaration
public RestartSettings WithMaxBackoff(TimeSpan value)
Parameters
Type Name Description
TimeSpan value
Returns
Type Description
RestartSettings
| Edit this page View Source

WithMaxRestarts(int, TimeSpan)

The amount of restarts is capped to count within a timeframe of within

Declaration
public RestartSettings WithMaxRestarts(int count, TimeSpan within)
Parameters
Type Name Description
int count
TimeSpan within
Returns
Type Description
RestartSettings
| Edit this page View Source

WithMinBackoff(TimeSpan)

Minimum (initial) duration until the child actor will started again, if it is terminated

Declaration
public RestartSettings WithMinBackoff(TimeSpan value)
Parameters
Type Name Description
TimeSpan value
Returns
Type Description
RestartSettings
| Edit this page View Source

WithRandomFactor(double)

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
Declaration
public RestartSettings WithRandomFactor(double value)
Parameters
Type Name Description
double value
Returns
Type Description
RestartSettings

Extension Methods