trait ExplicitAskSupport extends AnyRef
This object contains implementation details of the “ask” pattern, which can be combined with "replyTo" pattern.
- Source
- AskSupport.scala
- Alphabetic
- By Inheritance
- ExplicitAskSupport
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toany2stringadd[ExplicitAskSupport] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ExplicitAskSupport, B)
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toArrowAssoc[ExplicitAskSupport] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def ask(actorSelection: ActorSelection, messageFactory: (ActorRef) => Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]
- def ask(actorSelection: ActorSelection, messageFactory: (ActorRef) => 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 akka.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, replyTo => Request(replyTo))(timeout) f.map { response => EnrichedMessage(response) } pipeTo nextActor
- implicit def ask(actorSelection: ActorSelection): ExplicitlyAskableActorSelection
Import this implicit conversion to gain
?
andask
methods on akka.actor.ActorSelection, which will defer to theask(actorSelection, message)(timeout)
method defined here.Import this implicit conversion to gain
?
andask
methods on akka.actor.ActorSelection, which will defer to theask(actorSelection, message)(timeout)
method defined here.import akka.pattern.ask // same as `ask(selection, askSender => Request(askSender))` val future = selection ? { askSender => Request(askSender) } // same as `ask(selection, Request(_))` val future = selection ? (Request(_)) // same as `ask(selection, Request(_))(timeout)` val future = selection ? (Request(_))(timeout)
All of the above use a required implicit akka.util.Timeout and optional implicit sender akka.actor.ActorRef.
- def ask(actorRef: ActorRef, messageFactory: (ActorRef) => Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]
- def ask(actorRef: ActorRef, messageFactory: (ActorRef) => 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 akka.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, replyTo => Request(replyTo))(timeout) f.map { response => EnrichedMessage(response) } pipeTo nextActor
- implicit def ask(actorRef: ActorRef): ExplicitlyAskableActorRef
Import this implicit conversion to gain
?
andask
methods on akka.actor.ActorRef, which will defer to theask(actorRef, askSender => message)(timeout)
method defined here.Import this implicit conversion to gain
?
andask
methods on akka.actor.ActorRef, which will defer to theask(actorRef, askSender => message)(timeout)
method defined here.import akka.pattern.ask // same as `ask(actor, askSender => Request(askSender))` val future = actor ? { askSender => Request(askSender) } // same as `ask(actor, Request(_))` val future = actor ? (Request(_)) // same as `ask(actor, Request(_))(timeout)` val future = actor ? (Request(_))(timeout)
All of the above use a required implicit akka.util.Timeout and optional implicit sender akka.actor.ActorRef.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (ExplicitAskSupport) => Boolean, msg: => Any): ExplicitAskSupport
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toEnsuring[ExplicitAskSupport] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ExplicitAskSupport) => Boolean): ExplicitAskSupport
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toEnsuring[ExplicitAskSupport] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ExplicitAskSupport
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toEnsuring[ExplicitAskSupport] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ExplicitAskSupport
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toEnsuring[ExplicitAskSupport] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toStringFormat[ExplicitAskSupport] 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,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ExplicitAskSupport, B)
- Implicit
- This member is added by an implicit conversion from ExplicitAskSupport toArrowAssoc[ExplicitAskSupport] 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.