akka.actor
Interface Cell

All Known Implementing Classes:

ActorCell, ResizablePoolCell, RoutedActorCell, UnstartedCell

public interface Cell

INTERNAL API

Method Summary

ChildrenContainer	childrenRefs() All children of this actor, including only reserved-names.
scala.Option<ChildStats>	getChildByName(java.lang.String name) Get the stats for the named child, if that exists.
InternalActorRef	getSingleChild(java.lang.String name) Method for looking up a single child beneath this actor.
boolean	hasMessages() If the actor isLocal, returns whether "user messages" are currently queued, &ldquo;false&rdquo; otherwise.
boolean	isLocal() Returns true if the actor is local, i.e.
boolean	isTerminated() Returns &ldquo;true&rdquo; if the actor is locally known to be terminated, &ldquo;false&rdquo; if alive or uncertain.
int	numberOfMessages() If the actor isLocal, returns the number of "user messages" currently queued, which may be a costly operation, 0 otherwise.
InternalActorRef	parent() The supervisor of this actor.
Props	props() The props for this actor cell.
void	restart(java.lang.Throwable cause) Restart this actor (will recursively restart or stop all children).
void	resume(java.lang.Throwable causedByFailure) Recursively resume this actor and all its children.
ActorRef	self() The &ldquo;self&rdquo; reference which this Cell is attached to.
void	sendMessage(Envelope msg) 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.
void	sendMessage(java.lang.Object message, ActorRef sender) 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.
void	sendSystemMessage(SystemMessage msg) 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.
Cell	start() Start the cell: enqueued message must not be processed before this has been called.
void	stop() Recursively terminate this actor and all its children.
void	suspend() Recursively suspend this actor and all its children.
ActorSystem	system() The system within which this Cell lives.
ActorSystemImpl	systemImpl() The system internals where this Cell lives.

Method Detail

self

ActorRef self()

The “self” reference which this Cell is attached to.

Returns:

(undocumented)

system

ActorSystem system()

The system within which this Cell lives.

Returns:

(undocumented)

systemImpl

ActorSystemImpl systemImpl()

The system internals where this Cell lives.

Returns:

(undocumented)

start

Cell 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.

Returns:

(undocumented)

suspend

void suspend()

Recursively suspend this actor and all its children. Is only allowed to throw Fatal Throwables.

resume

void resume(java.lang.Throwable causedByFailure)

Recursively resume this actor and all its children. Is only allowed to throw Fatal Throwables.

Parameters:

causedByFailure - (undocumented)

restart

void restart(java.lang.Throwable cause)

Restart this actor (will recursively restart or stop all children). Is only allowed to throw Fatal Throwables.

Parameters:

cause - (undocumented)

stop

void stop()

Recursively terminate this actor and all its children. Is only allowed to throw Fatal Throwables.

isTerminated

boolean isTerminated()

Returns “true” if the actor is locally known to be terminated, “false” if alive or uncertain.

Returns:

(undocumented)

parent

InternalActorRef parent()

The supervisor of this actor.

Returns:

(undocumented)

childrenRefs

ChildrenContainer childrenRefs()

All children of this actor, including only reserved-names.

Returns:

(undocumented)

getChildByName

scala.Option<ChildStats> getChildByName(java.lang.String name)

Get the stats for the named child, if that exists.

Parameters:

name - (undocumented)

Returns:

(undocumented)

getSingleChild

InternalActorRef getSingleChild(java.lang.String name)

Method for looking up a single child beneath this actor. It is racy if called from the outside.

Parameters:

name - (undocumented)

Returns:

(undocumented)

sendMessage

void sendMessage(Envelope msg)

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. Is only allowed to throw Fatal Throwables.

Parameters:

msg - (undocumented)

sendMessage

void sendMessage(java.lang.Object message,
                 ActorRef sender)

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. Is only allowed to throw Fatal Throwables.

Parameters:

message - (undocumented)

sender - (undocumented)

sendSystemMessage

void sendSystemMessage(SystemMessage msg)

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. Is only allowed to throw Fatal Throwables.

Parameters:

msg - (undocumented)

isLocal

boolean isLocal()

Returns true if the actor is local, i.e. if it is actually scheduled on a Thread in the current JVM when run.

Returns:

(undocumented)

hasMessages

boolean hasMessages()

If the actor isLocal, returns whether "user messages" are currently queued, “false” otherwise.

Returns:

(undocumented)

numberOfMessages

int numberOfMessages()

If the actor isLocal, returns the number of "user messages" currently queued, which may be a costly operation, 0 otherwise.

Returns:

(undocumented)

props

Props props()

The props for this actor cell.

Returns:

(undocumented)