Packages

c

akka.stream.scaladsl

SourceWithContext

final class SourceWithContext[+Ctx, +Out, +Mat] extends GraphDelegate[SourceShape[(Out, Ctx)], Mat] with FlowWithContextOps[Ctx, Out, Mat]

A source that provides operations which automatically propagate the context of an element. Only a subset of common operations from FlowOps is supported. As an escape hatch you can use FlowWithContextOps.via to manually provide the context propagation for otherwise unsupported operations.

Can be created by calling Source.startContextPropagation()

API MAY CHANGE

Annotations
@ApiMayChange()
Source
SourceWithContext.scala
Linear Supertypes
FlowWithContextOps[Ctx, Out, Mat], GraphDelegate[SourceShape[(Out, Ctx)], Mat], Graph[SourceShape[(Out, Ctx)], Mat], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SourceWithContext
  2. FlowWithContextOps
  3. GraphDelegate
  4. Graph
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Repr[+C, +O] = ReprMat[C, O, Mat]
    Definition Classes
    FlowWithContextOps
  2. type ReprMat[+C, +O, +M] = SourceWithContext[C, O, M]
    Definition Classes
    SourceWithContextFlowWithContextOps
  3. type Shape = SourceShape[(Out, Ctx)]

    Type-level accessor for the shape parameter of this graph.

    Type-level accessor for the shape parameter of this graph.

    Definition Classes
    Graph

Value Members

  1. def addAttributes(attr: Attributes): Graph[SourceShape[(Out, Ctx)], Mat]

    Add the given attributes to this Graph.

    Add the given attributes to this Graph. If the specific attribute was already present on this graph this means the added attribute will be more specific than the existing one. If this Source is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

    Definition Classes
    Graph
  2. def asJava[JCtx >: Ctx, JOut >: Out, JMat >: Mat]: javadsl.SourceWithContext[JCtx, JOut, JMat]
  3. def async(dispatcher: String, inputBufferSize: Int): Graph[SourceShape[(Out, Ctx)], Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    inputBufferSize

    Set the input buffer to this size for the graph

    Definition Classes
    Graph
  4. def async(dispatcher: String): Graph[SourceShape[(Out, Ctx)], Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    Graph
  5. def async: Graph[SourceShape[(Out, Ctx)], Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph
  6. def collect[Out2](f: PartialFunction[Out, Out2]): Repr[Ctx, Out2]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.collect.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.collect.

    Note, that the context of elements that are filtered out is skipped as well.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.collect

  7. def endContextPropagation: Source[(Out, Ctx), Mat]

    Stops automatic context propagation from here and converts this to a regular stream of a pair of (data, context).

  8. def filter(pred: (Out) ⇒ Boolean): Repr[Ctx, Out]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filter.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filter.

    Note, that the context of elements that are filtered out is skipped as well.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.filter

  9. def filterNot(pred: (Out) ⇒ Boolean): Repr[Ctx, Out]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filterNot.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filterNot.

    Note, that the context of elements that are filtered out is skipped as well.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.filterNot

  10. def grouped(n: Int): Repr[Seq[Ctx], Seq[Out]]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.grouped.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.grouped.

    Each output group will be associated with a Seq of corresponding context elements.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.grouped

  11. def map[Out2](f: (Out) ⇒ Out2): Repr[Ctx, Out2]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.map.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.map.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.map

  12. def mapAsync[Out2](parallelism: Int)(f: (Out) ⇒ Future[Out2]): Repr[Ctx, Out2]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.mapAsync.

  13. def mapConcat[Out2](f: (Out) ⇒ Iterable[Out2]): Repr[Ctx, Out2]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.mapConcat.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.mapConcat.

    The context of the input element will be associated with each of the output elements calculated from this input element.

    Example:

    def dup(element: String) = Seq(element, element)

    Input:

    ("a", 1) ("b", 2)

    inputElements.mapConcat(dup)

    Output:

    ("a", 1) ("a", 1) ("b", 2) ("b", 2)

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.mapConcat

  14. def mapContext[Ctx2](f: (Ctx) ⇒ Ctx2): Repr[Ctx2, Out]

    Apply the given function to each context element (leaving the data elements unchanged).

    Apply the given function to each context element (leaving the data elements unchanged).

    Definition Classes
    FlowWithContextOps
  15. def named(name: String): Graph[SourceShape[(Out, Ctx)], Mat]
    Definition Classes
    Graph
  16. final def shape: SourceShape[(Out, Ctx)]

    The shape of a graph is all that is externally visible: its inlets and outlets.

    The shape of a graph is all that is externally visible: its inlets and outlets.

    Definition Classes
    GraphDelegate → Graph
  17. def sliding(n: Int, step: Int = 1): Repr[Seq[Ctx], Seq[Out]]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.sliding.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.sliding.

    Each output group will be associated with a Seq of corresponding context elements.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.sliding

  18. def statefulMapConcat[Out2](f: () ⇒ (Out) ⇒ Iterable[Out2]): Repr[Ctx, Out2]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.statefulMapConcat.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.statefulMapConcat.

    The context of the input element will be associated with each of the output elements calculated from this input element.

    Example:

    def dup(element: String) = Seq(element, element)

    Input:

    ("a", 1) ("b", 2)

    inputElements.statefulMapConcat(() => dup)

    Output:

    ("a", 1) ("a", 1) ("b", 2) ("b", 2)

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.statefulMapConcat

  19. def via[Ctx2, Out2, Mat2](viaFlow: Graph[FlowShape[(Out, Ctx), (Out2, Ctx2)], Mat2]): Repr[Ctx2, Out2]

    Transform this flow by the regular flow.

    Transform this flow by the regular flow. The given flow must support manual context propagation by taking and producing tuples of (data, context).

    This can be used as an escape hatch for operations that are not (yet) provided with automatic context propagation here.

    Definition Classes
    SourceWithContextFlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.via

  20. def viaMat[Ctx2, Out2, Mat2, Mat3](flow: Graph[FlowShape[(Out, Ctx), (Out2, Ctx2)], Mat2])(combine: (Mat, Mat2) ⇒ Mat3): SourceWithContext[Ctx2, Out2, Mat3]

    Transform this flow by the regular flow.

    Transform this flow by the regular flow. The given flow must support manual context propagation by taking and producing tuples of (data, context).

    This can be used as an escape hatch for operations that are not (yet) provided with automatic context propagation here.

    The combine function is used to compose the materialized values of this flow and that flow into the materialized value of the resulting Flow.

    Definition Classes
    SourceWithContextFlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.viaMat

  21. final def withAttributes(attr: Attributes): Graph[SourceShape[(Out, Ctx)], Mat]
    Definition Classes
    GraphDelegate → Graph