scala.actors

Channel

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

Provides a means for typed communication among actors. Only the actor creating an instance of a Channel may receive from it.

Source
Channel.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Channel
  2. CanReply
  3. OutputChannel
  4. InputChannel
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Channel()

  2. new Channel(receiver: InternalActor)

Type Members

  1. type Future[+P] = actors.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 function handler. 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. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  6. def !?(msec: Long, msg: Msg): Option[Any]

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

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

    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. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  9. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  10. def ->[B](y: B): (Channel[Msg], B)

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to ArrowAssoc[Channel[Msg]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  11. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

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

    Definition Classes
    Any
  13. def ?: Msg

    Receives the next message from this channel.

    Receives the next message from this channel.

    Definition Classes
    ChannelInputChannel
  14. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    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 expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(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 type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  15. def clone(): AnyRef

    Create a copy of the receiver object.

    Create 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  16. def ensuring(cond: (Channel[Msg]) ⇒ Boolean, msg: ⇒ Any): Channel[Msg]

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to Ensuring[Channel[Msg]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (Channel[Msg]) ⇒ Boolean): Channel[Msg]

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to Ensuring[Channel[Msg]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: ⇒ Any): Channel[Msg]

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to Ensuring[Channel[Msg]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): Channel[Msg]

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to Ensuring[Channel[Msg]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional 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).

    returns

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

    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

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

    Definition Classes
    AnyRef → Any
  22. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  23. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. 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
  25. final def getClass(): Class[_]

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

    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.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  26. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  27. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.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 specified type.

    returns

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

    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

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

    Definition Classes
    AnyRef
  29. final 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.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  30. final 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.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  31. 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
  32. 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
  33. 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
  34. 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
  35. val receiver: InternalActor

    Returns the Actor that is receiving from this channel.

    Returns the Actor that is receiving from this channel.

    Definition Classes
    ChannelOutputChannel
  36. 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
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  38. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  40. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  42. def [B](y: B): (Channel[Msg], B)

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to ArrowAssoc[Channel[Msg]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (channel: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (channel: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Channel[Msg]

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to ArrowAssoc[Channel[Msg]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (channel: ArrowAssoc[Channel[Msg]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Channel[Msg]

    Implicit information
    This member is added by an implicit conversion from Channel[Msg] to Ensuring[Channel[Msg]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (channel: Ensuring[Channel[Msg]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from CanReply[Msg, Any]

Inherited from OutputChannel[Msg]

Inherited from InputChannel[Msg]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Channel[Msg] to StringAdd

Inherited by implicit conversion any2stringfmt from Channel[Msg] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Channel[Msg] to ArrowAssoc[Channel[Msg]]

Inherited by implicit conversion any2Ensuring from Channel[Msg] to Ensuring[Channel[Msg]]

Ungrouped