scala.actors.OutputChannel.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scala-actors Show documentation

Deprecated Actors Library for Scala

There is a newer version: 2.11.2

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

package scala.actors

/**
 * A common interface for all channels to which values can be sent.
 *
 * @author Philipp Haller
 *
 * @define actor `OutputChannel`
 */
trait OutputChannel[-Msg] {

  /**
   * Sends `msg` to this $actor (asynchronous).
   *
   * @param  msg      the message to send
   */
  def !(msg: Msg): Unit

  /**
   * Sends `msg` to this $actor (asynchronous) supplying
   * explicit reply destination.
   *
   * @param  msg      the message to send
   * @param  replyTo  the reply destination
   */
  def send(msg: Msg, replyTo: OutputChannel[Any]): Unit

  /**
   * Forwards `msg` to this $actor (asynchronous).
   *
   * @param  msg      the message to forward
   */
  def forward(msg: Msg): Unit

  /**
   * Returns the `Actor` that is receiving from this $actor.
   */
  def receiver: InternalActor
}