Class BackoffOptions

Inheritance
object
BackoffOptions
Inherited Members
Namespace: Akka.Pattern
Assembly: Akka.dll
Syntax
public abstract class BackoffOptions

Methods

| Edit this page View Source

WithAutoReset(TimeSpan)

Returns a new BackoffOptions with automatic back-off reset. The back-off algorithm is reset if the child does not crash within the specified resetBackoff.

Declaration
public abstract BackoffOptions WithAutoReset(TimeSpan resetBackoff)
Parameters
Type Name Description
TimeSpan resetBackoff

The back-off is reset if the child does not crash within this duration
Returns
Type Description
BackoffOptions
| Edit this page View Source

WithDefaultStoppingStrategy()

Returns a new BackoffOptions with a default StoppingStrategy. The default supervisor strategy is used as fallback for throwables not handled by StoppingStrategy.

Declaration
public abstract BackoffOptions WithDefaultStoppingStrategy()
Returns
Type Description
BackoffOptions
| Edit this page View Source

WithFinalStopMessage(Func<object, bool>)

Predicate evaluated for each message, if it returns true and the supervised actor is stopped then the supervisor will stop its self. If it returns true while the supervised actor is running then it will be forwarded to the supervised actor and when the supervised actor stops itself the supervisor will stop itself.

Declaration
public abstract BackoffOptions WithFinalStopMessage(Func<object, bool> isFinalStopMessage)
Parameters
Type Name Description
Func<object, bool> isFinalStopMessage
Returns
Type Description
BackoffOptions
| Edit this page View Source

WithManualReset()

Returns a new BackoffOptions with manual back-off reset. The back-off is only reset if the child sends a BackoffSupervisor.Reset to its parent(the backoff-supervisor actor).

Declaration
public abstract BackoffOptions WithManualReset()
Returns
Type Description
BackoffOptions
| Edit this page View Source

WithMaxNrOfRetries(int)

Returns a new BackoffOptions with a maximum number of retries to restart the child actor. By default, the supervisor will retry infinitely. With this option, the supervisor will terminate itself after the maxNoOfRetries is reached.

Declaration
public abstract BackoffOptions WithMaxNrOfRetries(int maxNrOfRetries)
Parameters
Type Name Description
int maxNrOfRetries

The number of times a child actor is allowed to be restarted, negative value means no limit, if the limit is exceeded the child actor is stopped
Returns
Type Description
BackoffOptions
| Edit this page View Source

WithReplyWhileStopped(object)

Returns a new BackoffOptions with a constant reply to messages that the supervisor receives while its child is stopped. By default, a message received while the child is stopped is forwarded to deadLetters. With this option, the supervisor will reply to the sender instead.

Declaration
public abstract BackoffOptions WithReplyWhileStopped(object replyWhileStopped)
Parameters
Type Name Description
object replyWhileStopped

The message that the supervisor will send in response to all messages while its child is stopped.
Returns
Type Description
BackoffOptions
| Edit this page View Source

WithSupervisorStrategy(OneForOneStrategy)

Returns a new BackoffOptions with the supervisorStrategy.

Declaration
public abstract BackoffOptions WithSupervisorStrategy(OneForOneStrategy supervisorStrategy)
Parameters
Type Name Description
OneForOneStrategy supervisorStrategy

The SupervisorStrategy that the back-off supervisor will use. The default supervisor strategy is used as fallback if the specified SupervisorStrategy (its decider) does not explicitly handle an exception
Returns
Type Description
BackoffOptions

Extension Methods