com.twitter.concurrent

Channel

trait Channel [+A] extends Serialized

A Channel is a unidirectional, read-only communication object. It represents a stream of messages that can be subscribed to. There are any number of subscribers and thus it is also pub-sub hub.

Channel[+A] is a trait. The most common concrete implementation is a ChannelSource. A ChannelSource is both readable and writeable. A typical use case is for a producer to construct a ChannelSource and give it to a consumer, upcasted to a Channel. This is analogous to the Future/Promise relationship.

linear super types: Serialized, AnyRef, Any
known subclasses: ChannelSource
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Channel
  2. Serialized
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. case class Job [T] (promise: Promise[T], doItToIt: () ⇒ T) extends Product

    attributes: protected

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. 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
  3. def ## () : Int

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

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

    attributes: final
    definition classes: AnyRef
  6. 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
  7. 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
  8. 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
  9. 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
  10. val closes : Future[Unit]

    A Future[Unit] indicating when the Channel closed.

    A Future[Unit] indicating when the Channel closed. New observers can no longer be added (calls to respond become no-ops), and no more messages will be delivered.

    attributes: abstract
  11. def collect [B] (f: PartialFunction[A, B]) : Channel[B]

    The typical Scala collect method: a combination of map and filter.

    The typical Scala collect method: a combination of map and filter.

  12. 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
  13. 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
  14. def filter (p: (A) ⇒ Boolean) : Channel[A]

    Produce a new channel, eliminating elements where the predicate obtains.

    Produce a new channel, eliminating elements where the predicate obtains.

  15. 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
  16. def first : Future[A]

    Get a future for the first message to arrive on this Channel, from this point on.

    Get a future for the first message to arrive on this Channel, from this point on.

  17. def getClass () : java.lang.Class[_]

    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
  18. 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
  19. 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
  20. def isOpen : Boolean

    Indicates whether the Channel is open.

    Indicates whether the Channel is open.

    attributes: abstract
  21. def map [B] (f: (A) ⇒ B) : Channel[B]

    Produce a new channel with the function applied to all messages in this channel.

    Produce a new channel with the function applied to all messages in this channel.

  22. def merge [B >: A] (that: Channel[B]) : Channel[B]

    Combine two Channels together to produce a new Channel with messages interleaved.

    Combine two Channels together to produce a new Channel with messages interleaved.

  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 pipe [B >: A] (to: ChannelSource[B]) : Observer

    Pipe the output of this channel to another Channel.

    Pipe the output of this channel to another Channel. If either Channel closes midway through, stop operations.

  27. def respond (k: (A) ⇒ Future[Unit]) : Observer

    Subscribe to messages on this channel.

    Subscribe to messages on this channel. If the channel is closed, this method still returns an Observer. This is a trade-off to avoid excessive lock-contention. Listen for close events if this affects your use case.

    Note: all subclasses of Channel *must* ensure ordered, single-threaded delivery of messages. This means that the callback param k should NEVER be invoked by two threads at once.

    Furthermore, respond() must publish all operations to shared variables to any Threads that will later invoke param k. Thus, any shared variables accessed only from within k needn't be synchronized or annotated volatile.

    Note: hard references may be kept to callbacks added to a channel It is the callers responsibility to dispose() of the Observer to prevent memory leaks.

    k

    A function returning Future[Unit] indicating that the message has been fully processed.

    returns

    an observer object representing the subscription.

    attributes: abstract
  28. def serialized [A] (f: ⇒ A) : Future[A]

    Ensures that events happen in order, one thread at a time.

    Ensures that events happen in order, one thread at a time. This prevents interleaving of message delivery (respond) and lifecycle (close) events.

    Furthermore, it can be used to atomically perform several operations to a Channel at once, without the side-effects of those operations being triggered until the whole "batch" of operations complete. For example, this can be used to attach several observers at once without the possibility of one of the observers being invoked before the others were attached. If two or more observers share mutable state, this would be used to eliminate race-conditions leading to data-integrity woes.

    definition classes: ChannelSerialized
  29. val serializedQueue : Queue[Channel.this.Job[_]]

    attributes: protected
    definition classes: Serialized
  30. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  31. 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
  32. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef

Inherited from Serialized

Inherited from AnyRef

Inherited from Any