akka.actor

Class InternalActorRef

java.lang.Object

akka.actor.ActorRef

akka.actor.InternalActorRef

All Implemented Interfaces:

ScalaActorRef, java.io.Serializable, java.lang.Comparable<ActorRef>

Direct Known Subclasses:

ActorRefWithCell, EmptyLocalActorRef, FunctionRef, Logging.StandardOutLogger, Nobody$, PromiseActorRef, RemoteActorRef, UndefinedUidActorRef, VirtualPathContainer

public abstract class InternalActorRef
extends ActorRef
implements ScalaActorRef

Internal trait for assembling all the functionality needed internally on ActorRefs. NOTE THAT THIS IS NOT A STABLE EXTERNAL INTERFACE!

DO NOT USE THIS UNLESS INTERNALLY WITHIN AKKA!

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InternalActorRef()

Method Summary

Modifier and Type	Method and Description
abstract InternalActorRef	getChild(scala.collection.Iterator<java.lang.String> name) Obtain ActorRef by possibly traversing the actor tree or looking it up at some provider-specific location.
abstract InternalActorRef	getParent() Obtain parent of this ref; used by getChild for ".." paths.
abstract boolean	isLocal() Scope: if this ref points to an actor which resides within the same JVM, i.e.
abstract boolean	isTerminated() INTERNAL API: Returns &ldquo;true&rdquo; if the actor is locally known to be terminated, &ldquo;false&rdquo; if alive or uncertain.
abstract ActorRefProvider	provider() Get a reference to the actor ref provider which created this ref.
abstract void	restart(java.lang.Throwable cause)
abstract void	resume(java.lang.Throwable causedByFailure)
abstract void	sendSystemMessage(SystemMessage message)
abstract void	start()
abstract void	stop()
abstract void	suspend()

Methods inherited from class akka.actor.ActorRef

compareTo, equals, forward, hashCode, noSender, path, tell, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InternalActorRef

public InternalActorRef()

Method Detail

start

public abstract void start()

resume

public abstract void resume(java.lang.Throwable causedByFailure)

suspend

public abstract void suspend()

restart

public abstract void restart(java.lang.Throwable cause)

stop

public abstract void stop()

sendSystemMessage

public abstract void sendSystemMessage(SystemMessage message)

provider

public abstract ActorRefProvider provider()

Get a reference to the actor ref provider which created this ref.

Returns:

(undocumented)

getParent

public abstract InternalActorRef getParent()

Obtain parent of this ref; used by getChild for ".." paths.

Returns:

(undocumented)

getChild

public abstract InternalActorRef getChild(scala.collection.Iterator<java.lang.String> name)

Obtain ActorRef by possibly traversing the actor tree or looking it up at some provider-specific location. This method shall return the end result, i.e. not only the next step in the look-up; this will typically involve recursive invocation. A path element of ".." signifies the parent, a trailing "" element must be disregarded. If the requested path does not exist, return Nobody.

Parameters:

name - (undocumented)

Returns:

(undocumented)

isLocal

public abstract boolean isLocal()

Scope: if this ref points to an actor which resides within the same JVM, i.e. whose mailbox is directly reachable etc.

Returns:

(undocumented)

isTerminated

public abstract boolean isTerminated()

INTERNAL API: Returns &ldquo;true&rdquo; if the actor is locally known to be terminated, &ldquo;false&rdquo; if alive or uncertain.

Specified by:

isTerminated in class ActorRef

Returns:

(undocumented)