Package akka.actor
Class LocalActorRefProvider
- java.lang.Object
-
- akka.actor.LocalActorRefProvider
-
- All Implemented Interfaces:
ActorRefProvider
public class LocalActorRefProvider extends java.lang.Object implements ActorRefProvider
Local ActorRef provider.INTERNAL API!
Depending on this class is not supported, only the
ActorRefProvider
interface is supported.
-
-
Constructor Summary
Constructors Constructor Description LocalActorRefProvider(java.lang.String _systemName, ActorSystem.Settings settings, EventStream eventStream, DynamicAccess dynamicAccess)
LocalActorRefProvider(java.lang.String _systemName, ActorSystem.Settings settings, EventStream eventStream, DynamicAccess dynamicAccess, Deployer deployer, scala.Option<scala.Function1<ActorPath,InternalActorRef>> _deadLetters)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InternalActorRef
actorOf(ActorSystemImpl system, Props props, InternalActorRef supervisor, ActorPath path, boolean systemService, scala.Option<Deploy> deploy, boolean lookupDeploy, boolean async)
INTERNAL API: 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).java.lang.String
addressString()
INTERNAL APIInternalActorRef
deadLetters()
Dead letter destination for this provider.Deployer
deployer()
The Deployer associated with this ActorRefProviderDynamicAccess
dynamicAccess()
EventStream
eventStream()
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.protected SupervisorStrategy
guardianStrategy()
Overridable supervision strategy to be used by the “/user” guardian.ActorRef
ignoreRef()
INTERNAL APIvoid
init(ActorSystemImpl _system)
INTERNAL API: Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc.MarkerLoggingAdapter
log()
MarkerLoggingAdapter
logDeser()
void
registerExtraNames(scala.collection.immutable.Map<java.lang.String,InternalActorRef> _extras)
Higher-level providers (or extensions) might want to register new synthetic top-level paths for doing special stuff.void
registerTempActor(InternalActorRef actorRef, ActorPath path)
INTERNAL API: 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.InternalActorRef
resolveActorRef(InternalActorRef ref, scala.collection.Iterable<java.lang.String> pathElements)
INTERNAL APIActorRef
resolveActorRef(java.lang.String path)
Create actor reference for a specified path.LocalActorRef
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.protected SupervisorStrategy
rootGuardianStrategy()
Overridable supervision strategy to be used by the “/user” guardian.ActorPath
rootPath()
The root path for all actors within this actor system, not including any remote address information.Serialization.Information
serializationInformation()
INTERNAL APIActorSystem.Settings
settings()
The Settings associated with this ActorRefProviderLocalActorRef
systemGuardian()
Reference to the supervisor used for all top-level system actors.protected SupervisorStrategy
systemGuardianStrategy()
Overridable supervision strategy to be used by the “/user” guardian.VirtualPathContainer
tempContainer()
Returns the actor reference representing the “/temp” path.ActorPath
tempPath()
Generates and returns a unique actor path below “/temp”.ActorPath
tempPath(java.lang.String prefix)
Generates and returns a unique actor path starting withprefix
below “/temp”.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().InternalActorRef
theOneWhoWalksTheBubblesOfSpaceTime()
Top-level anchor for the supervision hierarchy of this actor system.void
unregisterTempActor(ActorPath path)
Unregister a temporary actor from the “/temp” path (i.e.
-
-
-
Constructor Detail
-
LocalActorRefProvider
public LocalActorRefProvider(java.lang.String _systemName, ActorSystem.Settings settings, EventStream eventStream, DynamicAccess dynamicAccess, Deployer deployer, scala.Option<scala.Function1<ActorPath,InternalActorRef>> _deadLetters)
-
LocalActorRefProvider
public LocalActorRefProvider(java.lang.String _systemName, ActorSystem.Settings settings, EventStream eventStream, DynamicAccess dynamicAccess)
-
-
Method Detail
-
settings
public ActorSystem.Settings settings()
Description copied from interface:ActorRefProvider
The Settings associated with this ActorRefProvider- Specified by:
settings
in interfaceActorRefProvider
-
eventStream
public EventStream eventStream()
-
dynamicAccess
public DynamicAccess dynamicAccess()
-
deployer
public Deployer deployer()
Description copied from interface:ActorRefProvider
The Deployer associated with this ActorRefProvider- Specified by:
deployer
in interfaceActorRefProvider
-
rootPath
public ActorPath rootPath()
Description copied from interface:ActorRefProvider
The root path for all actors within this actor system, not including any remote address information.- Specified by:
rootPath
in interfaceActorRefProvider
-
log
public MarkerLoggingAdapter log()
-
logDeser
public MarkerLoggingAdapter logDeser()
-
deadLetters
public InternalActorRef deadLetters()
Description copied from interface:ActorRefProvider
Dead letter destination for this provider.- Specified by:
deadLetters
in interfaceActorRefProvider
-
ignoreRef
public ActorRef ignoreRef()
Description copied from interface:ActorRefProvider
INTERNAL API- Specified by:
ignoreRef
in interfaceActorRefProvider
-
terminationFuture
public scala.concurrent.Future<Terminated> terminationFuture()
Description copied from interface:ActorRefProvider
This Future is completed upon termination of this ActorRefProvider, which is usually initiated by stopping the guardian via ActorSystem.stop().- Specified by:
terminationFuture
in interfaceActorRefProvider
-
tempPath
public ActorPath tempPath()
Description copied from interface:ActorRefProvider
Generates and returns a unique actor path below “/temp”.- Specified by:
tempPath
in interfaceActorRefProvider
-
tempPath
public ActorPath tempPath(java.lang.String prefix)
Description copied from interface:ActorRefProvider
Generates and returns a unique actor path starting withprefix
below “/temp”.- Specified by:
tempPath
in interfaceActorRefProvider
-
theOneWhoWalksTheBubblesOfSpaceTime
public InternalActorRef theOneWhoWalksTheBubblesOfSpaceTime()
Top-level anchor for the supervision hierarchy of this actor system. Will receive only Supervise/ChildTerminated system messages or Failure message.
-
registerExtraNames
public void registerExtraNames(scala.collection.immutable.Map<java.lang.String,InternalActorRef> _extras)
Higher-level providers (or extensions) might want to register new synthetic top-level paths for doing special stuff. This is the way to do just that. Just be careful to complete all this before ActorSystem.start() finishes, or before you start your own auto-spawned actors.
-
rootGuardianStrategy
protected SupervisorStrategy rootGuardianStrategy()
Overridable supervision strategy to be used by the “/user” guardian.
-
guardianStrategy
protected SupervisorStrategy guardianStrategy()
Overridable supervision strategy to be used by the “/user” guardian.
-
systemGuardianStrategy
protected SupervisorStrategy systemGuardianStrategy()
Overridable supervision strategy to be used by the “/user” guardian.
-
rootGuardian
public LocalActorRef rootGuardian()
Description copied from interface:ActorRefProvider
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.- Specified by:
rootGuardian
in interfaceActorRefProvider
-
rootGuardianAt
public ActorRef rootGuardianAt(Address address)
Description copied from interface:ActorRefProvider
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.- Specified by:
rootGuardianAt
in interfaceActorRefProvider
-
guardian
public LocalActorRef guardian()
Description copied from interface:ActorRefProvider
Reference to the supervisor used for all top-level user actors.- Specified by:
guardian
in interfaceActorRefProvider
-
systemGuardian
public LocalActorRef systemGuardian()
Description copied from interface:ActorRefProvider
Reference to the supervisor used for all top-level system actors.- Specified by:
systemGuardian
in interfaceActorRefProvider
-
tempContainer
public VirtualPathContainer tempContainer()
Description copied from interface:ActorRefProvider
Returns the actor reference representing the “/temp” path.- Specified by:
tempContainer
in interfaceActorRefProvider
-
registerTempActor
public void registerTempActor(InternalActorRef actorRef, ActorPath path)
Description copied from interface:ActorRefProvider
INTERNAL API: Registers an actorRef at a path returned by tempPath(); do NOT pass in any other path.- Specified by:
registerTempActor
in interfaceActorRefProvider
-
unregisterTempActor
public void unregisterTempActor(ActorPath path)
Description copied from interface:ActorRefProvider
Unregister a temporary actor from the “/temp” path (i.e. obtained from tempPath()); do NOT pass in any other path.- Specified by:
unregisterTempActor
in interfaceActorRefProvider
-
init
public void init(ActorSystemImpl _system)
Description copied from interface:ActorRefProvider
INTERNAL API: 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).- Specified by:
init
in interfaceActorRefProvider
-
resolveActorRef
public ActorRef resolveActorRef(java.lang.String path)
Description copied from interface:ActorRefProvider
Create actor reference for a specified path. If no such actor exists, it will be (equivalent to) a dead letter reference.- Specified by:
resolveActorRef
in interfaceActorRefProvider
-
resolveActorRef
public ActorRef resolveActorRef(ActorPath path)
Description copied from interface:ActorRefProvider
Create actor reference for a specified path. If no such actor exists, it will be (equivalent to) a dead letter reference.- Specified by:
resolveActorRef
in interfaceActorRefProvider
-
resolveActorRef
public InternalActorRef resolveActorRef(InternalActorRef ref, scala.collection.Iterable<java.lang.String> pathElements)
INTERNAL API
-
actorOf
public InternalActorRef actorOf(ActorSystemImpl system, Props props, InternalActorRef supervisor, ActorPath path, boolean systemService, scala.Option<Deploy> deploy, boolean lookupDeploy, boolean async)
Description copied from interface:ActorRefProvider
INTERNAL API: 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). IfSome(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
.
- Specified by:
actorOf
in interfaceActorRefProvider
-
getExternalAddressFor
public scala.Option<Address> getExternalAddressFor(Address addr)
Description copied from interface:ActorRefProvider
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).- Specified by:
getExternalAddressFor
in interfaceActorRefProvider
-
getDefaultAddress
public Address getDefaultAddress()
Description copied from interface:ActorRefProvider
Obtain the external address of the default transport.- Specified by:
getDefaultAddress
in interfaceActorRefProvider
-
serializationInformation
public Serialization.Information serializationInformation()
Description copied from interface:ActorRefProvider
INTERNAL API- Specified by:
serializationInformation
in interfaceActorRefProvider
-
addressString
public java.lang.String addressString()
Description copied from interface:ActorRefProvider
INTERNAL API- Specified by:
addressString
in interfaceActorRefProvider
-
-