Package org.apache.pekko.pattern

Class BackoffSupervisor

java.lang.Object

org.apache.pekko.pattern.BackoffSupervisor

public class BackoffSupervisor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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 final class	BackoffSupervisor.RestartCount
static class	BackoffSupervisor.RestartCount$
static class	BackoffSupervisor.StartChild$	INTERNAL API

Constructor Summary

Constructors

Constructor	Description
BackoffSupervisor()

Method Summary

Modifier and Type	Method	Description
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(BackoffOnFailureOptions options)	Props for creating a BackoffSupervisor actor from BackoffOnFailureOptions.
static Props	props(BackoffOnStopOptions options)	Props for creating a BackoffSupervisor actor from BackoffOnStopOptions.
static BackoffSupervisor.Reset$	reset()	Java API: Send this message to the BackoffSupervisor and it will reset the back-off.

Methods inherited from class java.lang.Object

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

Constructor Details

BackoffSupervisor

public BackoffSupervisor()

Method Details

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.

reset

public static BackoffSupervisor.Reset$ reset()

Java API: Send this message to the BackoffSupervisor and it will reset the back-off. This should be used in conjunction with withManualReset in BackoffOptions.

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.