Class BackoffSupervisor$
- java.lang.Object
-
- akka.pattern.BackoffSupervisor$
-
public class BackoffSupervisor$ extends java.lang.Object
Props for creating aBackoffSupervisor
actor.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(akka.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, akka.actor.SupervisorStrategy)
.param: childProps the
Props
of the child actor that will be started and supervised param: childName name of the child actor param: minBackoff minimum (initial) duration until the child actor will started again, if it is terminated param: maxBackoff the exponential back-off is capped to this duration param: randomFactor after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.
-
-
Field Summary
Fields Modifier and Type Field Description static BackoffSupervisor$
MODULE$
Static reference to the singleton instance of this Scala object.
-
Constructor Summary
Constructors Constructor Description BackoffSupervisor$()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description scala.concurrent.duration.FiniteDuration
calculateDelay(int restartCount, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor)
BackoffSupervisor.GetCurrentChild$
getCurrentChild()
BackoffSupervisor.GetRestartCount$
getRestartCount()
Props
props(Props childProps, java.lang.String childName, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor)
Deprecated.Use props with BackoffOpts instead.Props
props(Props childProps, java.lang.String childName, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxNrOfRetries)
Deprecated.Use props with BackoffOpts instead.Props
props(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor)
Deprecated.Use props with BackoffOpts instead.Props
props(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxNrOfRetries)
Deprecated.Use props with BackoffOpts instead.Props
props(BackoffOnFailureOptions options)
Props for creating aBackoffSupervisor
actor fromBackoffOnFailureOptions
.Props
props(BackoffOnStopOptions options)
Props for creating aBackoffSupervisor
actor fromBackoffOnStopOptions
.Props
props(BackoffOptions options)
Deprecated.Use new API from BackoffOpts object instead.Props
propsWithSupervisorStrategy(Props childProps, java.lang.String childName, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, SupervisorStrategy strategy)
Deprecated.Use props with BackoffOpts instead.Props
propsWithSupervisorStrategy(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, SupervisorStrategy strategy)
Deprecated.Use props with BackoffOpts instead.BackoffSupervisor.Reset$
reset()
-
-
-
Field Detail
-
MODULE$
public static final BackoffSupervisor$ MODULE$
Static reference to the singleton instance of this Scala object.
-
-
Method Detail
-
props
public Props props(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor)
Deprecated.Use props with BackoffOpts instead. Since 2.5.22.
-
props
public Props props(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, int maxNrOfRetries)
Deprecated.Use props with BackoffOpts instead. Since 2.5.22.Props for creating aBackoffSupervisor
actor.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(akka.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, akka.actor.SupervisorStrategy)
.- Parameters:
childProps
- theProps
of the child actor that will be started and supervisedchildName
- name of the child actorminBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds 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
.- Returns:
- (undocumented)
-
props
public Props props(Props childProps, java.lang.String childName, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor)
Deprecated.Use props with BackoffOpts instead. Since 2.5.22.Props for creating aBackoffSupervisor
actor.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(akka.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, akka.actor.SupervisorStrategy)
.- Parameters:
childProps
- theProps
of the child actor that will be started and supervisedchildName
- name of the child actorminBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.- Returns:
- (undocumented)
-
props
public Props props(Props childProps, java.lang.String childName, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, int maxNrOfRetries)
Deprecated.Use props with BackoffOpts instead. Since 2.5.22.Props for creating aBackoffSupervisor
actor.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(akka.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, akka.actor.SupervisorStrategy)
.- Parameters:
childProps
- theProps
of the child actor that will be started and supervisedchildName
- name of the child actorminBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds 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
.- Returns:
- (undocumented)
-
propsWithSupervisorStrategy
public Props propsWithSupervisorStrategy(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, SupervisorStrategy strategy)
Deprecated.Use props with BackoffOpts instead. Since 2.5.22.Props for creating aBackoffSupervisor
actor with a custom supervision strategy.Exceptions in the child are handled with the given
supervisionStrategy
. ARestart
will perform a normal immediate restart of the child. AStop
will stop the child, but it will be started again after the back-off duration.- Parameters:
childProps
- theProps
of the child actor that will be started and supervisedchildName
- name of the child actorminBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds 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 aOneForOneStrategy
makes sense here.- Returns:
- (undocumented)
-
propsWithSupervisorStrategy
public Props propsWithSupervisorStrategy(Props childProps, java.lang.String childName, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, SupervisorStrategy strategy)
Deprecated.Use props with BackoffOpts instead. Since 2.5.22.Props for creating aBackoffSupervisor
actor with a custom supervision strategy.Exceptions in the child are handled with the given
supervisionStrategy
. ARestart
will perform a normal immediate restart of the child. AStop
will stop the child, but it will be started again after the back-off duration.- Parameters:
childProps
- theProps
of the child actor that will be started and supervisedchildName
- name of the child actorminBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds 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 aOneForOneStrategy
makes sense here.- Returns:
- (undocumented)
-
props
public Props props(BackoffOptions options)
Deprecated.Use new API from BackoffOpts object instead. Since 2.5.22.Props for creating aBackoffSupervisor
actor fromBackoffOptions
.- Parameters:
options
- theBackoffOptions
that specify how to construct a backoff-supervisor.- Returns:
- (undocumented)
-
props
public Props props(BackoffOnStopOptions options)
Props for creating aBackoffSupervisor
actor fromBackoffOnStopOptions
.- Parameters:
options
- theBackoffOnStopOptions
that specify how to construct a backoff-supervisor.- Returns:
- (undocumented)
-
props
public Props props(BackoffOnFailureOptions options)
Props for creating aBackoffSupervisor
actor fromBackoffOnFailureOptions
.- Parameters:
options
- theBackoffOnFailureOptions
that specify how to construct a backoff-supervisor.- Returns:
- (undocumented)
-
getCurrentChild
public BackoffSupervisor.GetCurrentChild$ getCurrentChild()
-
reset
public BackoffSupervisor.Reset$ reset()
-
getRestartCount
public BackoffSupervisor.GetRestartCount$ getRestartCount()
-
calculateDelay
public scala.concurrent.duration.FiniteDuration calculateDelay(int restartCount, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor)
-
-