Package org.apache.pekko.actor

Interface ActorRefProvider

public interface ActorRefProvider
Interface for all ActorRef providers to implement. Not intended for extension outside of Apache Pekko.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.pekko.actor.InternalActorRef
    actorOf(org.apache.pekko.actor.ActorSystemImpl system, Props props, org.apache.pekko.actor.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).
    String
    addressString()
    INTERNAL API
    ActorRef
    deadLetters()
    Dead letter destination for this provider.
    org.apache.pekko.actor.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.
    org.apache.pekko.actor.LocalActorRef
    guardian()
    Reference to the supervisor used for all top-level user actors.
    ActorRef
    ignoreRef()
    INTERNAL API
    void
    init(org.apache.pekko.actor.ActorSystemImpl system)
    INTERNAL API: Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc.
    void
    registerTempActor(org.apache.pekko.actor.InternalActorRef actorRef, ActorPath path)
    INTERNAL API: Registers an actorRef at a path returned by tempPath(); do NOT pass in any other path.
    ActorRef
    resolveActorRef(String path)
    Create actor reference for a specified path.
    ActorRef
    resolveActorRef(ActorPath path)
    Create actor reference for a specified path.
    org.apache.pekko.actor.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.
    Serialization.Information
    serializationInformation()
    INTERNAL API
    ActorSystem.Settings
    settings()
    The Settings associated with this ActorRefProvider
    org.apache.pekko.actor.LocalActorRef
    systemGuardian()
    Reference to the supervisor used for all top-level system actors.
    org.apache.pekko.actor.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;.
    ActorPath
    tempPath(String prefix)
    Generates and returns a unique actor path starting with prefix 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 Details

    • actorOf

      org.apache.pekko.actor.InternalActorRef actorOf(org.apache.pekko.actor.ActorSystemImpl system, Props props, org.apache.pekko.actor.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). 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.

    • addressString

      String addressString()
      INTERNAL API

    • deadLetters

      ActorRef deadLetters()
      Dead letter destination for this provider.

    • deployer

      org.apache.pekko.actor.Deployer deployer()
      The Deployer associated with this ActorRefProvider

    • getDefaultAddress

      Address getDefaultAddress()
      Obtain the external address of the default transport.

    • 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).

    • guardian

      org.apache.pekko.actor.LocalActorRef guardian()
      Reference to the supervisor used for all top-level user actors.

    • ignoreRef

      ActorRef ignoreRef()
      INTERNAL API

    • init

      void init(org.apache.pekko.actor.ActorSystemImpl system)
      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).

    • registerTempActor

      void registerTempActor(org.apache.pekko.actor.InternalActorRef actorRef, ActorPath path)
      INTERNAL API: Registers an actorRef at a path returned by tempPath(); do NOT pass in any other path.

    • resolveActorRef

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

    • 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.

    • rootGuardian

      org.apache.pekko.actor.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.

    • 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.

    • rootPath

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

    • serializationInformation

      Serialization.Information serializationInformation()
      INTERNAL API

    • settings

      ActorSystem.Settings settings()
      The Settings associated with this ActorRefProvider

    • systemGuardian

      org.apache.pekko.actor.LocalActorRef systemGuardian()
      Reference to the supervisor used for all top-level system actors.

    • tempContainer

      org.apache.pekko.actor.InternalActorRef tempContainer()
      Returns the actor reference representing the &ldquo;/temp&rdquo; path.

    • tempPath

      ActorPath tempPath()
      Generates and returns a unique actor path below &ldquo;/temp&rdquo;.

    • tempPath

      ActorPath tempPath(String prefix)
      Generates and returns a unique actor path starting with prefix below &ldquo;/temp&rdquo;.

    • 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().

    • unregisterTempActor

      void unregisterTempActor(ActorPath path)
      Unregister a temporary actor from the &ldquo;/temp&rdquo; path (i.e. obtained from tempPath()); do NOT pass in any other path.