akka.actor

ActorRefProvider

trait ActorRefProvider extends AnyRef

Interface for all ActorRef providers to implement.

Source
ActorRefProvider.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ActorRefProvider
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
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.

    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.

    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.

    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[Unit]

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

    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.

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

  20. abstract def actorFor(ref: InternalActorRef, p: Iterable[String]): InternalActorRef

    Create actor reference for the specified child path starting at the given starting point.

    Create actor reference for the specified child path starting at the given starting point. This method always returns an actor which is “logically local”, i.e. it cannot be used to obtain a reference to an actor which is not physically or logically attached to this actor system.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

  21. abstract def actorFor(ref: InternalActorRef, s: String): InternalActorRef

    Create actor reference for a specified local or remote path, which will be parsed using java.

    Create actor reference for a specified local or remote path, which will be parsed using java.net.URI. If no such actor exists, it will be (equivalent to) a dead letter reference. If s is a relative URI, resolve it relative to the given ref.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

  22. abstract def actorFor(path: ActorPath): InternalActorRef

    Create actor reference for a specified local or remote path.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ActorRefProvider, B)

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to ArrowAssoc[ActorRefProvider] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (ActorRefProvider) ⇒ Boolean, msg: ⇒ Any): ActorRefProvider

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to Ensuring[ActorRefProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ActorRefProvider) ⇒ Boolean): ActorRefProvider

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to Ensuring[ActorRefProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): ActorRefProvider

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to Ensuring[ActorRefProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ActorRefProvider

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to Ensuring[ActorRefProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (ActorRefProvider, B)

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to ArrowAssoc[ActorRefProvider] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefProvider: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefProvider: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ActorRefProvider

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to ArrowAssoc[ActorRefProvider] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefProvider: ArrowAssoc[ActorRefProvider]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ActorRefProvider

    Implicit information
    This member is added by an implicit conversion from ActorRefProvider to Ensuring[ActorRefProvider] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefProvider: Ensuring[ActorRefProvider]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorRefProvider to StringAdd

Inherited by implicit conversion any2stringfmt from ActorRefProvider to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ActorRefProvider to ArrowAssoc[ActorRefProvider]

Inherited by implicit conversion any2Ensuring from ActorRefProvider to Ensuring[ActorRefProvider]

Ungrouped