Packages

abstract class 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 scaladsl.EntityRef[M] with InternalRecipientRef[M]
Annotations
@DoNotInherit()
Source
ClusterSharding.scala
Linear Supertypes
RecipientRef[M], AnyRef, Any
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

Instance Constructors

  1. new EntityRef()

Abstract Value Members

  1. abstract def ask[U](message: Function[ActorRef[U], M], timeout: Timeout): CompletionStage[U]

    Allows to "ask" the EntityRef for a reply.

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

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

  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.

    Definition Classes
    EntityRef → RecipientRef

Concrete 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.
    Definition Classes
    RecipientRefOps
  2. 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