Package org.apache.pekko.actor

Interface ActorRefFactory

All Known Subinterfaces:
AbstractActor.ActorContext, ActorContext
All Known Implementing Classes:
ActorSystem, ExtendedActorSystem
public interface ActorRefFactory
Interface implemented by ActorSystem and ActorContext, the only two places from which you can get fresh actors.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 “$” prepended, may change in the future).
    ActorRef
    actorOf(Props props, String name)
    Create new actor as child of this context with the given name, which must not be null, empty or start with “$”.
    ActorSelection
    actorSelection(String path)
    Construct an pekko.actor.ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally).
    ActorSelection
    actorSelection(ActorPath path)
    Construct an pekko.actor.ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally).
    scala.concurrent.ExecutionContextExecutor
    dispatcher()
    Returns the default MessageDispatcher associated with this ActorRefFactory
    org.apache.pekko.actor.InternalActorRef
    guardian()
    Parent of all children created by this interface.
    org.apache.pekko.actor.InternalActorRef
    lookupRoot()
    INTERNAL API
    ActorRefProvider
    provider()
    INTERNAL API
    void
    stop(ActorRef actor)
    Stop the actor pointed to by the given pekko.actor.ActorRef; this is an asynchronous operation, i.e.
    org.apache.pekko.actor.ActorSystemImpl
    systemImpl()
    INTERNAL API

  • Method Details

    • 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 “$” prepended, may change in the future).

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

      Throws:
      pekko.ConfigurationException - if deployment, dispatcher or mailbox configuration is wrong
      UnsupportedOperationException - if invoked on an ActorSystem that uses a custom user guardian

    • actorOf

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

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

      Throws:
      pekko.actor.InvalidActorNameException - if the given name is invalid or already in use
      pekko.ConfigurationException - if deployment, dispatcher or mailbox configuration is wrong
      UnsupportedOperationException - if invoked on an ActorSystem that uses a custom user guardian

    • actorSelection

      ActorSelection actorSelection(String path)
      Construct an pekko.actor.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.

    • actorSelection

      ActorSelection actorSelection(ActorPath path)
      Construct an pekko.actor.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.

    • dispatcher

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

    • guardian

      org.apache.pekko.actor.InternalActorRef guardian()
      Parent of all children created by this interface.

      INTERNAL API

    • lookupRoot

      org.apache.pekko.actor.InternalActorRef lookupRoot()
      INTERNAL API

    • provider

      ActorRefProvider provider()
      INTERNAL API

    • stop

      void stop(ActorRef actor)
      Stop the actor pointed to by the given pekko.actor.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.

    • systemImpl

      org.apache.pekko.actor.ActorSystemImpl systemImpl()
      INTERNAL API