akka.pattern

AskSupport

trait AskSupport extends AnyRef

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

Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AskSupport
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from AskSupport to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (AskSupport, B)

    Implicit information
    This member is added by an implicit conversion from AskSupport to ArrowAssoc[AskSupport] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. 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)).

    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(selection, request)(timeout)
    flow {
      EnrichedRequest(request, f())
    } pipeTo nextActor

    See scala.concurrent.Future for a description of flow

  10. 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.

  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)).

    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)
    flow {
      EnrichedRequest(request, f())
    } pipeTo nextActor

    See scala.concurrent.Future for a description of flow

  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 clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def ensuring(cond: (AskSupport) ⇒ Boolean, msg: ⇒ Any): AskSupport

    Implicit information
    This member is added by an implicit conversion from AskSupport to Ensuring[AskSupport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (AskSupport) ⇒ Boolean): AskSupport

    Implicit information
    This member is added by an implicit conversion from AskSupport to Ensuring[AskSupport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: ⇒ Any): AskSupport

    Implicit information
    This member is added by an implicit conversion from AskSupport to Ensuring[AskSupport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): AskSupport

    Implicit information
    This member is added by an implicit conversion from AskSupport to Ensuring[AskSupport] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from AskSupport to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. def toString(): String

    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def [B](y: B): (AskSupport, B)

    Implicit information
    This member is added by an implicit conversion from AskSupport to ArrowAssoc[AskSupport] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from AskSupport to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (askSupport: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from AskSupport to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (askSupport: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: AskSupport

    Implicit information
    This member is added by an implicit conversion from AskSupport to ArrowAssoc[AskSupport] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (askSupport: ArrowAssoc[AskSupport]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AskSupport

    Implicit information
    This member is added by an implicit conversion from AskSupport to Ensuring[AskSupport] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (askSupport: Ensuring[AskSupport]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AskSupport to StringAdd

Inherited by implicit conversion any2stringfmt from AskSupport to StringFormat

Inherited by implicit conversion any2ArrowAssoc from AskSupport to ArrowAssoc[AskSupport]

Inherited by implicit conversion any2Ensuring from AskSupport to Ensuring[AskSupport]

Ungrouped