Packages

implicit final class Askable[T] extends AnyVal

See ask

Source
AskPattern.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Askable
  2. AnyVal
  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. All

Instance Constructors

  1. new Askable(ref: RecipientRef[T])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Askable[T] to any2stringadd[Askable[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Askable[T], B)
    Implicit
    This member is added by an implicit conversion from Askable[T] to ArrowAssoc[Askable[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  6. def ?[U](replyTo: (ActorRef[U]) ⇒ T)(implicit timeout: Timeout, scheduler: Scheduler): Future[U]

    The ask-pattern implements the initiator side of a request–reply protocol.

    The ask-pattern implements the initiator side of a request–reply protocol. The ? operator is pronounced as "ask" (and a convenience symbolic operation kept since the previous ask API, if unsure which one to use, prefer the non-symbolic method as it leads to fewer surprises with the scope of the replyTo function)

    Note that if you are inside of an actor you should prefer ActorContext.ask as that provides better safety.

    The party that asks may be within or without an Actor, since the implementation will fabricate a (hidden) ActorRef that is bound to a scala.concurrent.Promise. This ActorRef will need to be injected in the message that is sent to the target Actor in order to function as a reply-to address, therefore the argument to the ask / ? operator is not the message itself but a function that given the reply-to address will create the message.

    case class Request(msg: String, replyTo: ActorRef[Reply])
    case class Reply(msg: String)
    
    implicit val scheduler = system.scheduler
    implicit val timeout = Timeout(3.seconds)
    val target: ActorRef[Request] = ...
    val f: Future[Reply] = target ? (replyTo => (Request("hello", replyTo)))

    Note: it is preferrable to use the non-symbolic ask method as it easier allows for wildcards for the ActorRef.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def ask[U](replyTo: (ActorRef[U]) ⇒ T)(implicit timeout: Timeout, scheduler: Scheduler): Future[U]

    The ask-pattern implements the initiator side of a request–reply protocol.

    The ask-pattern implements the initiator side of a request–reply protocol.

    Note that if you are inside of an actor you should prefer ActorContext.ask as that provides better safety.

    The party that asks may be within or without an Actor, since the implementation will fabricate a (hidden) ActorRef that is bound to a scala.concurrent.Promise. This ActorRef will need to be injected in the message that is sent to the target Actor in order to function as a reply-to address, therefore the argument to the ask / ? operator is not the message itself but a function that given the reply-to address will create the message.

    case class Request(msg: String, replyTo: ActorRef[Reply])
    case class Reply(msg: String)
    
    implicit val scheduler = system.scheduler
    implicit val timeout = Timeout(3.seconds)
    val target: ActorRef[Request] = ...
    val f: Future[Reply] = target.ask(replyTo => (Request("hello", replyTo)))
    // alternatively
    val f2: Future[Reply] = target.ask(Request("hello", _))
    // note that the explicit type on f2 is important for the compiler
    // to understand the type of the wildcard
    Annotations
    @silent()
  9. def ensuring(cond: (Askable[T]) ⇒ Boolean, msg: ⇒ Any): Askable[T]
    Implicit
    This member is added by an implicit conversion from Askable[T] to Ensuring[Askable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Askable[T]) ⇒ Boolean): Askable[T]
    Implicit
    This member is added by an implicit conversion from Askable[T] to Ensuring[Askable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): Askable[T]
    Implicit
    This member is added by an implicit conversion from Askable[T] to Ensuring[Askable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Askable[T]
    Implicit
    This member is added by an implicit conversion from Askable[T] to Ensuring[Askable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Askable[T] to StringFormat[Askable[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  14. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val ref: RecipientRef[T]
  17. def toString(): String
    Definition Classes
    Any
  18. def [B](y: B): (Askable[T], B)
    Implicit
    This member is added by an implicit conversion from Askable[T] to ArrowAssoc[Askable[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd from Askable[T] to any2stringadd[Askable[T]]

Inherited by implicit conversion StringFormat from Askable[T] to StringFormat[Askable[T]]

Inherited by implicit conversion Ensuring from Askable[T] to Ensuring[Askable[T]]

Inherited by implicit conversion ArrowAssoc from Askable[T] to ArrowAssoc[Askable[T]]

Ungrouped