Class AskPattern.Askable<Req>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <Res> scala.concurrent.Future<Res> $qmark​(scala.Function1<ActorRef<Res>,​Req> replyTo, Timeout timeout, Scheduler scheduler)
      The ask-pattern implements the initiator side of a request–reply protocol.
      <Res> scala.concurrent.Future<Res> ask​(scala.Function1<ActorRef<Res>,​Req> replyTo, Timeout timeout, Scheduler scheduler)
      The ask-pattern implements the initiator side of a request–reply protocol.
      boolean equals​(java.lang.Object x$1)  
      int hashCode()  
      RecipientRef<Req> ref()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • $qmark

        public <Res> scala.concurrent.Future<Res> $qmark​(scala.Function1<ActorRef<Res>,​Req> replyTo,
                                                         Timeout timeout,
                                                         Scheduler scheduler)
        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 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 system = ...
         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 replyTo: ActorRef.

        Parameters:
        replyTo - (undocumented)
        timeout - (undocumented)
        scheduler - (undocumented)
        Returns:
        (undocumented)
      • ask

        public <Res> scala.concurrent.Future<Res> ask​(scala.Function1<ActorRef<Res>,​Req> replyTo,
                                                      Timeout timeout,
                                                      Scheduler scheduler)
        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 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 system = ...
         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", _))
         

        Parameters:
        replyTo - (undocumented)
        timeout - (undocumented)
        scheduler - (undocumented)
        Returns:
        (undocumented)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object x$1)
        Overrides:
        equals in class java.lang.Object