sealed trait BackoffOnFailureOptions extends ExtendedBackoffOptions[BackoffOnFailureOptions]
- Alphabetic
- By Inheritance
- BackoffOnFailureOptions
- ExtendedBackoffOptions
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def withAutoReset(resetBackoff: FiniteDuration): BackoffOnFailureOptions
Returns a new BackoffOptions with automatic back-off reset.
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
.- resetBackoff
The back-off is reset if the child does not crash within this duration.
- Definition Classes
- ExtendedBackoffOptions
- abstract def withHandlerWhileStopped(handler: ActorRef): BackoffOnFailureOptions
Returns a new BackoffOptions with a custom handler for messages that the supervisor receives while its child is stopped.
Returns a new BackoffOptions with a custom handler for messages that the supervisor receives while its child is stopped. By default, a message received while the child is stopped is forwarded to
deadLetters
. Essentially, this handler replacesdeadLetters
allowing to implement custom handling instead of a static reply.- handler
PartialFunction of the received message and sender
- Definition Classes
- ExtendedBackoffOptions
- abstract def withManualReset: BackoffOnFailureOptions
Returns a new BackoffOptions with manual back-off reset.
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).- Definition Classes
- ExtendedBackoffOptions
- abstract def withMaxNrOfRetries(maxNrOfRetries: Int): BackoffOnFailureOptions
Returns a new BackoffOptions with a maximum number of retries to restart the child actor.
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.
- maxNrOfRetries
the number of times a child actor is allowed to be restarted. If negative, the value is unbounded, otherwise the provided limit is used. If the limit is exceeded the child actor will be stopped.
- Definition Classes
- ExtendedBackoffOptions
- abstract def withReplyWhileStopped(replyWhileStopped: Any): BackoffOnFailureOptions
Returns a new BackoffOptions with a constant reply to messages that the supervisor receives while its child is stopped.
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.- replyWhileStopped
The message that the supervisor will send in response to all messages while its child is stopped.
- Definition Classes
- ExtendedBackoffOptions
- abstract def withSupervisorStrategy(supervisorStrategy: OneForOneStrategy): BackoffOnFailureOptions
Returns a new BackoffOptions with the supervisorStrategy.
Returns a new BackoffOptions with the supervisorStrategy.
- 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. As the BackoffSupervisor creates a separate actor to handle the backoff process, only a OneForOneStrategy makes sense here. Note that changing the strategy will replace the previously defined maxNrOfRetries.
- Definition Classes
- ExtendedBackoffOptions