Interface EntityRef<M>
-
- All Superinterfaces:
RecipientRef<M>
- All Known Implementing Classes:
EntityRefImpl
public interface EntityRef<M> extends RecipientRef<M>
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")
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface akka.actor.typed.RecipientRef
RecipientRef.RecipientRefOps<T>, RecipientRef.RecipientRefOps$
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
$bang(M msg)
Send a message to the entity referenced by this EntityRef using *at-most-once* messaging semantics.<U> scala.concurrent.Future<U>
$qmark(scala.Function1<ActorRef<U>,M> message, Timeout timeout)
Allows to "ask" theEntityRef
for a reply.<U> scala.concurrent.Future<U>
ask(scala.Function1<ActorRef<U>,M> f, Timeout timeout)
Allows to "ask" theEntityRef
for a reply.void
tell(M msg)
Send a message to the entity referenced by this EntityRef using *at-most-once* messaging semantics.
-
-
-
Method Detail
-
$bang
void $bang(M msg)
Send a message to the entity referenced by this EntityRef using *at-most-once* messaging semantics.Example usage:
val target: EntityRef[String] = ... target ! "Hello"
- Parameters:
msg
- (undocumented)
-
$qmark
<U> scala.concurrent.Future<U> $qmark(scala.Function1<ActorRef<U>,M> message, Timeout timeout)
Allows to "ask" theEntityRef
for a reply. SeeAskPattern
for a complete write-up of this patternNote 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
Timeout
must be available to use this pattern.- Parameters:
message
- (undocumented)timeout
- (undocumented)- Returns:
- (undocumented)
-
ask
<U> scala.concurrent.Future<U> ask(scala.Function1<ActorRef<U>,M> f, Timeout timeout)
Allows to "ask" theEntityRef
for a reply. SeeAskPattern
for a complete write-up of this patternNote 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.- Parameters:
f
- (undocumented)timeout
- (undocumented)- Returns:
- (undocumented)
-
tell
void tell(M msg)
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")
- Specified by:
tell
in interfaceRecipientRef<M>
- Parameters:
msg
- (undocumented)
-
-