SupervisorStrategy.HandleFailure Method

SupervisorStrategyHandleFailure Method

This is the main entry point: in case of a child’s failure, this method must try to handle the failure by resuming, restarting or stopping the child (and returning `true`), or it returns `false` to escalate the failure, which will lead to this actor re-throwing the exception which caused the failure. The exception will not be wrapped. This method calls SupervisorStrategy, which will log the failure unless it is escalated. You can customize the logging by setting SupervisorStrategy to `false` and do the logging inside the `decider` or override the `LogFailure` method.

Namespace: Akka.Actor
Assembly: Akka (in Akka.dll) Version: 0.8.0.0 (0.8.0.0)

Syntax

C++

Copy

public bool HandleFailure(
	ActorCell actorCell,
	Exception cause,
	ChildRestartStats failedChildStats,
	IReadOnlyCollection<ChildRestartStats> allChildren
)

Public Function HandleFailure ( 
	actorCell As ActorCell,
	cause As Exception,
	failedChildStats As ChildRestartStats,
	allChildren As IReadOnlyCollection(Of ChildRestartStats)
) As Boolean

public:
bool HandleFailure(
	ActorCell^ actorCell, 
	Exception^ cause, 
	ChildRestartStats^ failedChildStats, 
	IReadOnlyCollection<ChildRestartStats^>^ allChildren
)

member HandleFailure : 
        actorCell : ActorCell * 
        cause : Exception * 
        failedChildStats : ChildRestartStats * 
        allChildren : IReadOnlyCollection<ChildRestartStats> -> bool

Parameters

actorCell: Type: Akka.ActorActorCell
The actor cell.
cause: Type: SystemException
The cause.
failedChildStats: Type: Akka.Actor.InternalChildRestartStats
The stats for the failed child.
allChildren: Type: System.Collections.GenericIReadOnlyCollectionChildRestartStats

Return Value

Type: Boolean
true if XXXX, false otherwise.

Reference

SupervisorStrategy Class

Akka.Actor Namespace