c

akka.actor.typed

RestartSupervisorStrategy

sealed abstract class RestartSupervisorStrategy extends SupervisorStrategy

Not for user extension

Annotations
@DoNotInherit()
Source
SupervisorStrategy.scala
Linear Supertypes
SupervisorStrategy, AnyRef, Any
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
    Definition Classes
    → SupervisorStrategy
  6. abstract def withLoggingEnabled(enabled: Boolean): RestartSupervisorStrategy
    Definition Classes
    → SupervisorStrategy
  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 akka.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