Package akka.actor

Class LocalActorRefProvider

  • All Implemented Interfaces:
    ActorRefProvider

    public class LocalActorRefProvider
    extends java.lang.Object
    implements ActorRefProvider
    Top-level anchor for the supervision hierarchy of this actor system. Will receive only Supervise/ChildTerminated system messages or Failure message.
    • Method Detail

      • 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 interface ActorRefProvider
        Returns:
        (undocumented)
      • 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 interface ActorRefProvider
        Returns:
        (undocumented)
      • 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.
        Returns:
        (undocumented)
      • 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.
        Parameters:
        _extras - (undocumented)
      • rootGuardianStrategy

        protected SupervisorStrategy rootGuardianStrategy()
        Overridable supervision strategy to be used by the &ldquo;/user&rdquo; guardian.
        Returns:
        (undocumented)
      • guardianStrategy

        protected SupervisorStrategy guardianStrategy()
        Overridable supervision strategy to be used by the &ldquo;/user&rdquo; guardian.
        Returns:
        (undocumented)
      • systemGuardianStrategy

        protected SupervisorStrategy systemGuardianStrategy()
        Overridable supervision strategy to be used by the &ldquo;/user&rdquo; guardian.
        Returns:
        (undocumented)
      • 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 interface ActorRefProvider
        Parameters:
        address - (undocumented)
        Returns:
        (undocumented)
      • 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 interface ActorRefProvider
        Parameters:
        actorRef - (undocumented)
        path - (undocumented)
      • unregisterTempActor

        public void unregisterTempActor​(ActorPath path)
        Description copied from interface: ActorRefProvider
        Unregister a temporary actor from the &ldquo;/temp&rdquo; path (i.e. obtained from tempPath()); do NOT pass in any other path.
        Specified by:
        unregisterTempActor in interface ActorRefProvider
        Parameters:
        path - (undocumented)
      • 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 interface ActorRefProvider
        Parameters:
        _system - (undocumented)
      • 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 interface ActorRefProvider
        Parameters:
        path - (undocumented)
        Returns:
        (undocumented)
      • 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 interface ActorRefProvider
        Parameters:
        path - (undocumented)
        Returns:
        (undocumented)
      • resolveActorRef

        public InternalActorRef resolveActorRef​(InternalActorRef ref,
                                                scala.collection.Iterable<java.lang.String> pathElements)
        INTERNAL API
        Parameters:
        ref - (undocumented)
        pathElements - (undocumented)
        Returns:
        (undocumented)
      • 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). 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.
        Specified by:
        actorOf in interface ActorRefProvider
        Parameters:
        system - (undocumented)
        props - (undocumented)
        supervisor - (undocumented)
        path - (undocumented)
        systemService - (undocumented)
        deploy - (undocumented)
        lookupDeploy - (undocumented)
        async - (undocumented)
        Returns:
        (undocumented)
      • 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 interface ActorRefProvider
        Parameters:
        addr - (undocumented)
        Returns:
        (undocumented)