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
- Alphabetic
- By Inheritance
- SupervisorStrategy
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SupervisorStrategy()
Abstract Value Members
- 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
handleFailureto obtain the Directive to be applied. - 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.
- 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
- 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 SupervisorStrategy toany2stringadd[SupervisorStrategy] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (SupervisorStrategy, B)
- Implicit
- This member is added by an implicit conversion from SupervisorStrategy toArrowAssoc[SupervisorStrategy] 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: (SupervisorStrategy) => Boolean, msg: => Any): SupervisorStrategy
- Implicit
- This member is added by an implicit conversion from SupervisorStrategy toEnsuring[SupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (SupervisorStrategy) => Boolean): SupervisorStrategy
- Implicit
- This member is added by an implicit conversion from SupervisorStrategy toEnsuring[SupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): SupervisorStrategy
- Implicit
- This member is added by an implicit conversion from SupervisorStrategy toEnsuring[SupervisorStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): SupervisorStrategy
- Implicit
- This member is added by an implicit conversion from SupervisorStrategy toEnsuring[SupervisorStrategy] 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 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 returnsfalseto 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 returnsfalseto 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
falseand do the logging inside thedecideror override thelogFailuremethod.- children
is a lazy collection (a view)
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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.Escalatefailures are not logged here, since they are supposed to be handled at a level higher up in the hierarchy.Resumefailures are logged atWarninglevel.StopandRestartfailures are logged atErrorlevel. - 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
- 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 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
suspendFirstmust 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. - 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.
- 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 SupervisorStrategy toStringFormat[SupervisorStrategy] 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): (SupervisorStrategy, B)
- Implicit
- This member is added by an implicit conversion from SupervisorStrategy toArrowAssoc[SupervisorStrategy] 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.