Package akka.actor

Interface ActorRefFactory

    • Method Detail

      • actorFor

        ActorRef actorFor​(ActorPath path)
        Deprecated.
        use actorSelection instead of actorFor. Since 2.2.
        INTERNAL API

        Look-up an actor by path; if it does not exist, returns a reference to the dead-letter mailbox of the ActorSystem. If the path point to an actor which is not local, no attempt is made during this call to verify that the actor it represents does exist or is alive; use watch(ref) to be notified of the target’s termination, which is also signaled if the queried path cannot be resolved.

        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

        ActorRef actorFor​(java.lang.String path)
        Deprecated.
        use actorSelection instead of actorFor. Since 2.2.
        INTERNAL API

        Look-up an actor by path represented as string.

        Absolute URIs like akka://appname/user/actorA are looked up as described for look-ups by actorOf(ActorPath).

        Relative URIs like /service/actorA/childB are looked up relative to the root path of the ActorSystem containing this factory and as described for look-ups by actorOf(Iterable[String]).

        Relative URIs like myChild/grandChild or ../myBrother are looked up relative to the current context as described for look-ups by actorOf(Iterable[String])

        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

        ActorRef actorFor​(scala.collection.Iterable<java.lang.String> path)
        Deprecated.
        use actorSelection instead of actorFor. Since 2.2.
        INTERNAL API

        Look-up an actor by applying the given path elements, starting from the current context, where ".." signifies the parent of an actor.

        Example: 

        
 class MyActor extends Actor {
   def receive = {
     case msg =>
       ...
       val target = context.actorFor(Seq("..", "myBrother", "myNephew"))
       ...
   }
 }

        For maximum performance use a collection with efficient head & tail operations.

        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

        ActorRef actorFor​(java.lang.Iterable<java.lang.String> path)
        Deprecated.
        use actorSelection instead of actorFor. Since 2.2.
        INTERNAL API

        Java API: Look-up an actor by applying the given path elements, starting from the current context, where ".." signifies the parent of an actor.

        For maximum performance use a collection with efficient head & tail operations.

        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)

      • actorOf

        ActorRef actorOf​(Props props)
        Create new actor as child of this context and give it an automatically generated name (currently similar to base64-encoded integer count, reversed and with &ldquo;$&rdquo; prepended, may change in the future).

        See Props for details on how to obtain a Props object.

        Parameters:
        props - (undocumented)
        Returns:
        (undocumented)
        Throws:
        ConfigurationException - if deployment, dispatcher or mailbox configuration is wrong
        java.lang.UnsupportedOperationException - if invoked on an ActorSystem that uses a custom user guardian

      • actorOf

        ActorRef actorOf​(Props props,
                 java.lang.String name)
        Create new actor as child of this context with the given name, which must not be null, empty or start with &ldquo;$&rdquo;. If the given name is already in use, an InvalidActorNameException is thrown.

        See Props for details on how to obtain a Props object.

        Parameters:
        props - (undocumented)
        name - (undocumented)
        Returns:
        (undocumented)
        Throws:
        InvalidActorNameException - if the given name is invalid or already in use
        ConfigurationException - if deployment, dispatcher or mailbox configuration is wrong
        java.lang.UnsupportedOperationException - if invoked on an ActorSystem that uses a custom user guardian

      • actorSelection

        ActorSelection actorSelection​(java.lang.String path)
        Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors.
        Parameters:
        path - (undocumented)
        Returns:
        (undocumented)

      • actorSelection

        ActorSelection actorSelection​(ActorPath path)
        Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors.
        Parameters:
        path - (undocumented)
        Returns:
        (undocumented)

      • dispatcher

        scala.concurrent.ExecutionContextExecutor dispatcher()
        Returns the default MessageDispatcher associated with this ActorRefFactory
        Returns:
        (undocumented)

      • guardian

        InternalActorRef guardian()
        Father of all children created by this interface.

        INTERNAL API

        Returns:
        (undocumented)

      • lookupRoot

        InternalActorRef lookupRoot()
        INTERNAL API
        Returns:
        (undocumented)

      • stop

        void stop​(ActorRef actor)
        Stop the actor pointed to by the given ActorRef; this is an asynchronous operation, i.e. involves a message send. If this method is applied to the self reference from inside an Actor then that Actor is guaranteed to not process any further messages after this call; please note that the processing of the current message will continue, this method does not immediately terminate this actor.
        Parameters:
        actor - (undocumented)

      • systemImpl

        ActorSystemImpl systemImpl()
        INTERNAL API
        Returns:
        (undocumented)