Packages

final case class AskInitiated[Req, Res, T](target: RecipientRef[Req], responseTimeout: FiniteDuration, responseClass: Class[Res])(askMessage: Req, forwardResponse: (Try[Res]) => Unit, mapResponse: (Try[Res]) => T) extends Effect with Product with Serializable

The behavior initiated an ask via its context. A response or timeout may be sent via this effect to the asking behavior: this effect enforces that at most one response or timeout is sent. Alternatively, one may, after obtaining the effect, test the response adaptation function (without sending a message to the asking behavior) arbitrarily many times via the 'adaptResponse and adaptTimeout methods.

The 'replyToRef' is exposed so that the target inbox can expect the actual message sent to initiate the ask.

Note that this requires the ask to be initiated via the ActorContext. The Future returning ask is not testable in the BehaviorTestKit.

Source
Effect.scala
Linear Supertypes
Serializable, Product, Equals, Effect, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AskInitiated
  2. Serializable
  3. Product
  4. Equals
  5. Effect
  6. AnyRef
  7. 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

Instance Constructors

  1. new AskInitiated(target: RecipientRef[Req], responseTimeout: FiniteDuration, responseClass: Class[Res])(askMessage: Req, forwardResponse: (Try[Res]) => Unit, mapResponse: (Try[Res]) => T)

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 AskInitiated[Req, Res, T] toany2stringadd[AskInitiated[Req, Res, T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AskInitiated[Req, Res, T], B)
    Implicit
    This member is added by an implicit conversion from AskInitiated[Req, Res, T] toArrowAssoc[AskInitiated[Req, Res, T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def adaptResponse(response: Res): T
  7. def adaptTimeout: T
  8. def adaptTimeout(msg: String): T
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val askMessage: Req
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. def ensuring(cond: (AskInitiated[Req, Res, T]) => Boolean, msg: => Any): AskInitiated[Req, Res, T]
    Implicit
    This member is added by an implicit conversion from AskInitiated[Req, Res, T] toEnsuring[AskInitiated[Req, Res, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (AskInitiated[Req, Res, T]) => Boolean): AskInitiated[Req, Res, T]
    Implicit
    This member is added by an implicit conversion from AskInitiated[Req, Res, T] toEnsuring[AskInitiated[Req, Res, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): AskInitiated[Req, Res, T]
    Implicit
    This member is added by an implicit conversion from AskInitiated[Req, Res, T] toEnsuring[AskInitiated[Req, Res, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): AskInitiated[Req, Res, T]
    Implicit
    This member is added by an implicit conversion from AskInitiated[Req, Res, T] toEnsuring[AskInitiated[Req, Res, T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def getResponseTimeout: Duration

    Java API

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def respondWith(response: Res): Unit
  25. val responseClass: Class[Res]
  26. val responseTimeout: FiniteDuration
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. val target: RecipientRef[Req]
  29. def timeout(): Unit
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. 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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AskInitiated[Req, Res, T] toStringFormat[AskInitiated[Req, Res, T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (AskInitiated[Req, Res, T], B)
    Implicit
    This member is added by an implicit conversion from AskInitiated[Req, Res, T] toArrowAssoc[AskInitiated[Req, Res, T]] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from Effect

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAskInitiated[Req, Res, T] to any2stringadd[AskInitiated[Req, Res, T]]

Inherited by implicit conversion StringFormat fromAskInitiated[Req, Res, T] to StringFormat[AskInitiated[Req, Res, T]]

Inherited by implicit conversion Ensuring fromAskInitiated[Req, Res, T] to Ensuring[AskInitiated[Req, Res, T]]

Inherited by implicit conversion ArrowAssoc fromAskInitiated[Req, Res, T] to ArrowAssoc[AskInitiated[Req, Res, T]]

Ungrouped