sealed abstract class RestartSupervisorStrategy extends SupervisorStrategy
Not for user extension
- Annotations
- @DoNotInherit()
- Source
- SupervisorStrategy.scala
- Alphabetic
- By Inheritance
- RestartSupervisorStrategy
- SupervisorStrategy
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def logLevel: Level
- Definition Classes
- SupervisorStrategy
- abstract def loggingEnabled: Boolean
- Definition Classes
- SupervisorStrategy
- abstract def withLimit(maxNrOfRetries: Int, withinTimeRange: Duration): RestartSupervisorStrategy
Java API: Restart with a limit of number of restart retries.
Java API: Restart with a limit of number of restart retries. The number of restarts are limited to a number of restart attempts (
maxNrOfRetries) within a time range (withinTimeRange). When the time window has elapsed without reachingmaxNrOfRetriesthe restart count is reset.The strategy is applied also if the actor behavior is deferred and throws an exception during startup.
- maxNrOfRetries
the number of times a child actor is allowed to be restarted, if the limit is exceeded the child actor is stopped
- withinTimeRange
duration of the time window for maxNrOfRetries
- abstract def withLimit(maxNrOfRetries: Int, withinTimeRange: FiniteDuration): RestartSupervisorStrategy
Scala API: Restart with a limit of number of restart retries.
Scala API: Restart with a limit of number of restart retries. The number of restarts are limited to a number of restart attempts (
maxNrOfRetries) within a time range (withinTimeRange). When the time window has elapsed without reachingmaxNrOfRetriesthe restart count is reset.The strategy is applied also if the actor behavior is deferred and throws an exception during startup.
- maxNrOfRetries
the number of times a child actor is allowed to be restarted, if the limit is exceeded the child actor is stopped
- withinTimeRange
duration of the time window for maxNrOfRetries
- abstract def withLogLevel(level: Level): RestartSupervisorStrategy
- Definition Classes
- RestartSupervisorStrategy → SupervisorStrategy
- abstract def withLoggingEnabled(enabled: Boolean): RestartSupervisorStrategy
- Definition Classes
- RestartSupervisorStrategy → SupervisorStrategy
- abstract def withStashCapacity(capacity: Int): RestartSupervisorStrategy
While restarting (waiting for children to stop) incoming messages and signals are stashed, and delivered later to the newly restarted behavior.
While restarting (waiting for 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
akka.actor.typed.restart-stash-capacity. - abstract def withStopChildren(enabled: Boolean): RestartSupervisorStrategy
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
truethen 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 RestartSupervisorStrategy toany2stringadd[RestartSupervisorStrategy] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (RestartSupervisorStrategy, B)
- Implicit
- This member is added by an implicit conversion from RestartSupervisorStrategy toArrowAssoc[RestartSupervisorStrategy] 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: (RestartSupervisorStrategy) => Boolean, msg: => Any): RestartSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from RestartSupervisorStrategy toEnsuring[RestartSupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (RestartSupervisorStrategy) => Boolean): RestartSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from RestartSupervisorStrategy toEnsuring[RestartSupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): RestartSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from RestartSupervisorStrategy toEnsuring[RestartSupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): RestartSupervisorStrategy
- Implicit
- This member is added by an implicit conversion from RestartSupervisorStrategy toEnsuring[RestartSupervisorStrategy] 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 RestartSupervisorStrategy toStringFormat[RestartSupervisorStrategy] 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,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (RestartSupervisorStrategy, B)
- Implicit
- This member is added by an implicit conversion from RestartSupervisorStrategy toArrowAssoc[RestartSupervisorStrategy] 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.