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

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

Can be created by calling Source.asSourceWithContext

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

Instance Constructors

  1. new SourceWithContext(delegate: scaladsl.SourceWithContext[Out, Ctx, Mat])

Type Members

  1. 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 asScala: scaladsl.SourceWithContext[Out, Ctx, Mat]
  3. def asSource(): Source[Pair[Out, Ctx], Mat]

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

  4. 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
  5. 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
  6. def async: Graph[SourceShape[(Out, Ctx)], Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph
  7. def collect[Out2](pf: PartialFunction[Out, Out2]): SourceWithContext[Out2, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.collect.

    Context-preserving variant of akka.stream.javadsl.Source.collect.

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

    See also

    akka.stream.javadsl.Source.collect

  8. def filter(p: Predicate[Out]): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.filter.

    Context-preserving variant of akka.stream.javadsl.Source.filter.

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

    See also

    akka.stream.javadsl.Source.filter

  9. def filterNot(p: Predicate[Out]): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.filterNot.

    Context-preserving variant of akka.stream.javadsl.Source.filterNot.

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

    See also

    akka.stream.javadsl.Source.filterNot

  10. def getAttributes: Attributes
    Definition Classes
    Graph
  11. def grouped(n: Int): SourceWithContext[List[Out], List[Ctx], Mat]

    Context-preserving variant of akka.stream.javadsl.Source.grouped.

    Context-preserving variant of akka.stream.javadsl.Source.grouped.

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

    See also

    akka.stream.javadsl.Source.grouped

  12. def log(name: String): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Flow.log.

    Context-preserving variant of akka.stream.javadsl.Flow.log.

    See also

    akka.stream.javadsl.Flow.log

  13. def log(name: String, log: LoggingAdapter): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Flow.log.

    Context-preserving variant of akka.stream.javadsl.Flow.log.

    See also

    akka.stream.javadsl.Flow.log

  14. def log(name: String, extract: Function[Out, Any]): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Flow.log.

    Context-preserving variant of akka.stream.javadsl.Flow.log.

    See also

    akka.stream.javadsl.Flow.log

  15. def log(name: String, extract: Function[Out, Any], log: LoggingAdapter): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.log.

    Context-preserving variant of akka.stream.javadsl.Source.log.

    See also

    akka.stream.javadsl.Source.log

  16. def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker]): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.

    Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.

    See also

    akka.stream.javadsl.Flow.logWithMarker

  17. def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker], log: MarkerLoggingAdapter): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.

    Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.

    See also

    akka.stream.javadsl.Flow.logWithMarker

  18. def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker], extract: Function[Out, Any]): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.,

    Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.,

    See also

    akka.stream.javadsl.Flow.logWithMarker

  19. def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker], extract: Function[Out, Any], log: MarkerLoggingAdapter): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.logWithMarker.

    Context-preserving variant of akka.stream.javadsl.Source.logWithMarker.

    See also

    akka.stream.javadsl.Source.logWithMarker

  20. def map[Out2](f: Function[Out, Out2]): SourceWithContext[Out2, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.map.

    Context-preserving variant of akka.stream.javadsl.Source.map.

    See also

    akka.stream.javadsl.Source.map

  21. def mapAsync[Out2](parallelism: Int, f: Function[Out, CompletionStage[Out2]]): SourceWithContext[Out2, Ctx, Mat]
  22. def mapConcat[Out2](f: Function[Out, _ <: Iterable[Out2]]): SourceWithContext[Out2, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.mapConcat.

    Context-preserving variant of akka.stream.javadsl.Source.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)

    See also

    akka.stream.javadsl.Source.mapConcat

  23. def mapContext[Ctx2](extractContext: Function[Ctx, Ctx2]): SourceWithContext[Out, Ctx2, Mat]

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

  24. def mapError(pf: PartialFunction[Throwable, Throwable]): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.mapError.

    Context-preserving variant of akka.stream.javadsl.Source.mapError.

    See also

    akka.stream.javadsl.Source.mapError

  25. def mapMaterializedValue[Mat2](f: Function[Mat, Mat2]): SourceWithContext[Out, Ctx, Mat2]

    Context-preserving variant of akka.stream.javadsl.Source.mapMaterializedValue.

    Context-preserving variant of akka.stream.javadsl.Source.mapMaterializedValue.

    See also

    akka.stream.javadsl.Flow.mapMaterializedValue

  26. def named(name: String): Graph[SourceShape[(Out, Ctx)], Mat]

    Specifies the name of the Graph.

    Specifies the name of the Graph. If the name is null or empty the name is ignored, i.e. #none is returned.

    Definition Classes
    Graph
  27. def runWith[M](sink: Graph[SinkShape[Pair[Out, Ctx]], M], materializer: Materializer): M

    Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it.

    Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it. The returned value is the materialized value of the Sink.

    Prefer the method taking an ActorSystem unless you have special requirements.

  28. def runWith[M](sink: Graph[SinkShape[Pair[Out, Ctx]], M], systemProvider: ClassicActorSystemProvider): M

    Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it.

    Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it. The returned value is the materialized value of the Sink.

  29. 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
  30. def sliding(n: Int, step: Int = 1): SourceWithContext[List[Out], List[Ctx], Mat]

    Context-preserving variant of akka.stream.javadsl.Source.sliding.

    Context-preserving variant of akka.stream.javadsl.Source.sliding.

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

    See also

    akka.stream.javadsl.Source.sliding

  31. def throttle(cost: Int, per: Duration, maximumBurst: Int, costCalculation: Function[Out, Integer], mode: ThrottleMode): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    See also

    akka.stream.javadsl.Source.throttle

  32. def throttle(cost: Int, per: Duration, costCalculation: Function[Out, Integer]): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    See also

    akka.stream.javadsl.Source.throttle

  33. def throttle(elements: Int, per: Duration, maximumBurst: Int, mode: ThrottleMode): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    See also

    akka.stream.javadsl.Source.throttle

  34. def throttle(elements: Int, per: Duration): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    Context-preserving variant of akka.stream.javadsl.Source.throttle.

    See also

    akka.stream.javadsl.Source.throttle

  35. def to[Mat2](sink: Graph[SinkShape[Pair[Out, Ctx]], Mat2]): RunnableGraph[Mat]

    Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink, concatenating the processing steps of both.

  36. def toMat[Mat2, Mat3](sink: Graph[SinkShape[Pair[Out, Ctx]], Mat2], combine: Function2[Mat, Mat2, Mat3]): RunnableGraph[Mat3]

    Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink, concatenating the processing steps of both.

  37. def unsafeDataVia[Out2, Mat2](viaFlow: Graph[FlowShape[Out, Out2], Mat2]): SourceWithContext[Out2, Ctx, Mat]

    Transform this flow by the regular flow.

    Transform this flow by the regular flow. The given flow works on the data portion of the stream and ignores the context.

    The given flow *must* not re-order, drop or emit multiple elements for one incoming element, the sequence of incoming contexts is re-combined with the outgoing elements of the stream. If a flow not fulfilling this requirement is used the stream will not fail but continue running in a corrupt state and re-combine incorrect pairs of elements and contexts or deadlock.

    For more background on these requirements see https://doc.akka.io/libraries/akka-core/current/stream/stream-context.html.

    Annotations
    @ApiMayChange()
  38. def via[Out2, Ctx2, Mat2](viaFlow: Graph[FlowShape[Pair[Out, Ctx], Pair[Out2, Ctx2]], Mat2]): SourceWithContext[Out2, Ctx2, Mat]

    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).

    It is up to the implementer to ensure the inner flow does not exhibit any behaviour that is not expected by the downstream elements, such as reordering. For more background on these requirements see https://doc.akka.io/libraries/akka-core/current/stream/stream-context.html.

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

    See also

    akka.stream.javadsl.Flow.via

  39. def withAttributes(attr: Attributes): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.javadsl.Source.withAttributes.

    Context-preserving variant of akka.stream.javadsl.Source.withAttributes.

    Definition Classes
    SourceWithContext → Graph
    See also

    akka.stream.javadsl.Source.withAttributes

Shadowed Implicit Value Members

  1. def mapMaterializedValue[M2](f: (Mat) => M2): Graph[SourceShape[(Out, Ctx)], M2]

    Transform the materialized value of this Graph, leaving all other properties as they were.

    Transform the materialized value of this Graph, leaving all other properties as they were.

    f

    function to map the graph's materialized value

    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] toGraphMapMatVal[SourceShape[(Out, Ctx)], Mat] performed by method GraphMapMatVal in akka.stream.Graph.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (sourceWithContext: GraphMapMatVal[SourceShape[(Out, Ctx)], Mat]).mapMaterializedValue(f)
    Definition Classes
    GraphMapMatVal