 | BackoffSupervisor Class |
Actor used to supervise actors with ability to restart them after back-off timeout occurred.
It's designed for cases when i.e. persistent actor stops due to journal unavailability or failure.
In this case it better to wait before restart.
Inheritance HierarchyNamespace: Akka.Pattern
Assembly: Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
SyntaxThe BackoffSupervisor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BackoffSupervisor(Props, String, TimeSpan, TimeSpan, Double) | Initializes a new instance of the BackoffSupervisor class |
| BackoffSupervisor(Props, String, TimeSpan, TimeSpan, IBackoffReset, Double, SupervisorStrategy) | Initializes a new instance of the BackoffSupervisor class |
Properties| Name | Description | |
|---|---|---|
 | Child | (Inherited from BackoffSupervisorBase.) |
| ChildName | (Inherited from BackoffSupervisorBase.) |
| ChildProps | (Inherited from BackoffSupervisorBase.) |
| Reset | (Inherited from BackoffSupervisorBase.) |
| RestartCountN | (Inherited from BackoffSupervisorBase.) |
| Self |
Gets the self ActorRef
(Inherited from ActorBase.) |
| Sender |
Gets the sending ActorRef of the current message
(Inherited from ActorBase.) |
Methods| Name | Description | |
|---|---|---|
| AroundPostRestart |
Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default.
(Inherited from ActorBase.) |
| AroundPostStop |
Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default..
(Inherited from ActorBase.) |
| AroundPreRestart |
Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default.
(Inherited from ActorBase.) |
| AroundPreStart |
Can be overridden to intercept calls to `PreStart`. Calls `PreStart` by default.
(Inherited from ActorBase.) |
 | AroundReceive |
TBD
(Inherited from ActorBase.) |
| Become |
Changes the actor's command behavior and replaces the current receive handler with the specified handler.
(Inherited from ActorBase.) |
| BecomeStacked |
Changes the actor's behavior and replaces the current receive handler with the specified handler.
The current handler is stored on a stack, and you can revert to it by calling UnbecomeStacked (Inherited from ActorBase.)RemarksPlease note, that in order to not leak memory, make sure every call to BecomeStacked(Receive)
is matched with a call to UnbecomeStacked. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HandleBackoff | (Inherited from BackoffSupervisorBase.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PostRestart |
User overridable callback: By default it calls `PreStart()`.
Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
(Inherited from ActorBase.) |
| PostStop |
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked.
Empty default implementation.
(Inherited from ActorBase.) |
| PreRestart |
User overridable callback: '''By default it disposes of all children and then calls `postStop()`.'''
Is called on a crashed Actor right BEFORE it is restarted to allow clean
up of resources before Actor is terminated.
(Inherited from ActorBase.) |
| PreStart | (Inherited from BackoffSupervisorBase.) |
 | Props(BackoffOptions) |
Props for creating a BackoffSupervisor actor from BackoffOptions.
|
| Props(Props, String, TimeSpan, TimeSpan, Double) |
Props for creating a BackoffSupervisor actor.
|
| PropsWithSupervisorStrategy |
Props for creating a BackoffSupervisor actor with a custom supervision strategy.
|
| Receive | (Overrides ActorBaseReceive(Object).) |
| SetReceiveTimeout | Defines the inactivity timeout after which the sending of a ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a ReceiveTimeout message. Please note that the receive timeout might fire and enqueue the ReceiveTimeout message right after another message was enqueued; hence it is not guaranteed that upon reception of the receive timeout there must have been an idle period beforehand as configured via this method. Once set, the receive timeout stays in effect (i.e. continues firing repeatedly after inactivity periods). Pass in null to switch off this feature. |
| SupervisorStrategy | (Overrides ActorBaseSupervisorStrategy.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnbecomeStacked |
Reverts the Actor behavior to the previous one on the behavior stack.
(Inherited from ActorBase.) |
| Unhandled |
Is called when a message isn't handled by the current behavior of the actor
by default it fails with either a DeathPactException (in
case of an unhandled Terminated message) or publishes an UnhandledMessage
to the actor's system's EventStream (Inherited from ActorBase.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsInstanceOfT |
TBD
(Defined by Extensions.) |
| Match | Overloaded.
Matches the specified target.
(Defined by PatternMatch.) |
| MatchT | Overloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.) |
See Also