trait AskSupport extends AnyRef
This object contains implementation details of the “ask” pattern.
- Source
- AskSupport.scala
- Alphabetic
- By Inheritance
- AskSupport
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- def ask(actorSelection: ActorSelection, message: Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]
- def ask(actorSelection: ActorSelection, message: Any)(implicit timeout: Timeout): Future[Any]
Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
reference provided.Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
reference provided.The Future will be completed with an pekko.pattern.AskTimeoutException after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. in
Await.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
val f = ask(worker, request)(timeout) f.map { response => EnrichedMessage(response) } pipeTo nextActor
- implicit def ask(actorSelection: ActorSelection): AskableActorSelection
Import this implicit conversion to gain
?
andask
methods on pekko.actor.ActorSelection, which will defer to theask(actorSelection, message)(timeout)
method defined here.Import this implicit conversion to gain
?
andask
methods on pekko.actor.ActorSelection, which will defer to theask(actorSelection, message)(timeout)
method defined here.import org.apache.pekko.pattern.ask val future = selection ? message // => ask(selection, message) val future = selection ask message // => ask(selection, message) val future = selection.ask(message)(timeout) // => ask(selection, message)(timeout)
All of the above use an implicit pekko.util.Timeout.
- def ask(actorRef: ActorRef, message: Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]
- def ask(actorRef: ActorRef, message: Any)(implicit timeout: Timeout): Future[Any]
Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
reference provided.Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
reference provided.The Future will be completed with an pekko.pattern.AskTimeoutException after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. in
Await.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
val f = ask(worker, request)(timeout) f.map { response => EnrichedMessage(response) } pipeTo nextActor
- implicit def ask(actorRef: ActorRef): AskableActorRef
Import this implicit conversion to gain
?
andask
methods on pekko.actor.ActorRef, which will defer to theask(actorRef, message)(timeout)
method defined here.Import this implicit conversion to gain
?
andask
methods on pekko.actor.ActorRef, which will defer to theask(actorRef, message)(timeout)
method defined here.import org.apache.pekko.pattern.ask val future = actor ? message // => ask(actor, message) val future = actor ask message // => ask(actor, message) val future = actor.ask(message)(timeout) // => ask(actor, message)(timeout)
All of the above use an implicit pekko.util.Timeout.
- def askWithStatus(actorRef: ActorRef, message: Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]
Use for messages whose response is known to be a pekko.pattern.StatusReply.
Use for messages whose response is known to be a pekko.pattern.StatusReply. When a pekko.pattern.StatusReply.Success response arrives the future is completed with the wrapped value, if a pekko.pattern.StatusReply.Error arrives the future is instead failed.
- def askWithStatus(actorRef: ActorRef, message: Any)(implicit timeout: Timeout): Future[Any]
Use for messages whose response is known to be a pekko.pattern.StatusReply.
Use for messages whose response is known to be a pekko.pattern.StatusReply. When a pekko.pattern.StatusReply.Success response arrives the future is completed with the wrapped value, if a pekko.pattern.StatusReply.Error arrives the future is instead failed.