Packages

trait EntityRef[-M] extends RecipientRef[M]

A reference to an sharded Entity, which allows ActorRef-like usage.

An EntityRef is NOT an ActorRef–by design–in order to be explicit about the fact that the life-cycle of a sharded Entity is very different than a plain Actors. Most notably, this is shown by features of Entities such as re-balancing (an active Entity to a different node) or passivation. Both of which are aimed to be completely transparent to users of such Entity. In other words, if this were to be a plain ActorRef, it would be possible to apply DeathWatch to it, which in turn would then trigger when the sharded Actor stopped, breaking the illusion that Entity refs are "always there". Please note that while not encouraged, it is possible to expose an Actor's self ActorRef and watch it in case such notification is desired. Not for user extension.

Self Type
EntityRef[M] with InternalRecipientRef[M]
Annotations
@DoNotInherit()
Source
ClusterSharding.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityRef
  2. RecipientRef
  3. AnyRef
  4. Any
Implicitly
  1. by RecipientRefOps
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def ask[Res](f: (ActorRef[Res]) ⇒ M)(implicit timeout: Timeout): Future[Res]

    Allows to "ask" the EntityRef for a reply.

    Allows to "ask" the EntityRef for a reply. See akka.actor.typed.scaladsl.AskPattern for a complete write-up of this pattern

    Note that if you are inside of an actor you should prefer akka.actor.typed.scaladsl.ActorContext.ask as that provides better safety.

    Example usage:

    case class Request(msg: String, replyTo: ActorRef[Reply])
    case class Reply(msg: String)
    
    implicit val timeout = Timeout(3.seconds)
    val target: EntityRef[Request] = ...
    val f: Future[Reply] = target.ask(Request("hello", _))

    Please note that an implicit akka.util.Timeout must be available to use this pattern.

    Res

    The response protocol, what the other actor sends back

  2. abstract def tell(msg: M): Unit

    Send a message to the entity referenced by this EntityRef using *at-most-once* messaging semantics.

    Send a message to the entity referenced by this EntityRef using *at-most-once* messaging semantics.

    Example usage:

    val target: EntityRef[String] = ...
    target.tell("Hello")
    Definition Classes
    EntityRefRecipientRef

Concrete Value Members

  1. def !(msg: M): Unit

    Send a message to the entity referenced by this EntityRef using *at-most-once* messaging semantics.

    Send a message to the entity referenced by this EntityRef using *at-most-once* messaging semantics.

    Example usage:

    val target: EntityRef[String] = ...
    target ! "Hello"
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to any2stringadd[EntityRef[M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (EntityRef[M], B)
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to ArrowAssoc[EntityRef[M]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def ?[Res](message: (ActorRef[Res]) ⇒ M)(implicit timeout: Timeout): Future[Res]

    Allows to "ask" the EntityRef for a reply.

    Allows to "ask" the EntityRef for a reply. See akka.actor.typed.scaladsl.AskPattern for a complete write-up of this pattern

    Note that if you are inside of an actor you should prefer akka.actor.typed.scaladsl.ActorContext.ask as that provides better safety.

    Example usage:

    case class Request(msg: String, replyTo: ActorRef[Reply])
    case class Reply(msg: String)
    
    implicit val timeout = Timeout(3.seconds)
    val target: EntityRef[Request] = ...
    val f: Future[Reply] = target ? (replyTo => Request("hello", replyTo))

    Please note that an implicit akka.util.Timeout must be available to use this pattern.

    Note: it is preferrable to use the non-symbolic ask method as it easier allows for wildcards for the replyTo: ActorRef.

    Res

    The response protocol, what the other actor sends back

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. def ensuring(cond: (EntityRef[M]) ⇒ Boolean, msg: ⇒ Any): EntityRef[M]
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to Ensuring[EntityRef[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (EntityRef[M]) ⇒ Boolean): EntityRef[M]
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to Ensuring[EntityRef[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): EntityRef[M]
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to Ensuring[EntityRef[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): EntityRef[M]
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to Ensuring[EntityRef[M]] performed by method Ensuring 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 formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to StringFormat[EntityRef[M]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val ref: RecipientRef[M]
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to RecipientRefOps[M] performed by method RecipientRefOps in akka.actor.typed.RecipientRef.
    Definition Classes
    RecipientRefOps
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (EntityRef[M], B)
    Implicit
    This member is added by an implicit conversion from EntityRef[M] to ArrowAssoc[EntityRef[M]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def !(msg: M): Unit

    Send a message to the destination referenced by this RecipientRef using *at-most-once* messaging semantics.

    Send a message to the destination referenced by this RecipientRef using *at-most-once* messaging semantics.

    Implicit
    This member is added by an implicit conversion from EntityRef[M] to RecipientRefOps[M] performed by method RecipientRefOps in akka.actor.typed.RecipientRef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (entityRef: RecipientRefOps[M]).!(msg)
    Definition Classes
    RecipientRefOps

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from RecipientRef[M]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion RecipientRefOps from EntityRef[M] to RecipientRefOps[M]

Inherited by implicit conversion any2stringadd from EntityRef[M] to any2stringadd[EntityRef[M]]

Inherited by implicit conversion StringFormat from EntityRef[M] to StringFormat[EntityRef[M]]

Inherited by implicit conversion Ensuring from EntityRef[M] to Ensuring[EntityRef[M]]

Inherited by implicit conversion ArrowAssoc from EntityRef[M] to ArrowAssoc[EntityRef[M]]

Ungrouped