akka.pattern

Class PromiseActorRef

java.lang.Object

akka.actor.ActorRef

akka.actor.InternalActorRef

akka.pattern.PromiseActorRef

All Implemented Interfaces:

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

public final class PromiseActorRef
extends InternalActorRef
implements MinimalActorRef

Akka private optimized representation of the temporary actor spawned to receive the reply to an "ask" operation.

INTERNAL API

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PromiseActorRef(ActorRefProvider provider, scala.concurrent.Promise<java.lang.Object> result) Deprecated. Use the full constructor. Since 2.4.

Method Summary

Modifier and Type	Method and Description
static void	$bang(java.lang.Object message, ActorRef sender)
static ActorRef	$bang$default$2(java.lang.Object message)
static PromiseActorRef	apply(ActorRefProvider provider, Timeout timeout, java.lang.Object targetName, java.lang.String messageClassName, ActorRef sender)
static PromiseActorRef	apply(ActorRefProvider provider, Timeout timeout, java.lang.String targetName) Deprecated. Use apply with messageClassName and sender parameters. Since 2.4.
static int	compareTo(ActorRef other)
static boolean	equals(java.lang.Object that)
static void	forward(java.lang.Object message, ActorContext context)
static InternalActorRef	getChild(scala.collection.Iterator<java.lang.String> names)
InternalActorRef	getParent() Obtain parent of this ref; used by getChild for ".." paths.
static int	hashCode()
scala.concurrent.ExecutionContext	internalCallingThreadExecutionContext()
abstract static boolean	isLocal()
boolean	isTerminated() Deprecated. Use context.watch(actor) and receive Terminated(actor). Since 2.2.
java.lang.String	messageClassName()
ActorPath	path() Contract of this method: Must always return the same ActorPath, which must have been registered if we haven't been stopped yet.
ActorRefProvider	provider() Get a reference to the actor ref provider which created this ref.
static void	restart(java.lang.Throwable cause)
scala.concurrent.Promise<java.lang.Object>	result()
static void	resume(java.lang.Throwable causedByFailure)
void	sendSystemMessage(SystemMessage message)
static void	start()
void	stop()
static void	suspend()
static void	tell(java.lang.Object msg, ActorRef sender)
static java.lang.String	toString()
protected static java.lang.Object	writeReplace()

Methods inherited from class akka.actor.InternalActorRef

getChild, 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, restart, resume, start, suspend, writeReplace

Methods inherited from interface akka.actor.LocalRef

isLocal

Constructor Detail

PromiseActorRef

public PromiseActorRef(ActorRefProvider provider,
                       scala.concurrent.Promise<java.lang.Object> result)

Deprecated. Use the full constructor. Since 2.4.

Method Detail

apply

public static PromiseActorRef apply(ActorRefProvider provider,
                                    Timeout timeout,
                                    java.lang.Object targetName,
                                    java.lang.String messageClassName,
                                    ActorRef sender)

apply

public static PromiseActorRef apply(ActorRefProvider provider,
                                    Timeout timeout,
                                    java.lang.String targetName)

Deprecated. Use apply with messageClassName and sender parameters. Since 2.4.

compareTo

public static final int compareTo(ActorRef other)

tell

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

forward

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

hashCode

public static final int hashCode()

equals

public static final boolean equals(java.lang.Object that)

toString

public static java.lang.String toString()

isLocal

public abstract static boolean isLocal()

getChild

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

start

public static void start()

suspend

public static void suspend()

resume

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

$bang

public static void $bang(java.lang.Object message,
                         ActorRef sender)

restart

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

writeReplace

protected static java.lang.Object writeReplace()
                                        throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException

$bang$default$2

public static ActorRef $bang$default$2(java.lang.Object message)

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)

result

public scala.concurrent.Promise<java.lang.Object> result()

messageClassName

public java.lang.String messageClassName()

getParent

public InternalActorRef getParent()

Description copied from class: InternalActorRef

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

Specified by:

getParent in interface MinimalActorRef

Specified by:

getParent in class InternalActorRef

Returns:

(undocumented)

internalCallingThreadExecutionContext

public scala.concurrent.ExecutionContext internalCallingThreadExecutionContext()

path

public ActorPath path()

Contract of this method: Must always return the same ActorPath, which must have been registered if we haven't been stopped yet.

Specified by:

path in class ActorRef

Returns:

(undocumented)

sendSystemMessage

public void sendSystemMessage(SystemMessage message)

Specified by:

sendSystemMessage in interface MinimalActorRef

Specified by:

sendSystemMessage in class InternalActorRef

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

Specified by:

isTerminated in class InternalActorRef

Returns:

(undocumented)

stop

public void stop()

Specified by:

stop in interface MinimalActorRef

Specified by:

stop in class InternalActorRef