Packages

abstract class SupervisorStrategy extends AnyRef

An Akka SupervisorStrategy is the policy to apply for crashing children.

IMPORTANT:

You should not normally need to create new subclasses, instead use the existing akka.actor.OneForOneStrategy or akka.actor.AllForOneStrategy, but if you do, please read the docs of the methods below carefully, as incorrect implementations may lead to “blocked” actor systems (i.e. permanently suspended actors).

Source
FaultHandling.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AllForOneStrategy, OneForOneStrategy, ClusterMetricsStrategy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SupervisorStrategy
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SupervisorStrategy()

Abstract Value Members

  1. abstract def decider: Decider

    Returns the Decider that is associated with this SupervisorStrategy.

    Returns the Decider that is associated with this SupervisorStrategy. The Decider is invoked by the default implementation of handleFailure to obtain the Directive to be applied.

  2. abstract def handleChildTerminated(context: ActorContext, child: ActorRef, children: Iterable[ActorRef]): Unit

    This method is called after the child has been removed from the set of children.

    This method is called after the child has been removed from the set of children. It does not need to do anything special. Exceptions thrown from this method do NOT make the actor fail if this happens during termination.

  3. abstract def processFailure(context: ActorContext, restart: Boolean, child: ActorRef, cause: Throwable, stats: ChildRestartStats, children: Iterable[ChildRestartStats]): Unit

    This method is called to act on the failure of a child: restart if the flag is true, stop otherwise.

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 SupervisorStrategy to any2stringadd[SupervisorStrategy] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SupervisorStrategy, B)
    Implicit
    This member is added by an implicit conversion from SupervisorStrategy to ArrowAssoc[SupervisorStrategy] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (SupervisorStrategy) ⇒ Boolean, msg: ⇒ Any): SupervisorStrategy
    Implicit
    This member is added by an implicit conversion from SupervisorStrategy to Ensuring[SupervisorStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (SupervisorStrategy) ⇒ Boolean): SupervisorStrategy
    Implicit
    This member is added by an implicit conversion from SupervisorStrategy to Ensuring[SupervisorStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): SupervisorStrategy
    Implicit
    This member is added by an implicit conversion from SupervisorStrategy to Ensuring[SupervisorStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): SupervisorStrategy
    Implicit
    This member is added by an implicit conversion from SupervisorStrategy to Ensuring[SupervisorStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SupervisorStrategy to StringFormat[SupervisorStrategy] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def handleFailure(context: ActorContext, child: ActorRef, cause: Throwable, stats: ChildRestartStats, children: Iterable[ChildRestartStats]): Boolean

    This is the main entry point: in case of a child’s failure, this method must try to handle the failure by resuming, restarting or stopping the child (and returning true), or it returns false to escalate the failure, which will lead to this actor re-throwing the exception which caused the failure.

    This is the main entry point: in case of a child’s failure, this method must try to handle the failure by resuming, restarting or stopping the child (and returning true), or it returns false to escalate the failure, which will lead to this actor re-throwing the exception which caused the failure. The exception will not be wrapped.

    This method calls akka.actor.SupervisorStrategy#logFailure, which will log the failure unless it is escalated. You can customize the logging by setting akka.actor.SupervisorStrategy#loggingEnabled to false and do the logging inside the decider or override the logFailure method.

    children

    is a lazy collection (a view)

  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def logFailure(context: ActorContext, child: ActorRef, cause: Throwable, decision: Directive): Unit

    Default logging of actor failures when akka.actor.SupervisorStrategy#loggingEnabled is true.

    Default logging of actor failures when akka.actor.SupervisorStrategy#loggingEnabled is true. Escalate failures are not logged here, since they are supposed to be handled at a level higher up in the hierarchy. Resume failures are logged at Warning level. Stop and Restart failures are logged at Error level.

  21. def loggingEnabled: Boolean

    Logging of actor failures is done when this is true.

    Logging of actor failures is done when this is true.

    Attributes
    protected
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. final def restartChild(child: ActorRef, cause: Throwable, suspendFirst: Boolean): Unit

    Restart the given child, possibly suspending it first.

    Restart the given child, possibly suspending it first.

    IMPORTANT:

    If the child is the currently failing one, it will already have been suspended, hence suspendFirst must be false. If the child is not the currently failing one, then it did not request this treatment and is therefore not prepared to be resumed without prior suspend.

  26. final def resumeChild(child: ActorRef, cause: Throwable): Unit

    Resume the previously failed child: do never apply this to a child which is not the currently failing child.

    Resume the previously failed child: do never apply this to a child which is not the currently failing child. Suspend/resume needs to be done in matching pairs, otherwise actors will wake up too soon or never at all.

  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def →[B](y: B): (SupervisorStrategy, B)
    Implicit
    This member is added by an implicit conversion from SupervisorStrategy to ArrowAssoc[SupervisorStrategy] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SupervisorStrategy to any2stringadd[SupervisorStrategy]

Inherited by implicit conversion StringFormat from SupervisorStrategy to StringFormat[SupervisorStrategy]

Inherited by implicit conversion Ensuring from SupervisorStrategy to Ensuring[SupervisorStrategy]

Inherited by implicit conversion ArrowAssoc from SupervisorStrategy to ArrowAssoc[SupervisorStrategy]

Ungrouped