Source

Abstract Value Members

abstract def outputState: TransportState
abstract def peek: PullResult[T]
abstract def pull(): PullResult[T]

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.
abstract def pullWhile(fn: (T) ⇒ PullAction, onComplete: (TerminalPullResult) ⇒ Any): Unit

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.
abstract def terminate(reason: Throwable): Unit

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

Definition Classes
Transport

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def ++[U >: T](next: Source[U]): Source[U]
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
def canPullNonEmpty: Boolean
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def collected: Callback[Iterator[T]]
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fold[U](init: U)(cb: (T, U) ⇒ U): Callback[U]
def foldWhile[U](init: U)(cb: (T, U) ⇒ U)(f: (U) ⇒ Boolean): Callback[U]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def into[X >: T](sink: Sink[X]): Unit
def into[X >: T](sink: Sink[X], linkClosed: Boolean, linkTerminated: Boolean)(onComplete: (NonOpenTransportState) ⇒ Any): Unit

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
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pull(whenReady: (Try[Option[T]]) ⇒ Unit): Unit
def pullCB(): Callback[Option[T]]
def pullUntilNull(fn: (T) ⇒ Boolean): Option[NullPullResult]

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.
def reduce[U >: T](reducer: (U, U) ⇒ U): Callback[U]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Source | package streaming

trait Source[+T] extends Transport

Abstract Value Members

abstract def outputState: TransportState

abstract def peek: PullResult[T]

abstract def pull(): PullResult[T]

abstract def pullWhile(fn: (T) ⇒ PullAction, onComplete: (TerminalPullResult) ⇒ Any): Unit

abstract def terminate(reason: Throwable): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def ++[U >: T](next: Source[U]): Source[U]

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def canPullNonEmpty: Boolean

def clone(): AnyRef

def collected: Callback[Iterator[T]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fold[U](init: U)(cb: (T, U) ⇒ U): Callback[U]

def foldWhile[U](init: U)(cb: (T, U) ⇒ U)(f: (U) ⇒ Boolean): Callback[U]

final def getClass(): Class[_]

def hashCode(): Int

def into[X >: T](sink: Sink[X]): Unit

def into[X >: T](sink: Sink[X], linkClosed: Boolean, linkTerminated: Boolean)(onComplete: (NonOpenTransportState) ⇒ Any): Unit

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pull(whenReady: (Try[Option[T]]) ⇒ Unit): Unit

def pullCB(): Callback[Option[T]]

def pullUntilNull(fn: (T) ⇒ Boolean): Option[NullPullResult]

def reduce[U >: T](reducer: (U, U) ⇒ U): Callback[U]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Transport

Inherited from AnyRef

Inherited from Any

Ungrouped