Packages

  • package root
    Definition Classes
    root
  • package akka
    Definition Classes
    root
  • package stream
    Definition Classes
    akka
  • package actor
    Definition Classes
    stream
  • package extra
    Definition Classes
    stream
  • package javadsl
    Definition Classes
    stream
  • package scaladsl

    Scala API: The flow DSL allows the formulation of stream transformations based on some input.

    Scala API: The flow DSL allows the formulation of stream transformations based on some input. The starting point is called Source and can be a collection, an iterator, a block of code which is evaluated repeatedly or a org.reactivestreams.Publisher. A flow with an attached input and open output is also a Source.

    A flow may also be defined without an attached input or output and that is then a Flow. The Flow can be connected to the Source later by using Source#via with the flow as argument, and it remains a Source.

    Transformations can be appended to Source and Flow with the operations defined in FlowOps. Each DSL element produces a new flow that can be further transformed, building up a description of the complete transformation pipeline.

    The termination point of a flow is called Sink and can for example be a Future or org.reactivestreams.Subscriber. A flow with an attached output and open input is also a Sink.

    If a flow has both an attached input and an attached output it becomes a RunnableGraph. In order to execute this pipeline the flow must be materialized by calling RunnableGraph#run on it.

    You can create your Source, Flow and Sink in any order and then wire them together before they are materialized by connecting them using Flow#via and Flow#to, or connecting them into a GraphDSL with fan-in and fan-out elements.

    See Reactive Streams for details on org.reactivestreams.Publisher and org.reactivestreams.Subscriber.

    It should be noted that the streams modeled by this library are “hot”, meaning that they asynchronously flow through a series of processors without detailed control by the user. In particular it is not predictable how many elements a given transformation step might buffer before handing elements downstream, which means that transformation functions may be invoked more often than for corresponding transformations on strict collections like List. *An important consequence* is that elements that were produced into a stream may be discarded by later processors, e.g. when using the #take operator.

    By default every operation is executed within its own akka.actor.Actor to enable full pipelining of the chained set of computations. This behavior is determined by the akka.stream.Materializer which is required by those methods that materialize the Flow into a series of org.reactivestreams.Processor instances. The returned reactive stream is fully started and active.

    Definition Classes
    stream
  • package snapshot
    Definition Classes
    stream
  • ConnectionSnapshot
  • HideImpl
  • InterpreterSnapshot
  • LogicSnapshot
  • MaterializerState
  • RunningInterpreter
  • StreamSnapshot
  • UninitializedInterpreter
  • package stage
    Definition Classes
    stream
  • package testkit
    Definition Classes
    stream
  • package typed
    Definition Classes
    stream
p

akka.stream

snapshot

package snapshot

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait ConnectionSnapshot extends AnyRef

    Not for user extension

    Not for user extension

    Annotations
    @DoNotInherit() @ApiMayChange()
  2. trait HideImpl extends AnyRef

    INTERNAL API

    INTERNAL API

    Annotations
    @InternalApi()
  3. sealed trait InterpreterSnapshot extends AnyRef

    A snapshot of one interpreter - contains a set of logics running in the same underlying actor.

    A snapshot of one interpreter - contains a set of logics running in the same underlying actor. Note that multiple interpreters may be running in the same actor (because of submaterialization)

    Not for user extension

    Annotations
    @DoNotInherit() @ApiMayChange()
  4. sealed trait LogicSnapshot extends AnyRef

    Not for user extension

    Not for user extension

    Annotations
    @DoNotInherit() @ApiMayChange()
  5. sealed trait RunningInterpreter extends InterpreterSnapshot

    A stream interpreter that is running/has been started

    A stream interpreter that is running/has been started

    Annotations
    @DoNotInherit() @ApiMayChange()
  6. sealed trait StreamSnapshot extends AnyRef

    A snapshot of one running stream

    A snapshot of one running stream

    Not for user extension

    Annotations
    @DoNotInherit() @ApiMayChange()
  7. sealed trait UninitializedInterpreter extends InterpreterSnapshot

    A stream interpreter that was not yet initialized when the snapshot was taken

    A stream interpreter that was not yet initialized when the snapshot was taken

    Not for user extension

    Annotations
    @DoNotInherit() @ApiMayChange()

Value Members

  1. object ConnectionSnapshot
    Annotations
    @ApiMayChange()
  2. object MaterializerState

    Debug utility to dump the running streams of a materializers in a structure describing the graph layout and "waits-on" relationships.

    Debug utility to dump the running streams of a materializers in a structure describing the graph layout and "waits-on" relationships.

    Some of the data extracted may be off unless the stream has settled, for example in when deadlocked, but the structure should be valid regardless. Extracting the information often will have an impact on the performance of the running streams.

Ungrouped