Package akka.actor.typed

Class SupervisorStrategy$

java.lang.Object

akka.actor.typed.SupervisorStrategy$

public class SupervisorStrategy$
extends java.lang.Object

Resume means keeping the same state as before the exception was thrown and is thus less safe than restart.

If the actor behavior is deferred and throws an exception on startup the actor is stopped (restarting would be dangerous as it could lead to an infinite restart-loop)

Field Summary

Fields

Modifier and Type	Field	Description
static SupervisorStrategy$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
SupervisorStrategy$()

Method Summary

Modifier and Type	Method	Description
RestartSupervisorStrategy	restart()	Restart immediately without any limit on number of restart retries.
BackoffSupervisorStrategy	restartWithBackoff(java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor)	Java API: It supports exponential back-off between the given minBackoff and maxBackoff durations.
BackoffSupervisorStrategy	restartWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, double randomFactor)	Scala API: It supports exponential back-off between the given minBackoff and maxBackoff durations.
SupervisorStrategy	resume()
SupervisorStrategy	stop()	Stop the actor

Methods inherited from class java.lang.Object

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

Field Detail

MODULE$

public static final SupervisorStrategy$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

SupervisorStrategy$

public SupervisorStrategy$()

Method Detail

resume

public SupervisorStrategy resume()

restart

public RestartSupervisorStrategy restart()

Restart immediately without any limit on number of restart retries. A limit can be added with RestartSupervisorStrategy.withLimit.

If the actor behavior is deferred and throws an exception on startup the actor is stopped (restarting would be dangerous as it could lead to an infinite restart-loop)

Returns:

(undocumented)

stop

public SupervisorStrategy stop()

Stop the actor

Returns:

(undocumented)

restartWithBackoff

public BackoffSupervisorStrategy restartWithBackoff(scala.concurrent.duration.FiniteDuration minBackoff,
                                                    scala.concurrent.duration.FiniteDuration maxBackoff,
                                                    double randomFactor)

Scala API: It supports exponential back-off between the given minBackoff and maxBackoff durations. For example, if minBackoff is 3 seconds and maxBackoff 30 seconds the start attempts will be delayed with 3, 6, 12, 24, 30, 30 seconds. The exponential back-off counter is reset if the actor is not terminated within the minBackoff duration.

In addition to the calculated exponential back-off an additional random delay based the given randomFactor is added, e.g. 0.2 adds up to 20% delay. The reason for adding a random delay is to avoid that all failing actors hit the backend resource at the same time.

During the back-off incoming messages are dropped.

If no new exception occurs within the minBackoff duration the exponentially increased back-off timeout is reset.

The strategy is applied also if the actor behavior is deferred and throws an exception during startup.

A maximum number of restarts can be specified with Backoff#withMaxRestarts

Parameters:

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.

Returns:

(undocumented)

restartWithBackoff

public BackoffSupervisorStrategy restartWithBackoff(java.time.Duration minBackoff,
                                                    java.time.Duration maxBackoff,
                                                    double randomFactor)

Java API: It supports exponential back-off between the given minBackoff and maxBackoff durations. For example, if minBackoff is 3 seconds and maxBackoff 30 seconds the start attempts will be delayed with 3, 6, 12, 24, 30, 30 seconds. The exponential back-off counter is reset if the actor is not terminated within the minBackoff duration.

In addition to the calculated exponential back-off an additional random delay based the given randomFactor is added, e.g. 0.2 adds up to 20% delay. The reason for adding a random delay is to avoid that all failing actors hit the backend resource at the same time.

During the back-off incoming messages are dropped.

If no new exception occurs within the minBackoff duration the exponentially increased back-off timeout is reset.

The strategy is applied also if the actor behavior is deferred and throws an exception during startup.

Parameters:

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.

Returns:

(undocumented)