ICell Interface

ICell Interface

Remarks

Note! Part of internal API. Breaking changes may occur without notice. Use at own risk.

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

Syntax

public interface ICell

type ICell =  interface end

The ICell type exposes the following members.

Properties

	Name	Description
	ChildrenContainer	TBD
	HasMessages	If the actor isLocal, returns whether "user messages" are currently queued, falseotherwise.
	IsLocal	Returns true if the actor is local.
	IsTerminated	TBD
	NumberOfMessages	If the actor isLocal, returns the number of "user messages" currently queued, which may be a costly operation, 0 otherwise.
	Parent	The supervisor of this actor.
	Props	The props for this actor cell.
	Self	Gets the "self" reference which this Cell is attached to.
	System	The system within which this Cell lives.
	SystemImpl	The system internals within which this Cell lives.

Methods

	Name	Description
	GetChildByName	TBD
	GetChildren	Obsolete. TBD
	GetSingleChild	Method for looking up a single child beneath this actor. It is racy if called from the outside.
	Restart	Restart this actor (will recursively restart or stop all children). Is only allowed to throw Fatal Throwables.
	Resume	Recursively resume this actor and all its children. Is only allowed to throw fatal exceptions.
	SendMessage	TBD
	SendSystemMessage	Enqueue a message to be sent to the actor; may or may not actually schedule the actor to run, depending on which type of cell it is.
	Start	Start the cell: enqueued message must not be processed before this has been called. The usual action is to attach the mailbox to a dispatcher.
	Stop	Recursively terminate this actor and all its children. Is only allowed to throw Fatal Throwables.
	Suspend	Recursively suspend this actor and all its children. Is only allowed to throw fatal exceptions.
	TryGetChildStatsByName	Tries to get the stats for the child with the specified name. The stats can be either ChildNameReserved indicating that only a name has been reserved for the child, or a ChildRestartStats for a child that has been initialized/created.