c

org.apache.pekko.actor.typed

RestartSupervisorStrategy

sealed abstract class RestartSupervisorStrategy extends SupervisorStrategy

Not for user extension

Annotations
@DoNotInherit()
Source
SupervisorStrategy.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RestartSupervisorStrategy
  2. SupervisorStrategy
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def logLevel: Level
    Definition Classes
    SupervisorStrategy
  2. abstract def loggingEnabled: Boolean
    Definition Classes
    SupervisorStrategy
  3. 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 reaching maxNrOfRetries the 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

  4. 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 reaching maxNrOfRetries the 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

  5. abstract def withLogLevel(level: Level): RestartSupervisorStrategy
  6. abstract def withLoggingEnabled(enabled: Boolean): RestartSupervisorStrategy
  7. 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 pekko.actor.typed.restart-stash-capacity.

  8. 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 true then child actors are stopped, otherwise they are kept

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. 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
  9. 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
  10. 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
  11. 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
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. 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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

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

Inherited from SupervisorStrategy

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRestartSupervisorStrategy to any2stringadd[RestartSupervisorStrategy]

Inherited by implicit conversion StringFormat fromRestartSupervisorStrategy to StringFormat[RestartSupervisorStrategy]

Inherited by implicit conversion Ensuring fromRestartSupervisorStrategy to Ensuring[RestartSupervisorStrategy]

Inherited by implicit conversion ArrowAssoc fromRestartSupervisorStrategy to ArrowAssoc[RestartSupervisorStrategy]

Ungrouped