Packages

t

akka.pattern

AskSupport

trait AskSupport extends AnyRef

This object contains implementation details of the “ask” pattern.

Source
AskSupport.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AskSupport
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AskSupport toany2stringadd[AskSupport] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AskSupport, B)
    Implicit
    This member is added by an implicit conversion from AskSupport toArrowAssoc[AskSupport] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def ask(actorSelection: ActorSelection, message: Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]
  8. 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 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 for AskTimeoutException 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
  9. implicit def ask(actorSelection: ActorSelection): AskableActorSelection

    Import this implicit conversion to gain ? and ask methods on akka.actor.ActorSelection, which will defer to the ask(actorSelection, message)(timeout) method defined here.

    Import this implicit conversion to gain ? and ask methods on akka.actor.ActorSelection, which will defer to the ask(actorSelection, message)(timeout) method defined here.

    import akka.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 akka.util.Timeout.

  10. def ask(actorRef: ActorRef, message: Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]
  11. 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 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 for AskTimeoutException 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
  12. implicit def ask(actorRef: ActorRef): AskableActorRef

    Import this implicit conversion to gain ? and ask methods on akka.actor.ActorRef, which will defer to the ask(actorRef, message)(timeout) method defined here.

    Import this implicit conversion to gain ? and ask methods on akka.actor.ActorRef, which will defer to the ask(actorRef, message)(timeout) method defined here.

    import akka.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 akka.util.Timeout.

  13. def askWithStatus(actorRef: ActorRef, message: Any, sender: ActorRef)(implicit timeout: Timeout): Future[Any]

    Use for messages whose response is known to be a akka.pattern.StatusReply.

    Use for messages whose response is known to be a akka.pattern.StatusReply. When a akka.pattern.StatusReply.Success response arrives the future is completed with the wrapped value, if a akka.pattern.StatusReply.Error arrives the future is instead failed.

  14. def askWithStatus(actorRef: ActorRef, message: Any)(implicit timeout: Timeout): Future[Any]

    Use for messages whose response is known to be a akka.pattern.StatusReply.

    Use for messages whose response is known to be a akka.pattern.StatusReply. When a akka.pattern.StatusReply.Success response arrives the future is completed with the wrapped value, if a akka.pattern.StatusReply.Error arrives the future is instead failed.

  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  16. def ensuring(cond: (AskSupport) => Boolean, msg: => Any): AskSupport
    Implicit
    This member is added by an implicit conversion from AskSupport toEnsuring[AskSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (AskSupport) => Boolean): AskSupport
    Implicit
    This member is added by an implicit conversion from AskSupport toEnsuring[AskSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: => Any): AskSupport
    Implicit
    This member is added by an implicit conversion from AskSupport toEnsuring[AskSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): AskSupport
    Implicit
    This member is added by an implicit conversion from AskSupport toEnsuring[AskSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AskSupport toStringFormat[AskSupport] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (AskSupport, B)
    Implicit
    This member is added by an implicit conversion from AskSupport toArrowAssoc[AskSupport] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAskSupport to any2stringadd[AskSupport]

Inherited by implicit conversion StringFormat fromAskSupport to StringFormat[AskSupport]

Inherited by implicit conversion Ensuring fromAskSupport to Ensuring[AskSupport]

Inherited by implicit conversion ArrowAssoc fromAskSupport to ArrowAssoc[AskSupport]

Ungrouped