scala.actors

Channel

class Channel[Msg] extends InputChannel[Msg] with OutputChannel[Msg] with CanReply[Msg, Any]

This class provides a means for typed communication among actors. Only the actor creating an instance of aChannel may receive from it.

source: Channel.scala
    authors:
  1. Philipp Haller

Inherited
  1. Hide All
  2. Show all
  1. CanReply
  2. OutputChannel
  3. InputChannel
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new Channel()

  2. new Channel(receiver: Actor)

Type Members

  1. type Future = Future[P]

    definition classes: ChannelCanReply

Value Members

  1. def !(msg: Msg): Unit

    Sends msg to this channel (asynchronous).

    Sends msg to this channel (asynchronous).

    msg

    the message to send

    definition classes: ChannelOutputChannel
  2. def !!(msg: Msg): Future[Any]

    Sends msg to this channel and immediately returns a future representing the reply value.

    Sends msg to this channel and immediately returns a future representing the reply value.

    msg

    the message to be sent

    returns

    the future

    definition classes: ChannelCanReply
  3. def !![A](msg: Msg, handler: PartialFunction[Any, A]): Future[A]

    Sends msg to this channel and immediately returns a future representing the reply value.

    Sends msg to this channel and immediately returns a future representing the reply value. The reply is post-processed using the partial functionhandler. This also allows to recover a more precise type for the reply value.

    msg

    the message to be sent

    handler

    the function to be applied to the response

    returns

    the future

    definition classes: ChannelCanReply
  4. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  5. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  6. def !?(msec: Long, msg: Msg): Option[Any]

    Sends msg to this channel and awaits reply (synchronous) within msecmilliseconds.

    Sends msg to this channel and awaits reply (synchronous) within msecmilliseconds.

    msec

    the time span before timeout

    msg

    the message to be sent

    returns

    None in case of timeout, otherwise Some(x) where x is the reply

    definition classes: ChannelCanReply
  7. def !?(msg: Msg): Any

    Sends msg to this channel and awaits reply (synchronous).

    Sends msg to this channel and awaits reply (synchronous).

    msg

    the message to be sent

    returns

    the reply

    definition classes: ChannelCanReply
  8. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  9. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  10. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  11. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  12. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  13. def ?: Msg

    Receives the next message from this channel.

    Receives the next message from this channel.

    definition classes: ChannelInputChannel
  14. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  15. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  16. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  17. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  18. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  19. def forward(msg: Msg): Unit

    Forwards msg to this channel (asynchronous).

    Forwards msg to this channel (asynchronous).

    msg

    the message to forward

    definition classes: ChannelOutputChannel
  20. def getClass(): java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  21. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  22. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  23. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  24. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  25. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  26. def react(f: PartialFunction[Msg, Unit]): Nothing

    Receives a message from this channel.

    Receives a message from this channel.

    This method never returns. Therefore, the rest of the computation has to be contained in the actions of the partial function.

    f

    a partial function with message patterns and actions

    definition classes: ChannelInputChannel
  27. def reactWithin(msec: Long)(f: PartialFunction[Any, Unit]): Nothing

    Receives a message from this channel within a certain time span.

    Receives a message from this channel within a certain time span.

    This method never returns. Therefore, the rest of the computation has to be contained in the actions of the partial function.

    msec

    the time span before timeout

    f

    a partial function with message patterns and actions

    definition classes: ChannelInputChannel
  28. def receive[R](f: PartialFunction[Msg, R]): R

    Receives a message from this channel.

    Receives a message from this channel.

    f

    a partial function with message patterns and actions

    returns

    result of processing the received value

    definition classes: ChannelInputChannel
  29. def receiveWithin[R](msec: Long)(f: PartialFunction[Any, R]): R

    Receives a message from this channel within a certain time span.

    Receives a message from this channel within a certain time span.

    msec

    the time span before timeout

    f

    a partial function with message patterns and actions

    returns

    result of processing the received value

    definition classes: ChannelInputChannel
  30. val receiver: Actor

    Returns the Actor that is receiving from this channel.

    Returns the Actor that is receiving from this channel.

    definition classes: ChannelOutputChannel
  31. def send(msg: Msg, replyTo: OutputChannel[Any]): Unit

    Sends msg to this channel (asynchronous) supplying explicit reply destination.

    Sends msg to this channel (asynchronous) supplying explicit reply destination.

    msg

    the message to send

    replyTo

    the reply destination

    definition classes: ChannelOutputChannel
  32. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  33. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  34. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  35. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  36. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef