Scala example source code file (CanReply.scala)

This example Scala source code file (CanReply.scala) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Scala source code examples by using tags.

All credit for the original source code belongs to scala-lang.org; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Scala tags/keywords

actor, canreply, for, future, guide, long, p, partialfunction, r, t, use

The CanReply.scala Scala example source code

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

package scala.actors

import scala.language.higherKinds

/**
 * Defines result-bearing message send operations.
 *
 * @author Philipp Haller
 *
 * @define actor `CanReply`
 */
@deprecated("Use the akka.actor package instead. For migration from the scala.actors package refer to the Actors Migration Guide.", "2.11.0")
trait CanReply[-T, +R] {

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

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

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

  /**
   * Sends `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 `msg` to this $actor and immediately returns a future representing
   * the reply value. The reply is post-processed using the partial function
   * `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]

}