object BackoffSupervisor
- Source
- BackoffSupervisor.scala
- Alphabetic
- By Inheritance
- BackoffSupervisor
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class CurrentChild(ref: Option[ActorRef]) extends Product with Serializable
Send this message to the
BackoffSupervisorand it will reply with BackoffSupervisor.CurrentChild containing theActorRefof the current child, if any. - final case class RestartCount(count: Int) extends Product with Serializable
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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]) @native() @HotSpotIntrinsicCandidate()
- 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
- @native() @HotSpotIntrinsicCandidate()
- def getCurrentChild: GetCurrentChild
Java API: Send this message to the
BackoffSupervisorand it will reply with BackoffSupervisor.CurrentChild containing theActorRefof the current child, if any. - def getRestartCount: GetRestartCount
Java API: Send this message to the
BackoffSupervisorand it will reply with BackoffSupervisor.RestartCount containing the current restart count. - def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def props(options: BackoffOnFailureOptions): Props
Props for creating a
BackoffSupervisoractor from BackoffOnFailureOptions.Props for creating a
BackoffSupervisoractor from BackoffOnFailureOptions.- options
the BackoffOnFailureOptions that specify how to construct a backoff-supervisor.
- def props(options: BackoffOnStopOptions): Props
Props for creating a
BackoffSupervisoractor from BackoffOnStopOptions.Props for creating a
BackoffSupervisoractor from BackoffOnStopOptions.- options
the BackoffOnStopOptions that specify how to construct a backoff-supervisor.
- def reset: Reset
Java API: Send this message to the
BackoffSupervisorand it will reset the back-off.Java API: Send this message to the
BackoffSupervisorand it will reset the back-off. This should be used in conjunction withwithManualResetin BackoffOptions. - 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])
- case object GetCurrentChild extends Product with Serializable
Send this message to the
BackoffSupervisorand it will reply with BackoffSupervisor.CurrentChild containing theActorRefof the current child, if any. - case object GetRestartCount extends Product with Serializable
Send this message to the
BackoffSupervisorand it will reply with BackoffSupervisor.RestartCount containing the current restart count. - case object Reset extends Product with Serializable
Send this message to the
BackoffSupervisorand it will reset the back-off.Send this message to the
BackoffSupervisorand it will reset the back-off. This should be used in conjunction withwithManualResetin BackoffOptions.
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated
- def props(options: BackoffOptions): Props
Props for creating a
BackoffSupervisoractor from BackoffOptions.Props for creating a
BackoffSupervisoractor from BackoffOptions.- options
the BackoffOptions that specify how to construct a backoff-supervisor.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use new API from BackoffOpts object instead
- def props(childProps: Props, childName: String, minBackoff: Duration, maxBackoff: Duration, randomFactor: Double, maxNrOfRetries: Int): Props
Props for creating a
BackoffSupervisoractor.Props for creating a
BackoffSupervisoractor.Exceptions in the child are handled with the default supervision strategy, i.e. most exceptions will immediately restart the child. You can define another supervision strategy by using #propsWithSupervisorStrategy.
- childProps
the pekko.actor.Props of the child actor that will be started and supervised
- childName
name of the child actor
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds up to20%delay. In order to skip this additional delay pass in0.- maxNrOfRetries
maximum number of attempts to restart the child actor. The supervisor will terminate itself after the maxNoOfRetries is reached. In order to restart infinitely pass in
-1.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use props with BackoffOpts instead
- def props(childProps: Props, childName: String, minBackoff: Duration, maxBackoff: Duration, randomFactor: Double): Props
Props for creating a
BackoffSupervisoractor.Props for creating a
BackoffSupervisoractor.Exceptions in the child are handled with the default supervision strategy, i.e. most exceptions will immediately restart the child. You can define another supervision strategy by using #propsWithSupervisorStrategy.
- childProps
the pekko.actor.Props of the child actor that will be started and supervised
- childName
name of the child actor
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds up to20%delay. In order to skip this additional delay pass in0.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use props with BackoffOpts instead
- def props(childProps: Props, childName: String, minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, maxNrOfRetries: Int): Props
Props for creating a
BackoffSupervisoractor.Props for creating a
BackoffSupervisoractor.Exceptions in the child are handled with the default supervision strategy, i.e. most exceptions will immediately restart the child. You can define another supervision strategy by using #propsWithSupervisorStrategy.
- childProps
the pekko.actor.Props of the child actor that will be started and supervised
- childName
name of the child actor
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds up to20%delay. In order to skip this additional delay pass in0.- maxNrOfRetries
maximum number of attempts to restart the child actor. The supervisor will terminate itself after the maxNoOfRetries is reached. In order to restart infinitely pass in
-1.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use props with BackoffOpts instead
- def props(childProps: Props, childName: String, minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double): Props
Props for creating a
BackoffSupervisoractor.Props for creating a
BackoffSupervisoractor.Exceptions in the child are handled with the default supervision strategy, i.e. most exceptions will immediately restart the child. You can define another supervision strategy by using #propsWithSupervisorStrategy.
- childProps
the pekko.actor.Props of the child actor that will be started and supervised
- childName
name of the child actor
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds up to20%delay. In order to skip this additional delay pass in0.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use props with BackoffOpts instead
- def propsWithSupervisorStrategy(childProps: Props, childName: String, minBackoff: Duration, maxBackoff: Duration, randomFactor: Double, strategy: SupervisorStrategy): Props
Props for creating a
BackoffSupervisoractor with a custom supervision strategy.Props for creating a
BackoffSupervisoractor with a custom supervision strategy.Exceptions in the child are handled with the given
supervisionStrategy. ARestartwill perform a normal immediate restart of the child. AStopwill stop the child, but it will be started again after the back-off duration.- childProps
the pekko.actor.Props of the child actor that will be started and supervised
- childName
name of the child actor
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds up to20%delay. In order to skip this additional delay pass in0.- strategy
the supervision strategy to use for handling exceptions in the child. As the BackoffSupervisor creates a separate actor to handle the backoff process, only a OneForOneStrategy makes sense here.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use props with BackoffOpts instead
- def propsWithSupervisorStrategy(childProps: Props, childName: String, minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double, strategy: SupervisorStrategy): Props
Props for creating a
BackoffSupervisoractor with a custom supervision strategy.Props for creating a
BackoffSupervisoractor with a custom supervision strategy.Exceptions in the child are handled with the given
supervisionStrategy. ARestartwill perform a normal immediate restart of the child. AStopwill stop the child, but it will be started again after the back-off duration.- childProps
the pekko.actor.Props of the child actor that will be started and supervised
- childName
name of the child actor
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.
0.2adds up to20%delay. In order to skip this additional delay pass in0.- strategy
the supervision strategy to use for handling exceptions in the child. As the BackoffSupervisor creates a separate actor to handle the backoff process, only a OneForOneStrategy makes sense here.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use props with BackoffOpts instead