akka.actor

Class ActorSelection

java.lang.Object

akka.actor.ActorSelection

All Implemented Interfaces:

java.io.Serializable

public abstract class ActorSelection
extends java.lang.Object
implements scala.Serializable

An ActorSelection is a logical view of a section of an ActorSystem's tree of Actors, allowing for broadcasting of messages to that section.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActorSelection()

Method Summary

Modifier and Type	Method and Description
protected abstract ActorRef	anchor()
ActorPath	anchorPath() The ActorPath of the anchor actor.
static ActorSelection	apply(ActorRef anchorRef, scala.collection.Iterable<java.lang.String> elements) Construct an ActorSelection from the given string representing a path relative to the given target.
static ActorSelection	apply(ActorRef anchorRef, java.lang.String path) Construct an ActorSelection from the given string representing a path relative to the given target.
static void	deliverSelection(InternalActorRef anchor, ActorRef sender, ActorSelectionMessage sel) INTERNAL API The receive logic for ActorSelectionMessage.
boolean	equals(java.lang.Object obj)
void	forward(java.lang.Object message, ActorContext context) Forwards the message and passes the original sender actor as the sender.
int	hashCode()
protected abstract scala.collection.immutable.IndexedSeq<SelectionPathElement>	path()
java.lang.String	pathString() String representation of the path elements, starting with "/" and separated with "/".
scala.concurrent.Future<ActorRef>	resolveOne(scala.concurrent.duration.FiniteDuration timeout) Resolve the ActorRef matching this selection.
scala.concurrent.Future<ActorRef>	resolveOne(Timeout timeout) Resolve the ActorRef matching this selection.
java.util.concurrent.CompletionStage<ActorRef>	resolveOneCS(scala.concurrent.duration.FiniteDuration timeout) Java API for resolveOne(akka.util.Timeout)
void	tell(java.lang.Object msg, ActorRef sender) Sends the specified message to this ActorSelection, i.e.
static ScalaActorSelection	toScala(ActorSelection sel)
java.lang.String	toSerializationFormat() String representation of the actor selection suitable for storage and recreation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorSelection

public ActorSelection()

Method Detail

toScala

public static ScalaActorSelection toScala(ActorSelection sel)

apply

public static ActorSelection apply(ActorRef anchorRef,
                                   java.lang.String path)

Construct an ActorSelection from the given string representing a path relative to the given target. This operation has to create all the matching magic, so it is preferable to cache its result if the intention is to send messages frequently.

Parameters:

anchorRef - (undocumented)

path - (undocumented)

Returns:

(undocumented)

apply

public static ActorSelection apply(ActorRef anchorRef,
                                   scala.collection.Iterable<java.lang.String> elements)

Construct an ActorSelection from the given string representing a path relative to the given target. This operation has to create all the matching magic, so it is preferable to cache its result if the intention is to send messages frequently.

Parameters:

anchorRef - (undocumented)

elements - (undocumented)

Returns:

(undocumented)

deliverSelection

public static void deliverSelection(InternalActorRef anchor,
                                    ActorRef sender,
                                    ActorSelectionMessage sel)

INTERNAL API The receive logic for ActorSelectionMessage. The idea is to recursively descend as far as possible with local refs and hand over to that “foreign” child when we encounter it.

Parameters:

anchor - (undocumented)

sender - (undocumented)

sel - (undocumented)

anchor

protected abstract ActorRef anchor()

path

protected abstract scala.collection.immutable.IndexedSeq<SelectionPathElement> path()

tell

public void tell(java.lang.Object msg,
                 ActorRef sender)

Sends the specified message to this ActorSelection, i.e. fire-and-forget semantics, including the sender reference if possible.

Pass ActorRef.noSender() or null as sender if there is nobody to reply to

Parameters:

msg - (undocumented)

sender - (undocumented)

forward

public void forward(java.lang.Object message,
                    ActorContext context)

Forwards the message and passes the original sender actor as the sender.

Works, no matter whether originally sent with tell/'!' or ask/'?'.

Parameters:

message - (undocumented)

context - (undocumented)

resolveOne

public scala.concurrent.Future<ActorRef> resolveOne(Timeout timeout)

Resolve the ActorRef matching this selection. The result is returned as a Future that is completed with the ActorRef if such an actor exists. It is completed with failure ActorNotFound if no such actor exists or the identification didn't complete within the supplied timeout.

Under the hood it talks to the actor to verify its existence and acquire its ActorRef.

Parameters:

timeout - (undocumented)

Returns:

(undocumented)

resolveOne

public scala.concurrent.Future<ActorRef> resolveOne(scala.concurrent.duration.FiniteDuration timeout)

Resolve the ActorRef matching this selection. The result is returned as a Future that is completed with the ActorRef if such an actor exists. It is completed with failure ActorNotFound if no such actor exists or the identification didn't complete within the supplied timeout.

Under the hood it talks to the actor to verify its existence and acquire its ActorRef.

Parameters:

timeout - (undocumented)

Returns:

(undocumented)

resolveOneCS

public java.util.concurrent.CompletionStage<ActorRef> resolveOneCS(scala.concurrent.duration.FiniteDuration timeout)

Java API for resolveOne(akka.util.Timeout)

Resolve the ActorRef matching this selection. The result is returned as a CompletionStage that is completed with the ActorRef if such an actor exists. It is completed with failure ActorNotFound if no such actor exists or the identification didn't complete within the supplied timeout.

Parameters:

timeout - (undocumented)

Returns:

(undocumented)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

anchorPath

public ActorPath anchorPath()

The ActorPath of the anchor actor.

Returns:

(undocumented)

pathString

public java.lang.String pathString()

String representation of the path elements, starting with "/" and separated with "/".

Returns:

(undocumented)

toSerializationFormat

public java.lang.String toSerializationFormat()

String representation of the actor selection suitable for storage and recreation. The output is similar to the URI fragment returned by ActorPath.toSerializationFormat().

Returns:

URI fragment

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object