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
- Protected
Abstract Value Members
- 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
- abstract def askWithStatus[Res](f: (ActorRef[StatusReply[Res]]) => M)(implicit timeout: Timeout): Future[Res]
The same as ask but only for requests that result in a response of type akka.pattern.StatusReply.
The same as ask but only for requests that result in a response of type akka.pattern.StatusReply. If the response is a akka.pattern.StatusReply.Success the returned future is completed successfully with the wrapped response. If the status response is a akka.pattern.StatusReply.Error the returned future will be failed with the exception in the error (normally a akka.pattern.StatusReply.ErrorMessage).
- abstract def dataCenter: Option[String]
The specified datacenter of the incarnation of the particular entity referenced by this EntityRef, if a datacenter was specified.
- abstract def entityId: String
The identifier for the particular entity referenced by this EntityRef.
The identifier for the particular entity referenced by this EntityRef.
// given sharding, typeKey sharding.entityRefFor(typeKey, "someId").entityId == "someId" // always true
- 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
- abstract def typeKey: EntityTypeKey[M]
The EntityTypeKey associated with this EntityRef.
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 ?[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 preferable 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val ref: RecipientRef[M]
- Implicit
- This member is added by an implicit conversion from EntityRef[M] toRecipientRefOps[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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
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] toRecipientRefOps[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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EntityRef[M] toStringFormat[EntityRef[M]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (EntityRef[M], B)
- Implicit
- This member is added by an implicit conversion from EntityRef[M] toArrowAssoc[EntityRef[M]] 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.