Packages

t

akka.actor

ActorRefProvider

trait ActorRefProvider extends AnyRef

Interface for all ActorRef providers to implement. Not intended for extension outside of Akka.

Annotations
@DoNotInherit()
Source
ActorRefProvider.scala
Linear Supertypes
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. Protected

Abstract Value Members

  1. abstract def deadLetters: ActorRef

    Dead letter destination for this provider.

  2. abstract def deployer: Deployer

    The Deployer associated with this ActorRefProvider

  3. abstract def getDefaultAddress: Address

    Obtain the external address of the default transport.

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

  5. abstract def guardian: LocalActorRef

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

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

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

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

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

  10. abstract def rootPath: ActorPath

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

  11. abstract def settings: Settings

    The Settings associated with this ActorRefProvider

  12. abstract def systemGuardian: LocalActorRef

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

  13. abstract def systemUid: Long
  14. abstract def tempContainer: InternalActorRef

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

  15. abstract def tempPath(prefix: String): ActorPath

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

  16. abstract def tempPath(): ActorPath

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

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

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toany2stringadd[ActorRefProvider] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ActorRefProvider, B)
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toArrowAssoc[ActorRefProvider] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (ActorRefProvider) => Boolean, msg: => Any): ActorRefProvider
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toEnsuring[ActorRefProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ActorRefProvider) => Boolean): ActorRefProvider
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toEnsuring[ActorRefProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ActorRefProvider
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toEnsuring[ActorRefProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ActorRefProvider
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toEnsuring[ActorRefProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toStringFormat[ActorRefProvider] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (ActorRefProvider, B)
    Implicit
    This member is added by an implicit conversion from ActorRefProvider toArrowAssoc[ActorRefProvider] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromActorRefProvider to any2stringadd[ActorRefProvider]

Inherited by implicit conversion StringFormat fromActorRefProvider to StringFormat[ActorRefProvider]

Inherited by implicit conversion Ensuring fromActorRefProvider to Ensuring[ActorRefProvider]

Inherited by implicit conversion ArrowAssoc fromActorRefProvider to ArrowAssoc[ActorRefProvider]

Ungrouped