Class/Object

colossus.streaming

Channel

Related Docs: object Channel | package streaming

Permalink

class Channel[I, O] extends Pipe[I, O]

Linear Supertypes
Pipe[I, O], Source[O], Sink[I], Transport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Channel
  2. Pipe
  3. Source
  4. Sink
  5. Transport
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Channel(sink: Sink[I], source: Source[O])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++[U >: O](next: Source[U]): Source[U]

    Permalink
    Definition Classes
    Source
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def canPullNonEmpty: Boolean

    Permalink
    Definition Classes
    Source
  7. def canPush: Boolean

    Permalink
    Definition Classes
    Sink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def collected: Callback[Iterator[O]]

    Permalink
    Definition Classes
    Source
  10. def complete(): Try[Unit]

    Permalink
    Definition Classes
    ChannelSink
  11. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def fold[U](init: U)(cb: (O, U) ⇒ U): Callback[U]

    Permalink
    Definition Classes
    Source
  15. def foldWhile[U](init: U)(cb: (O, U) ⇒ U)(f: (U) ⇒ Boolean): Callback[U]

    Permalink
    Definition Classes
    Source
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. def inputState: TransportState

    Permalink
    Definition Classes
    ChannelSink
  19. def into[X >: O](sink: Sink[X]): Unit

    Permalink
    Definition Classes
    Source
  20. def into[X >: O](sink: Sink[X], linkClosed: Boolean, linkTerminated: Boolean)(onComplete: (NonOpenTransportState) ⇒ Any): Unit

    Permalink

    Link this source to a sink.

    Link this source to a sink. Items will be pulled from the source and pushed to the sink, respecting backpressure, until either the source is closed or an error occurs. The linkClosed and linkTerminated parameters determine whether to propagate closure/termination of this Source to the linked Sink. However if the sink is closed or terminated first, this source will be terminated.

    sink

    The sink to link to this source

    linkClosed

    if true, the linked sink will be closed when this source is closed

    linkTerminated

    if true, the linked sink will be terminated when this source is terminated

    Definition Classes
    Source
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def mapIn[A](f: (A) ⇒ I): Sink[A]

    Permalink
    Definition Classes
    Sink
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def outputState: TransportState

    Permalink
    Definition Classes
    ChannelSource
  27. def peek: PullResult[O]

    Permalink
    Definition Classes
    ChannelSource
  28. def pull(): PullResult[O]

    Permalink

    Pull the next item from the Source if available.

    Pull the next item from the Source if available. The returned PullResult will indicate whether an item was successfully pulled.

    Definition Classes
    ChannelSource
  29. def pull(whenReady: (Try[Option[O]]) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Source
  30. def pullCB(): Callback[Option[O]]

    Permalink
    Definition Classes
    Source
  31. def pullUntilNull(fn: (O) ⇒ Boolean): Option[NullPullResult]

    Permalink

    Pull until either the supplied function returns false or there are no more items immediately available to pull, in which case a Some[NullPullResult] is returned indicating why the loop stopped.

    Pull until either the supplied function returns false or there are no more items immediately available to pull, in which case a Some[NullPullResult] is returned indicating why the loop stopped.

    Definition Classes
    ChannelSource
  32. def pullWhile(fn: (O) ⇒ PullAction, onc: (TerminalPullResult) ⇒ Any): Unit

    Permalink

    Repeatedly pull items out of a pipe, even if items are not immediately available.

    Repeatedly pull items out of a pipe, even if items are not immediately available. The Source will hold onto the given processing function and immediately forward items into it as they become available. The returned PullAction determines how the Source will proceed with the next item. If PullContinue or Wait are returned, the Source will hold onto the processing function for either when the next item is available or when the returned Signal is fired. onComplete is only called if the Source is closed or terminated while the processing function is in use.

    When Wait is returned, the item that was passed into the processing function is _not_ pulled from the source. Thus when the returned signal is fired and processing resumes, the same item will be passed to the processing function.

    This method is generally intended for linking the output of a Source to the input of a Sink. For a simplified version of this functionality, see Source.into.

    Definition Classes
    ChannelSource
  33. def push(item: I): PushResult

    Permalink
    Definition Classes
    ChannelSink
  34. def pushPeek: PushResult

    Permalink
    Definition Classes
    ChannelSink
  35. def reduce[U >: O](reducer: (U, U) ⇒ U): Callback[U]

    Permalink
    Definition Classes
    Source
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def terminate(reason: Throwable): Unit

    Permalink

    Immediately terminate the transport, permenantly putting it into an error state

    Immediately terminate the transport, permenantly putting it into an error state

    Definition Classes
    ChannelTransport
  38. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def weld[U >: O, T](next: Pipe[U, T]): Pipe[I, T]

    Permalink
    Definition Classes
    Pipe

Inherited from Pipe[I, O]

Inherited from Source[O]

Inherited from Sink[I]

Inherited from Transport

Inherited from AnyRef

Inherited from Any

Ungrouped