sealed trait BackoffOnStopOptions extends ExtendedBackoffOptions[BackoffOnStopOptions]
- Annotations
- @DoNotInherit()
- Source
- BackoffOptions.scala
- Alphabetic
- By Inheritance
- BackoffOnStopOptions
- ExtendedBackoffOptions
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
withAutoReset(resetBackoff: FiniteDuration): BackoffOnStopOptions
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
withDefaultStoppingStrategy: BackoffOnStopOptions
Returns a new BackoffOptions with a default
SupervisorStrategy.stoppingStrategy
.Returns a new BackoffOptions with a default
SupervisorStrategy.stoppingStrategy
. The default supervisor strategy is used as fallback for throwables not handled bySupervisorStrategy.stoppingStrategy
. -
abstract
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.
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.
-
abstract
def
withManualReset: BackoffOnStopOptions
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): BackoffOnStopOptions
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): BackoffOnStopOptions
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): BackoffOnStopOptions
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
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to any2stringadd[BackoffOnStopOptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (BackoffOnStopOptions, B)
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to ArrowAssoc[BackoffOnStopOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (BackoffOnStopOptions) ⇒ Boolean, msg: ⇒ Any): BackoffOnStopOptions
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to Ensuring[BackoffOnStopOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BackoffOnStopOptions) ⇒ Boolean): BackoffOnStopOptions
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to Ensuring[BackoffOnStopOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BackoffOnStopOptions
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to Ensuring[BackoffOnStopOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BackoffOnStopOptions
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to Ensuring[BackoffOnStopOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to StringFormat[BackoffOnStopOptions] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (BackoffOnStopOptions, B)
- Implicit
- This member is added by an implicit conversion from BackoffOnStopOptions to ArrowAssoc[BackoffOnStopOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc