akka.actor

Class FunctionRef

java.lang.Object

akka.actor.ActorRef

akka.actor.InternalActorRef

akka.actor.FunctionRef

All Implemented Interfaces:

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

public final class FunctionRef
extends InternalActorRef
implements MinimalActorRef

INTERNAL API

This kind of ActorRef passes all received messages to the given function for performing a non-blocking side-effect. The intended use is to transform the message before sending to the real target actor. Such references can be created by calling ActorCell.addFunctionRef and must be deregistered when no longer needed by calling ActorCell.removeFunctionRef. FunctionRefs do not count towards the live children of an actor, they do not receive the Terminate command and do not prevent the parent from terminating. FunctionRef is properly registered for remote lookup and ActorSelection.

When using the watch() feature you must ensure that upon reception of the Terminated message the watched actorRef is unwatch()ed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FunctionRef(ActorPath path, ActorRefProvider provider, EventStream eventStream, scala.Function2<ActorRef,java.lang.Object,scala.runtime.BoxedUnit> f)

Method Summary

Modifier and Type	Method and Description
EventStream	eventStream()
boolean	isTerminated() INTERNAL API: Returns “true” if the actor is locally known to be terminated, “false” if alive or uncertain.
boolean	isWatching(ActorRef actorRef) Query whether this FunctionRef is currently watching the given Actor.
ActorPath	path() Returns the path for this actor (from this actor up to the root actor).
ActorRefProvider	provider() Get a reference to the actor ref provider which created this ref.
void	sendSystemMessage(SystemMessage message)
protected void	sendTerminated()
void	stop()
void	unwatch(ActorRef actorRef) Have this FunctionRef unwatch the given Actor.
void	watch(ActorRef actorRef) Have this FunctionRef watch the given Actor.

Methods inherited from class akka.actor.InternalActorRef

getChild, getParent, isLocal, restart, resume, start, suspend

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.actor.MinimalActorRef

getChild, getParent, restart, resume, start, suspend, writeReplace

Methods inherited from interface akka.actor.LocalRef

isLocal

Constructor Detail

FunctionRef

public FunctionRef(ActorPath path,
                   ActorRefProvider provider,
                   EventStream eventStream,
                   scala.Function2<ActorRef,java.lang.Object,scala.runtime.BoxedUnit> f)

Method Detail

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)

provider

public ActorRefProvider 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)

eventStream

public EventStream eventStream()

sendSystemMessage

public void sendSystemMessage(SystemMessage message)

Specified by:

sendSystemMessage in interface MinimalActorRef

Specified by:

sendSystemMessage in class InternalActorRef

isTerminated

public boolean isTerminated()

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 interface MinimalActorRef

Specified by:

isTerminated in class InternalActorRef

Returns:

(undocumented)

sendTerminated

protected void sendTerminated()

stop

public void stop()

Specified by:

stop in interface MinimalActorRef

Specified by:

stop in class InternalActorRef

watch

public void watch(ActorRef actorRef)

Have this FunctionRef watch the given Actor. This method must not be called concurrently from different threads, it should only be called by its parent Actor.

Upon receiving the Terminated message, unwatch() must be called from a safe context (i.e. normally from the parent Actor).

Parameters:

actorRef - (undocumented)

unwatch

public void unwatch(ActorRef actorRef)

Have this FunctionRef unwatch the given Actor. This method must not be called concurrently from different threads, it should only be called by its parent Actor.

Parameters:

actorRef - (undocumented)

isWatching

public boolean isWatching(ActorRef actorRef)

Query whether this FunctionRef is currently watching the given Actor. This method must not be called concurrently from different threads, it should only be called by its parent Actor.

Parameters:

actorRef - (undocumented)

Returns:

(undocumented)