BackoffOnStopOptions

org.apache.pekko.pattern.BackoffOnStopOptions
@DoNotInherit
sealed trait BackoffOnStopOptions

Attributes

Source
BackoffOptions.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

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

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

Attributes

Source
BackoffOptions.scala
def withFinalStopMessage(isFinalStopMessage: Any => Boolean): BackoffOnStopOptions

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 its self the supervisor will stop its self.

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 its self the supervisor will stop its self.

Attributes

Source
BackoffOptions.scala

Inherited and Abstract methods

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.

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.

Value parameters

resetBackoff

The back-off is reset if the child does not crash within this duration.

Attributes

Inherited from:
ExtendedBackoffOptions (hidden)
Source
BackoffOptions.scala

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 replaces deadLetters allowing to implement custom handling instead of a static reply.

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 replaces deadLetters allowing to implement custom handling instead of a static reply.

Value parameters

handler

PartialFunction of the received message and sender

Attributes

Inherited from:
ExtendedBackoffOptions (hidden)
Source
BackoffOptions.scala

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

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

Attributes

Inherited from:
ExtendedBackoffOptions (hidden)
Source
BackoffOptions.scala

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.

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.

Value parameters

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.

Attributes

Inherited from:
ExtendedBackoffOptions (hidden)
Source
BackoffOptions.scala
def withReplyWhileStopped(replyWhileStopped: Any): BackoffOnStopOptions

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.

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.

Value parameters

replyWhileStopped

The message that the supervisor will send in response to all messages while its child is stopped.

Attributes

Inherited from:
ExtendedBackoffOptions (hidden)
Source
BackoffOptions.scala

Returns a new BackoffOptions with the supervisorStrategy.

Returns a new BackoffOptions with the supervisorStrategy.

Value parameters

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.

Attributes

Inherited from:
ExtendedBackoffOptions (hidden)
Source
BackoffOptions.scala