Package org.apache.pekko.pattern

Class BackoffSupervisor

java.lang.Object

org.apache.pekko.pattern.internal.BackoffOnStopSupervisor

org.apache.pekko.pattern.BackoffSupervisor

public final class BackoffSupervisor
extends org.apache.pekko.pattern.internal.BackoffOnStopSupervisor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackoffSupervisor.CurrentChild	Send this message to the BackoffSupervisor and it will reply with BackoffSupervisor.CurrentChild containing the ActorRef of the current child, if any.
static class	BackoffSupervisor.CurrentChild$
static class	BackoffSupervisor.GetCurrentChild$	Send this message to the BackoffSupervisor and it will reply with BackoffSupervisor.CurrentChild containing the ActorRef of the current child, if any.
static class	BackoffSupervisor.GetRestartCount$	Send this message to the BackoffSupervisor and it will reply with BackoffSupervisor.RestartCount containing the current restart count.
static class	BackoffSupervisor.Reset$	Send this message to the BackoffSupervisor and it will reset the back-off.
static class	BackoffSupervisor.ResetRestartCount$
static class	BackoffSupervisor.RestartCount
static class	BackoffSupervisor.RestartCount$
static class	BackoffSupervisor.StartChild$	INTERNAL API

Constructor Summary

Constructors

Constructor	Description
BackoffSupervisor(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor)	Deprecated. Use `BackoffSupervisor.props` method instead.
BackoffSupervisor(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor, SupervisorStrategy supervisorStrategy)	Deprecated. Use `BackoffSupervisor.props` method instead.
BackoffSupervisor(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, BackoffReset reset, double randomFactor, SupervisorStrategy strategy, scala.Option<java.lang.Object> replyWhileStopped)	Deprecated. Use `BackoffSupervisor.props` method instead.
BackoffSupervisor(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, BackoffReset reset, double randomFactor, SupervisorStrategy strategy, scala.Option<java.lang.Object> replyWhileStopped, scala.Option<scala.Function1<java.lang.Object,java.lang.Object>> finalStopMessage)	Deprecated. Use `BackoffSupervisor.props` method instead.

Method Summary

Modifier and Type	Method	Description
java.lang.String	childName()
Props	childProps()
scala.Option<scala.Function1<java.lang.Object,java.lang.Object>>	finalStopMessage()
static BackoffSupervisor.GetCurrentChild$	getCurrentChild()	Java API: Send this message to the BackoffSupervisor and it will reply with BackoffSupervisor.CurrentChild containing the ActorRef of the current child, if any.
static BackoffSupervisor.GetRestartCount$	getRestartCount()	Java API: Send this message to the BackoffSupervisor and it will reply with BackoffSupervisor.RestartCount containing the current restart count.
static Props	props(Props childProps, java.lang.String childName, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor)	Deprecated. Use props with BackoffOpts instead.
static 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.
static 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.
static 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.
static Props	props(BackoffOnFailureOptions options)	Props for creating a BackoffSupervisor actor from BackoffOnFailureOptions.
static Props	props(BackoffOnStopOptions options)	Props for creating a BackoffSupervisor actor from BackoffOnStopOptions.
static Props	props(BackoffOptions options)	Deprecated. Use new API from BackoffOpts object instead.
static 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.
static 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.
scala.Option<java.lang.Object>	replyWhileStopped()
BackoffReset	reset()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackoffSupervisor

public BackoffSupervisor(Props childProps,
                         java.lang.String childName,
                         scala.concurrent.duration.FiniteDuration minBackoff,
                         scala.concurrent.duration.FiniteDuration maxBackoff,
                         BackoffReset reset,
                         double randomFactor,
                         SupervisorStrategy strategy,
                         scala.Option<java.lang.Object> replyWhileStopped,
                         scala.Option<scala.Function1<java.lang.Object,java.lang.Object>> finalStopMessage)

Deprecated.

Use `BackoffSupervisor.props` method instead. Since Akka 2.5.22.

BackoffSupervisor

public BackoffSupervisor(Props childProps,
                         java.lang.String childName,
                         scala.concurrent.duration.FiniteDuration minBackoff,
                         scala.concurrent.duration.FiniteDuration maxBackoff,
                         BackoffReset reset,
                         double randomFactor,
                         SupervisorStrategy strategy,
                         scala.Option<java.lang.Object> replyWhileStopped)

