Packages

final class BackoffSupervisor extends BackoffOnStopSupervisor

Source
BackoffSupervisor.scala
Linear Supertypes
BackoffOnStopSupervisor, ActorLogging, HandleBackoff, Actor, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BackoffSupervisor
  2. BackoffOnStopSupervisor
  3. ActorLogging
  4. HandleBackoff
  5. Actor
  6. AnyRef
  7. 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

Instance Constructors

  1. new BackoffSupervisor(childProps: Props, childName: String, minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double)
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.5.22) Use BackoffSupervisor.props method instead

  2. new BackoffSupervisor(childProps: Props, childName: String, minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, supervisorStrategy: SupervisorStrategy)
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.5.22) Use BackoffSupervisor.props method instead

  3. new BackoffSupervisor(childProps: Props, childName: String, minBackoff: FiniteDuration, maxBackoff: FiniteDuration, reset: BackoffReset, randomFactor: Double, strategy: SupervisorStrategy, replyWhileStopped: Option[Any])
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.5.22) Use BackoffSupervisor.props method instead

  4. new BackoffSupervisor(childProps: Props, childName: String, minBackoff: FiniteDuration, maxBackoff: FiniteDuration, reset: BackoffReset, randomFactor: Double, strategy: SupervisorStrategy, replyWhileStopped: Option[Any], finalStopMessage: Option[(Any) => Boolean])
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.5.22) Use BackoffSupervisor.props method instead

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

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 BackoffSupervisor toany2stringadd[BackoffSupervisor] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BackoffSupervisor, B)
    Implicit
    This member is added by an implicit conversion from BackoffSupervisor toArrowAssoc[BackoffSupervisor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  7. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postStop. Calls postStop by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preRestart. Calls preRestart by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preStart. Calls preStart by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  10. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to this actor's current behavior.

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. val child: Option[ActorRef]
    Definition Classes
    HandleBackoff
  13. val childName: String
    Definition Classes
    BackoffSupervisor → BackoffOnStopSupervisor → HandleBackoff
  14. val childProps: Props
    Definition Classes
    BackoffSupervisor → BackoffOnStopSupervisor → HandleBackoff
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  16. implicit val context: ActorContext

    Scala API: Stores the context for this actor, including self, and sender.

    Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    pekko.actor.ActorContext is the Scala API. getContext returns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  17. def ensuring(cond: (BackoffSupervisor) => Boolean, msg: => Any): BackoffSupervisor
    Implicit
    This member is added by an implicit conversion from BackoffSupervisor toEnsuring[BackoffSupervisor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (BackoffSupervisor) => Boolean): BackoffSupervisor
    Implicit
    This member is added by an implicit conversion from BackoffSupervisor toEnsuring[BackoffSupervisor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: => Any): BackoffSupervisor
    Implicit
    This member is added by an implicit conversion from BackoffSupervisor toEnsuring[BackoffSupervisor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): BackoffSupervisor
    Implicit
    This member is added by an implicit conversion from BackoffSupervisor toEnsuring[BackoffSupervisor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. val finalStopMessage: Option[(Any) => Boolean]
  24. val finalStopMessageReceived: Boolean
    Definition Classes
    HandleBackoff
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. def handleBackoff: actor.Actor.Receive
    Definition Classes
    HandleBackoff
  27. def handleMessageToChild(msg: Any): Unit
    Attributes
    protected
    Definition Classes
    BackoffOnStopSupervisor → HandleBackoff
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  34. def onTerminated: Receive
    Definition Classes
    BackoffOnStopSupervisor
  35. def postRestart(reason: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    reason

    the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  36. def postStop(): Unit

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  37. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  38. def preStart(): Unit
    Definition Classes
    HandleBackoff
  39. def receive: Receive

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    BackoffOnStopSupervisor → Actor
  40. val replyWhileStopped: Option[Any]
  41. val reset: BackoffReset
    Definition Classes
    BackoffSupervisor → BackoffOnStopSupervisor → HandleBackoff
  42. val restartCount: Int
    Definition Classes
    HandleBackoff
  43. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself: 

    self ! message

    Definition Classes
    Actor
  44. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  45. def startChild(): Unit
    Definition Classes
    HandleBackoff
  46. val supervisorStrategy: SupervisorStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    BackoffOnStopSupervisor → Actor
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toString(): String
    Definition Classes
    AnyRef → Any
  49. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream

    Definition Classes
    Actor
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. 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 BackoffSupervisor toStringFormat[BackoffSupervisor] 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): (BackoffSupervisor, B)
    Implicit
    This member is added by an implicit conversion from BackoffSupervisor toArrowAssoc[BackoffSupervisor] 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 BackoffOnStopSupervisor

Inherited from ActorLogging

Inherited from HandleBackoff

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBackoffSupervisor to any2stringadd[BackoffSupervisor]

Inherited by implicit conversion StringFormat fromBackoffSupervisor to StringFormat[BackoffSupervisor]

Inherited by implicit conversion Ensuring fromBackoffSupervisor to Ensuring[BackoffSupervisor]

Inherited by implicit conversion ArrowAssoc fromBackoffSupervisor to ArrowAssoc[BackoffSupervisor]

Ungrouped