abstract class EntityRef[-M] extends RecipientRef[M]
- Alphabetic
- By Inheritance
- EntityRef
- RecipientRef
- AnyRef
- Any
- by RecipientRefOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EntityRef()
Abstract Value Members
- abstract def ask[Res](message: [ActorRef[Res], M], timeout: Duration): CompletionStage[Res]
Allows to "ask" the EntityRef for a reply.
Allows to "ask" the 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.
- Res
The response protocol, what the other actor sends back
- abstract def askWithStatus[Res](f: ([StatusReply[Res]]) => M, timeout: Duration): CompletionStage[Res]
The same as but only for requests that result in a response of type akka.pattern.StatusReply.
The same as but only for requests that result in a response of type . If the response is a the returned future is completed successfully with the wrapped response. If the status response is a the returned future will be failed with the exception in the error (normally a akka.pattern.StatusReply.ErrorMessage).
- 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
- → RecipientRef
Concrete 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.
- Definition Classes
- RecipientRefOps
- def getEntityId: String
The identifier for the particular entity referenced by this EntityRef.
- def getTypeKey: EntityTypeKey[M]
The name of the EntityTypeKey associated with this EntityRef
- 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
Deprecated Value Members
- def getDataCenter: Optional[String]
The specified datacenter of the incarnation of the particular entity referenced by this EntityRef, if a datacenter was specified.
The specified datacenter of the incarnation of the particular entity referenced by this EntityRef, if a datacenter was specified.
- Annotations
- @deprecated
- Deprecated
(Since version 2.10.0) Use Akka Distributed Cluster instead
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 Actor. 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
selfActorRef and watch it in case such notification is desired.Not for user extension.