EntityRef

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

Instance Constructors

new EntityRef()

Abstract Value Members

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

def !(msg: M): Unit

Implicit information
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
final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Implicit information
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
def ->[B](y: B): (EntityRef[M], B)

Implicit information
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Implicit information
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
def ensuring(cond: (EntityRef[M]) ⇒ Boolean): EntityRef[M]

Implicit information
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
def ensuring(cond: Boolean, msg: ⇒ Any): EntityRef[M]

Implicit information
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
def ensuring(cond: Boolean): EntityRef[M]

Implicit information
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
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Implicit information
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val ref: RecipientRef[M]

Implicit information
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (EntityRef[M], B)

Implicit information
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

Related Doc: package javadsl

abstract class EntityRef[M] extends RecipientRef[M]

Instance Constructors

new EntityRef()

Abstract Value Members

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

abstract def tell(msg: M): Unit

Concrete Value Members

def !(msg: M): Unit

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (EntityRef[M], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (EntityRef[M]) ⇒ Boolean, msg: ⇒ Any): EntityRef[M]

def ensuring(cond: (EntityRef[M]) ⇒ Boolean): EntityRef[M]

def ensuring(cond: Boolean, msg: ⇒ Any): EntityRef[M]

def ensuring(cond: Boolean): EntityRef[M]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ref: RecipientRef[M]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (EntityRef[M], B)

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