c

swave.core

StreamGraph

final class StreamGraph[+A] extends AnyRef

A StreamGraph represents a stream graph in which the ports of all stages have been properly connected and which is therefore ready to be started.

If the type parameter A is a Future then run().result returns an A, otherwise a Try[A].

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamGraph
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def mapResult[B](f: (A) ⇒ B): StreamGraph[B]

    Turns this StreamGraph into one with a different result by mapping over the result value.

    Turns this StreamGraph into one with a different result by mapping over the result value.

    NOTE: The result of this call and the underlying StreamGraph share the same stages. This means that only one of them can be sealed and/or run (once).

  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. val result: A
  17. def run()(implicit env: StreamEnv, ev: ToTryOrFuture[A]): StreamRun[Out]

    Seals and starts this StreamGraph and returns the StreamRun instance for the run.

    Seals and starts this StreamGraph and returns the StreamRun instance for the run. The result of the returned StreamRun has either type A if A is a Future, or otherwise Try[A].

    If the stream runs synchronously the call will not return before the stream has finished running completely. In this case the result of the returned StreamRun will be already completed if it's a Future.

    Otherwise, if the stream runs asynchronously, it will return (more or less) immediately and the stream will run detached from the caller thread.

    If there are any problems with sealing the stream setup a respective Exception will be thrown. The non-throwing variant of this method is StreamGraph.tryRun.

  18. def seal()(implicit env: StreamEnv): RunnableStreamGraph[A]

    Prepares this StreamGraph for starting and verifies that the ports of all stages are properly connected.

    Prepares this StreamGraph for starting and verifies that the ports of all stages are properly connected.

    If there is any problem with the stream setup (for example because the graph is not closed or dispatcher assignments are conflicting) a respective Exception will be thrown.

    The non-throwing variant of this method is StreamGraph.trySeal

  19. def stage: Stage

    A Stage of the graph that can serve as a basis for exploring the graph's stage layout.

    A Stage of the graph that can serve as a basis for exploring the graph's stage layout. Often used for rendering via the Graph.render method.

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. def tryRun()(implicit env: StreamEnv, ev: ToTryOrFuture[A]): Try[StreamRun[Out]]

    Same as StreamGraph.run but never throwing.

  23. def trySeal()(implicit env: StreamEnv): Try[RunnableStreamGraph[A]]

    Same as StreamGraph.seal but never throwing.

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

Inherited from AnyRef

Inherited from Any

Ungrouped