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
- Alphabetic
- By Inheritance
- EntityRef
- RecipientRef
- AnyRef
- Any
- by RecipientRefOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
ask[U](f: (ActorRef[U]) ⇒ M)(implicit timeout: Timeout): Future[U]
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.
-
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
- EntityRef → RecipientRef
Concrete Value Members
-
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"
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (EntityRef[M], B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
?[U](message: (ActorRef[U]) ⇒ M)(implicit timeout: Timeout): Future[U]
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 ? (Request("hello", _))
Please note that an implicit akka.util.Timeout must be available to use this pattern.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- 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
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (EntityRef[M], B)
Shadowed Implicit Value Members
-
def
!(msg: M): Unit
Send a message to the destination referenced by this
RecipientRefusing *at-most-once* messaging semantics.Send a message to the destination referenced by this
RecipientRefusing *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