Package akka.cluster.sharding.typed.internal

Class EntityRefImpl<M>

java.lang.Object

akka.cluster.sharding.typed.javadsl.EntityRef<M>

akka.cluster.sharding.typed.internal.EntityRefImpl<M>

All Implemented Interfaces:

InternalRecipientRef<M>, RecipientRef<M>, EntityRef<M>

public final class EntityRefImpl<M>
extends EntityRef<M>
implements EntityRef<M>, InternalRecipientRef<M>

Similar to akka.actor.typed.scaladsl.AskPattern.PromiseRef but for an `EntityRef` target.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.typed.RecipientRef

RecipientRef.RecipientRefOps<T>, RecipientRef.RecipientRefOps$

Constructor Summary

Constructors

Constructor	Description
EntityRefImpl(ActorRef shardRegion, java.lang.String entityId, EntityTypeKeyImpl<M> typeKey)

Method Summary

Modifier and Type	Method	Description
<U> java.util.concurrent.CompletionStage<U>	ask(Function<ActorRef<U>,M> message, Timeout timeout)	Allows to "ask" the EntityRef for a reply.
<U> scala.concurrent.Future<U>	ask(scala.Function1<ActorRef<U>,M> message, Timeout timeout)	Allows to "ask" the EntityRef for a reply.
boolean	isTerminated()
ActorRefProvider	provider()	Get a reference to the actor ref provider which created this ref.
void	tell(M msg)	Send a message to the destination referenced by this RecipientRef using *at-most-once* messaging semantics.
java.lang.String	toString()

Methods inherited from class akka.cluster.sharding.typed.javadsl.EntityRef

asScala

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.cluster.sharding.typed.scaladsl.EntityRef

$bang, $qmark

Constructor Detail

EntityRefImpl

public EntityRefImpl(ActorRef shardRegion,
                     java.lang.String entityId,
                     EntityTypeKeyImpl<M> typeKey)

Method Detail

ask

public <U> scala.concurrent.Future<U> ask(scala.Function1<ActorRef<U>,M> message,
                                          Timeout timeout)

Description copied from interface: EntityRef

Allows to "ask" the EntityRef for a reply. See 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 Timeout must be available to use this pattern.

Specified by:

ask in interface EntityRef<M>

Parameters:

message - (undocumented)

timeout - (undocumented)

Returns:

(undocumented)

ask

public <U> java.util.concurrent.CompletionStage<U> ask(Function<ActorRef<U>,M> message,
                                                       Timeout timeout)

Description copied from class: EntityRef

Allows to "ask" the EntityRef for a reply. See 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.

Specified by:

ask in class EntityRef<M>

Parameters:

message - (undocumented)

timeout - (undocumented)

Returns:

(undocumented)

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface InternalRecipientRef<M>

Returns:

true if the actor is locally known to be terminated, false if alive or uncertain.

provider

public ActorRefProvider provider()

Description copied from interface: InternalRecipientRef

Get a reference to the actor ref provider which created this ref.

Specified by:

provider in interface InternalRecipientRef<M>

Returns:

(undocumented)

tell

public void tell(M msg)

Description copied from interface: RecipientRef

Send a message to the destination referenced by this RecipientRef using *at-most-once* messaging semantics.

Specified by:

tell in interface EntityRef<M>

Specified by:

tell in interface RecipientRef<M>

Specified by:

tell in class EntityRef<M>

Parameters:

msg - (undocumented)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object