Deprecated.

Use `BackoffSupervisor.props` method instead. Since Akka 2.5.22.

BackoffSupervisor

public BackoffSupervisor(Props childProps,
                         java.lang.String childName,
                         scala.concurrent.duration.FiniteDuration minBackoff,
                         scala.concurrent.duration.FiniteDuration maxBackoff,
                         double randomFactor,
                         SupervisorStrategy supervisorStrategy)

Deprecated.

Use `BackoffSupervisor.props` method instead. Since Akka 2.5.22.

BackoffSupervisor

public BackoffSupervisor(Props childProps,
                         java.lang.String childName,
                         scala.concurrent.duration.FiniteDuration minBackoff,
                         scala.concurrent.duration.FiniteDuration maxBackoff,
                         double randomFactor)

Deprecated.

Use `BackoffSupervisor.props` method instead. Since Akka 2.5.22.

Method Detail

props

public static 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 Akka 2.5.22.

Props for creating a BackoffSupervisor 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(org.apache.pekko.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, org.apache.pekko.actor.SupervisorStrategy).

Parameters:

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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

props

public static 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 Akka 2.5.22.

Props for creating a BackoffSupervisor 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(org.apache.pekko.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, org.apache.pekko.actor.SupervisorStrategy).

Parameters:

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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

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.

props

public static 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 Akka 2.5.22.

Props for creating a BackoffSupervisor 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(org.apache.pekko.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, org.apache.pekko.actor.SupervisorStrategy).

Parameters:

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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

props

public static 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 Akka 2.5.22.

Props for creating a BackoffSupervisor 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(org.apache.pekko.actor.Props, java.lang.String, scala.concurrent.duration.FiniteDuration, scala.concurrent.duration.FiniteDuration, double, org.apache.pekko.actor.SupervisorStrategy).

Parameters:

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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

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.

propsWithSupervisorStrategy

public static 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 Akka 2.5.22.

Props for creating a BackoffSupervisor actor with a custom supervision strategy.

Exceptions in the child are handled with the given supervisionStrategy. A Restart will perform a normal immediate restart of the child. A Stop will stop the child, but it will be started again after the back-off duration.

Parameters:

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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

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.

propsWithSupervisorStrategy

public static 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 Akka 2.5.22.

Props for creating a BackoffSupervisor actor with a custom supervision strategy.

Exceptions in the child are handled with the given supervisionStrategy. A Restart will perform a normal immediate restart of the child. A Stop will stop the child, but it will be started again after the back-off duration.

Parameters:

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.2 adds up to 20% delay. In order to skip this additional delay pass in 0.

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.

props

public static Props props(BackoffOptions options)

Deprecated.

Use new API from BackoffOpts object instead. Since Akka 2.5.22.

Props for creating a BackoffSupervisor actor from BackoffOptions.

Parameters:

options - the BackoffOptions that specify how to construct a backoff-supervisor.

props

public static Props props(BackoffOnStopOptions options)

Props for creating a BackoffSupervisor actor from BackoffOnStopOptions.

Parameters:

options - the BackoffOnStopOptions that specify how to construct a backoff-supervisor.

props

public static Props props(BackoffOnFailureOptions options)

Props for creating a BackoffSupervisor actor from BackoffOnFailureOptions.

Parameters:

options - the BackoffOnFailureOptions that specify how to construct a backoff-supervisor.

getCurrentChild

public static BackoffSupervisor.GetCurrentChild$ getCurrentChild()

Java API: Send this message to the BackoffSupervisor and it will reply with BackoffSupervisor.CurrentChild containing the ActorRef of the current child, if any.

getRestartCount

public static BackoffSupervisor.GetRestartCount$ getRestartCount()

Java API: Send this message to the BackoffSupervisor and it will reply with BackoffSupervisor.RestartCount containing the current restart count.

childProps

public Props childProps()

childName

public java.lang.String childName()

reset

public BackoffReset reset()

replyWhileStopped

public scala.Option<java.lang.Object> replyWhileStopped()

finalStopMessage

public scala.Option<scala.Function1<java.lang.Object,java.lang.Object>> finalStopMessage()