akka.actor

Interface ActorRefProvider

All Known Implementing Classes:

ClusterActorRefProvider, LocalActorRefProvider, RemoteActorRefProvider

public interface ActorRefProvider

Interface for all ActorRef providers to implement.

Method Summary

Modifier and Type	Method and Description
InternalActorRef	actorFor(ActorPath path) Deprecated. use actorSelection instead of actorFor. Since 2.2.
InternalActorRef	actorFor(InternalActorRef ref, scala.collection.Iterable<java.lang.String> p) Deprecated. use actorSelection instead of actorFor. Since 2.2.
InternalActorRef	actorFor(InternalActorRef ref, java.lang.String s) Deprecated. use actorSelection instead of actorFor. Since 2.2.
InternalActorRef	actorOf(ActorSystemImpl system, Props props, InternalActorRef supervisor, ActorPath path, boolean systemService, scala.Option<Deploy> deploy, boolean lookupDeploy, boolean async) Actor factory with create-only semantics: will create an actor as described by props with the given supervisor and path (may be different in case of remote supervision).
ActorRef	deadLetters() Dead letter destination for this provider.
Deployer	deployer() The Deployer associated with this ActorRefProvider
Address	getDefaultAddress() Obtain the external address of the default transport.
scala.Option<Address>	getExternalAddressFor(Address addr) Obtain the address which is to be used within sender references when sending to the given other address or none if the other address cannot be reached from this system (i.e.
LocalActorRef	guardian() Reference to the supervisor used for all top-level user actors.
void	init(ActorSystemImpl system) Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc.
void	registerTempActor(InternalActorRef actorRef, ActorPath path) Registers an actorRef at a path returned by tempPath(); do NOT pass in any other path.
ActorRef	resolveActorRef(ActorPath path) Create actor reference for a specified path.
ActorRef	resolveActorRef(java.lang.String path) Create actor reference for a specified path.
InternalActorRef	rootGuardian() Reference to the supervisor of guardian and systemGuardian; this is exposed so that the ActorSystemImpl can use it as lookupRoot, i.e.
ActorRef	rootGuardianAt(Address address) Reference to the supervisor of guardian and systemGuardian at the specified address; this is exposed so that the ActorRefFactory can use it as lookupRoot, i.e.
ActorPath	rootPath() The root path for all actors within this actor system, not including any remote address information.
ActorSystem.Settings	settings() The Settings associated with this ActorRefProvider
LocalActorRef	systemGuardian() Reference to the supervisor used for all top-level system actors.
InternalActorRef	tempContainer() Returns the actor reference representing the &ldquo;/temp&rdquo; path.
ActorPath	tempPath() Generates and returns a unique actor path below &ldquo;/temp&rdquo;.
scala.concurrent.Future<Terminated>	terminationFuture() This Future is completed upon termination of this ActorRefProvider, which is usually initiated by stopping the guardian via ActorSystem.stop().
void	unregisterTempActor(ActorPath path) Unregister a temporary actor from the &ldquo;/temp&rdquo; path (i.e.

Method Detail

rootGuardian

InternalActorRef rootGuardian()

Reference to the supervisor of guardian and systemGuardian; this is exposed so that the ActorSystemImpl can use it as lookupRoot, i.e. for anchoring absolute actor look-ups.

Returns:

(undocumented)

rootGuardianAt

ActorRef rootGuardianAt(Address address)

Reference to the supervisor of guardian and systemGuardian at the specified address; this is exposed so that the ActorRefFactory can use it as lookupRoot, i.e. for anchoring absolute actor selections.

Parameters:

address - (undocumented)

Returns:

(undocumented)

guardian

LocalActorRef guardian()

Reference to the supervisor used for all top-level user actors.

Returns:

(undocumented)

systemGuardian

LocalActorRef systemGuardian()

Reference to the supervisor used for all top-level system actors.

Returns:

(undocumented)

deadLetters

ActorRef deadLetters()

Dead letter destination for this provider.

Returns:

(undocumented)

rootPath

ActorPath rootPath()

The root path for all actors within this actor system, not including any remote address information.

Returns:

(undocumented)

settings

ActorSystem.Settings settings()

The Settings associated with this ActorRefProvider

Returns:

(undocumented)

init

void init(ActorSystemImpl system)

Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc. and then—when the ActorSystem is constructed—the second phase during which actors may be created (e.g. the guardians).

Parameters:

system - (undocumented)

deployer

Deployer deployer()

The Deployer associated with this ActorRefProvider

Returns:

(undocumented)

tempPath

ActorPath tempPath()

Generates and returns a unique actor path below “/temp”.

Returns:

(undocumented)

tempContainer

InternalActorRef tempContainer()

Returns the actor reference representing the “/temp” path.

Returns:

(undocumented)

registerTempActor

void registerTempActor(InternalActorRef actorRef,
                       ActorPath path)

Registers an actorRef at a path returned by tempPath(); do NOT pass in any other path.

Parameters:

actorRef - (undocumented)

path - (undocumented)

unregisterTempActor

void unregisterTempActor(ActorPath path)

Unregister a temporary actor from the “/temp” path (i.e. obtained from tempPath()); do NOT pass in any other path.

Parameters:

path - (undocumented)

actorOf

InternalActorRef actorOf(ActorSystemImpl system,
                         Props props,
                         InternalActorRef supervisor,
                         ActorPath path,
                         boolean systemService,
                         scala.Option<Deploy> deploy,
                         boolean lookupDeploy,
                         boolean async)

Actor factory with create-only semantics: will create an actor as described by props with the given supervisor and path (may be different in case of remote supervision). If systemService is true, deployment is bypassed (local-only). If Some(deploy) is passed in, it should be regarded as taking precedence over the nominally applicable settings, but it should be overridable from external configuration; the lookup of the latter can be suppressed by setting lookupDeploy to false.

Parameters:

system - (undocumented)

props - (undocumented)

supervisor - (undocumented)

path - (undocumented)

systemService - (undocumented)

deploy - (undocumented)

lookupDeploy - (undocumented)

async - (undocumented)

Returns:

(undocumented)

actorFor

InternalActorRef actorFor(ActorPath path)

Deprecated. use actorSelection instead of actorFor. Since 2.2.

INTERNAL API

Create actor reference for a specified local or remote path. If no such actor exists, it will be (equivalent to) a dead letter reference.

Actor references acquired with actorFor do not always include the full information about the underlying actor identity and therefore such references do not always compare equal to references acquired with actorOf, sender, or context.self.

Parameters:

path - (undocumented)

Returns:

(undocumented)

actorFor

InternalActorRef actorFor(InternalActorRef ref,
                          java.lang.String s)

Deprecated. use actorSelection instead of actorFor. Since 2.2.

INTERNAL API

Create actor reference for a specified local or remote path, which will be parsed using java.net.URI. If no such actor exists, it will be (equivalent to) a dead letter reference. If s is a relative URI, resolve it relative to the given ref.

Parameters:

ref - (undocumented)

s - (undocumented)

Returns:

(undocumented)

actorFor

InternalActorRef actorFor(InternalActorRef ref,
                          scala.collection.Iterable<java.lang.String> p)

Deprecated. use actorSelection instead of actorFor. Since 2.2.

INTERNAL API

Create actor reference for the specified child path starting at the given starting point. This method always returns an actor which is “logically local”, i.e. it cannot be used to obtain a reference to an actor which is not physically or logically attached to this actor system.

Parameters:

ref - (undocumented)

p - (undocumented)

Returns:

(undocumented)

resolveActorRef

ActorRef resolveActorRef(java.lang.String path)

Create actor reference for a specified path. If no such actor exists, it will be (equivalent to) a dead letter reference.

Parameters:

path - (undocumented)

Returns:

(undocumented)

resolveActorRef

ActorRef resolveActorRef(ActorPath path)

Create actor reference for a specified path. If no such actor exists, it will be (equivalent to) a dead letter reference.

Parameters:

path - (undocumented)

Returns:

(undocumented)

terminationFuture

scala.concurrent.Future<Terminated> terminationFuture()

This Future is completed upon termination of this ActorRefProvider, which is usually initiated by stopping the guardian via ActorSystem.stop().

Returns:

(undocumented)

getExternalAddressFor

scala.Option<Address> getExternalAddressFor(Address addr)

Obtain the address which is to be used within sender references when sending to the given other address or none if the other address cannot be reached from this system (i.e. no means of communication known; no attempt is made to verify actual reachability).

Parameters:

addr - (undocumented)

Returns:

(undocumented)

getDefaultAddress

Address getDefaultAddress()

Obtain the external address of the default transport.

Returns:

(undocumented)