Scala example source code file (CanReply.scala)

This example Scala source code file (CanReply.scala) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Scala tags/keywords

canreply, future, future, long, option, p, p, partialfunction, r, r, t, t

The Scala CanReply.scala source code

/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2005-2011, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */


package scala.actors

/**
 * Defines result-bearing message send operations.
 *
 * @author Philipp Haller
 *
 * @define actor `CanReply`
 */
trait CanReply[-T, +R] {

  type Future[+P] <: () => P

  /**
   * Sends <code>msg to this $actor and
   * awaits reply (synchronous).
   *
   * @param  msg the message to be sent
   * @return     the reply
   */
  def !?(msg: T): R

  /**
   * Sends <code>msg to this $actor and
   * awaits reply (synchronous) within <code>msec
   * milliseconds.
   *
   * @param  msec the time span before timeout
   * @param  msg  the message to be sent
   * @return      <code>None in case of timeout, otherwise
   *              <code>Some(x) where x is the reply
   */
  def !?(msec: Long, msg: T): Option[R]

  /**
   * Sends <code>msg to this $actor and
   * immediately returns a future representing the reply value.
   *
   * @param  msg the message to be sent
   * @return     the future
   */
  def !!(msg: T): Future[R]

  /**
   * Sends <code>msg to this $actor and
   * immediately returns a future representing the reply value.
   * The reply is post-processed using the partial function
   * <code>handler. This also allows to recover a more
   * precise type for the reply value.
   *
   * @param      msg the message to be sent
   * @param  handler the function to be applied to the response
   * @return         the future
   */
  def !![P](msg: T, handler: PartialFunction[R, P]): Future[P]

}