sealed abstract class BackoffSupervisorStrategy extends SupervisorStrategy
Not for user extension
- Annotations
- @DoNotInherit()
- Source
- SupervisorStrategy.scala
- Alphabetic
- By Inheritance
- BackoffSupervisorStrategy
- SupervisorStrategy
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def getResetBackoffAfter: Duration
- abstract def logLevel: Level
- Definition Classes
- SupervisorStrategy
- abstract def loggingEnabled: Boolean
- Definition Classes
- SupervisorStrategy
- abstract def resetBackoffAfter: FiniteDuration
- abstract def withCriticalLogLevel(criticalLevel: Level, afterErrors: Int): BackoffSupervisorStrategy
Possibility to use another log level after a given number of errors.
Possibility to use another log level after a given number of errors. The initial errors are logged at the level defined with BackoffSupervisorStrategy.withLogLevel. For example, the first 3 errors can be logged at INFO level and thereafter at ERROR level.
The counter (and log level) is reset after the BackoffSupervisorStrategy.withResetBackoffAfter duration.
- abstract def withLogLevel(level: Level): BackoffSupervisorStrategy
- Definition Classes
- BackoffSupervisorStrategy → SupervisorStrategy
- abstract def withLoggingEnabled(enabled: Boolean): BackoffSupervisorStrategy
- Definition Classes
- BackoffSupervisorStrategy → SupervisorStrategy
- abstract def withMaxRestarts(maxRestarts: Int): BackoffSupervisorStrategy
Allow at most this number of failed restarts in a row.
Allow at most this number of failed restarts in a row. Zero or negative disables the upper limit on restarts (and is the default)
- abstract def withResetBackoffAfter(timeout: Duration): BackoffSupervisorStrategy
Java API: The back-off algorithm is reset if the actor does not crash within the specified
resetBackoffAfter
.Java API: The back-off algorithm is reset if the actor does not crash within the specified
resetBackoffAfter
. By default, theresetBackoffAfter
has the same value asminBackoff
. - abstract def withResetBackoffAfter(timeout: FiniteDuration): BackoffSupervisorStrategy
Scala API: The back-off algorithm is reset if the actor does not crash within the specified
resetBackoffAfter
.Scala API: The back-off algorithm is reset if the actor does not crash within the specified
resetBackoffAfter
. By default, theresetBackoffAfter
has the value of(minBackoff + maxBackoff) / 2
. - abstract def withStashCapacity(capacity: Int): BackoffSupervisorStrategy
While restarting (waiting for backoff to expire and children to stop) incoming messages and signals are stashed, and delivered later to the newly restarted behavior.
While restarting (waiting for backoff to expire and children to stop) incoming messages and signals are stashed, and delivered later to the newly restarted behavior. This property defines the capacity in number of messages of the stash buffer. If the capacity is exceed then additional incoming messages are dropped.
By default the capacity is defined by config property
pekko.actor.typed.restart-stash-capacity
. - abstract def withStopChildren(enabled: Boolean): BackoffSupervisorStrategy
Stop or keep child actors when the parent actor is restarted.
Stop or keep child actors when the parent actor is restarted. By default child actors are stopped when parent is restarted.
- enabled
if
true
then child actors are stopped, otherwise they are kept
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 BackoffSupervisorStrategy toany2stringadd[BackoffSupervisorStrategy] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (BackoffSupervisorStrategy, B)
- Implicit
- This member is added by an implicit conversion from BackoffSupervisorStrategy toArrowAssoc[BackoffSupervisorStrategy] 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (BackoffSupervisorStrategy) => Boolean, msg: => Any): BackoffSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from BackoffSupervisorStrategy toEnsuring[BackoffSupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (BackoffSupervisorStrategy) => Boolean): BackoffSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from BackoffSupervisorStrategy toEnsuring[BackoffSupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): BackoffSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from BackoffSupervisorStrategy toEnsuring[BackoffSupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): BackoffSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from BackoffSupervisorStrategy toEnsuring[BackoffSupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from BackoffSupervisorStrategy toStringFormat[BackoffSupervisorStrategy] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (BackoffSupervisorStrategy, B)
- Implicit
- This member is added by an implicit conversion from BackoffSupervisorStrategy toArrowAssoc[BackoffSupervisorStrategy] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.