Packages

t

akka.actor

ActorRefProvider

trait ActorRefProvider extends AnyRef

Interface for all ActorRef providers to implement.

Source
ActorRefProvider.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorRefProvider
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def actorOf(system: ActorSystemImpl, props: Props, supervisor: InternalActorRef, path: ActorPath, systemService: Boolean, deploy: Option[Deploy], lookupDeploy: Boolean, async: Boolean): InternalActorRef

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

    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.

  2. abstract def deadLetters: ActorRef

    Dead letter destination for this provider.

  3. abstract def deployer: Deployer

    The Deployer associated with this ActorRefProvider

  4. abstract def getDefaultAddress: Address

    Obtain the external address of the default transport.

  5. abstract def getExternalAddressFor(addr: Address): Option[Address]

    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.

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

  6. abstract def guardian: LocalActorRef

    Reference to the supervisor used for all top-level user actors.

  7. abstract def init(system: ActorSystemImpl): Unit

    Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc.

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

  8. abstract def registerTempActor(actorRef: InternalActorRef, path: ActorPath): Unit

    Registers an actorRef at a path returned by tempPath(); do NOT pass in any other path.

  9. abstract def resolveActorRef(path: ActorPath): ActorRef

    Create actor reference for a specified path.

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

  10. abstract def resolveActorRef(path: String): ActorRef

    Create actor reference for a specified path.

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

  11. abstract def rootGuardian: InternalActorRef

    Reference to the supervisor of guardian and systemGuardian; this is exposed so that the ActorSystemImpl can use it as lookupRoot, i.e.

    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.

  12. abstract def rootGuardianAt(address: Address): ActorRef

    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.

    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.

  13. abstract def rootPath: ActorPath

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

  14. abstract def settings: Settings

    The Settings associated with this ActorRefProvider

  15. abstract def systemGuardian: LocalActorRef

    Reference to the supervisor used for all top-level system actors.

  16. abstract def tempContainer: InternalActorRef

    Returns the actor reference representing the “/temp” path.

  17. abstract def tempPath(): ActorPath

    Generates and returns a unique actor path below “/temp”.

  18. abstract def terminationFuture: Future[Terminated]

    This Future is completed upon termination of this ActorRefProvider, which is usually initiated by stopping the guardian via ActorSystem.stop().

  19. abstract def unregisterTempActor(path: ActorPath): Unit

    Unregister a temporary actor from the “/temp” path (i.e.

    Unregister a temporary actor from the “/temp” path (i.e. obtained from tempPath()); do NOT pass in any other path.