akka.remote

Class RemoteActorRef

java.lang.Object

akka.actor.ActorRef

akka.actor.InternalActorRef

akka.remote.RemoteActorRef

All Implemented Interfaces:

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

public class RemoteActorRef
extends InternalActorRef
implements RemoteRef

INTERNAL API Remote ActorRef that is used when referencing the Actor on a different node than its "home" node. This reference is network-aware (remembers its origin) and immutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RemoteActorRef(RemoteTransport remote, Address localAddressToUse, ActorPath path, InternalActorRef getParent, scala.Option<Props> props, scala.Option<Deploy> deploy)

Method Summary

Modifier and Type	Method and Description
Association	cachedAssociation()
int	cachedSendQueueIndex()
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.
InternalActorRef	getParent() Obtain parent of this ref; used by getChild for ".." paths.
boolean	isTerminated() Deprecated. Use context.watch(actor) and receive Terminated(actor). Since 2.2.
boolean	isWatchIntercepted(ActorRef watchee, ActorRef watcher) Determine if a watch/unwatch message must be handled by the remoteWatcher actor, or sent to this remote ref
Address	localAddressToUse()
ActorPath	path() Returns the path for this actor (from this actor up to the root actor).
RemoteActorRefProvider	provider() Get a reference to the actor ref provider which created this ref.
void	restart(java.lang.Throwable cause)
void	resume(java.lang.Throwable causedByFailure)
void	sendSystemMessage(SystemMessage message)
void	start()
void	stop()
void	suspend()

Methods inherited from class akka.actor.InternalActorRef

isLocal

Methods inherited from class akka.actor.ActorRef

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.remote.RemoteRef

isLocal

Constructor Detail

RemoteActorRef

public RemoteActorRef(RemoteTransport remote,
                      Address localAddressToUse,
                      ActorPath path,
                      InternalActorRef getParent,
                      scala.Option<Props> props,
                      scala.Option<Deploy> deploy)

Method Detail

localAddressToUse

public Address localAddressToUse()

path

public ActorPath path()

Description copied from class: ActorRef

Returns the path for this actor (from this actor up to the root actor).

Specified by:

path in class ActorRef

Returns:

(undocumented)

getParent

public InternalActorRef getParent()

Description copied from class: InternalActorRef

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

Specified by:

getParent in class InternalActorRef

Returns:

(undocumented)

cachedAssociation

public Association cachedAssociation()

cachedSendQueueIndex

public int cachedSendQueueIndex()

getChild

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

Description copied from class: InternalActorRef

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.

Specified by:

getChild in class InternalActorRef

Parameters:

name - (undocumented)

Returns:

(undocumented)

isTerminated

public boolean isTerminated()

Deprecated. Use context.watch(actor) and receive Terminated(actor). Since 2.2.

Description copied from class: InternalActorRef

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 InternalActorRef

Returns:

(undocumented)

isWatchIntercepted

public boolean isWatchIntercepted(ActorRef watchee,
                                  ActorRef watcher)

Determine if a watch/unwatch message must be handled by the remoteWatcher actor, or sent to this remote ref

Parameters:

watchee - (undocumented)

watcher - (undocumented)

Returns:

(undocumented)

sendSystemMessage

public void sendSystemMessage(SystemMessage message)

Specified by:

sendSystemMessage in class InternalActorRef

provider

public RemoteActorRefProvider provider()

Description copied from class: InternalActorRef

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

Specified by:

provider in class InternalActorRef

Returns:

(undocumented)

start

public void start()

Specified by:

start in class InternalActorRef

suspend

public void suspend()

Specified by:

suspend in class InternalActorRef

resume

public void resume(java.lang.Throwable causedByFailure)

Specified by:

resume in class InternalActorRef

stop

public void stop()

Specified by:

stop in class InternalActorRef

restart

public void restart(java.lang.Throwable cause)

Specified by:

restart in class InternalActorRef