Package org.apache.pekko.stream

Interface Graph<S extends Shape,M>

All Known Implementing Classes:
AbstractGraphStageWithMaterializedValue, Balance, BidiFlow, BidiFlow, Broadcast, Concat, Flow, Flow, FlowWithContext, FlowWithContext, org.apache.pekko.stream.GraphDelegate, GraphStage, GraphStageWithMaterializedValue, Interleave, KillSwitches.UniqueBidiKillSwitchStage$, KillSwitches.UniqueKillSwitchStage$, Merge, MergeLatest, MergePreferred, MergePrioritized, MergeSequence, MergeSorted, Partition, RestartWithBackoffFlow, RestartWithBackoffSink, RestartWithBackoffSource, RunnableGraph, RunnableGraph, Sink, Sink, org.apache.pekko.stream.impl.SinkModule, Source, Source, org.apache.pekko.stream.impl.SourceModule, SourceWithContext, SourceWithContext, StreamTestKit.ProbeSink, StreamTestKit.ProbeSource, Unzip, UnzipWith10, UnzipWith11, UnzipWith12, UnzipWith13, UnzipWith14, UnzipWith15, UnzipWith16, UnzipWith17, UnzipWith18, UnzipWith19, UnzipWith2, UnzipWith20, UnzipWith21, UnzipWith22, UnzipWith3, UnzipWith4, UnzipWith5, UnzipWith6, UnzipWith7, UnzipWith8, UnzipWith9, Zip, ZipLatest, ZipLatestWith10, ZipLatestWith11, ZipLatestWith12, ZipLatestWith13, ZipLatestWith14, ZipLatestWith15, ZipLatestWith16, ZipLatestWith17, ZipLatestWith18, ZipLatestWith19, ZipLatestWith2, ZipLatestWith20, ZipLatestWith21, ZipLatestWith22, ZipLatestWith3, ZipLatestWith4, ZipLatestWith5, ZipLatestWith6, ZipLatestWith7, ZipLatestWith8, ZipLatestWith9, ZipN, ZipWith10, ZipWith11, ZipWith12, ZipWith13, ZipWith14, ZipWith15, ZipWith16, ZipWith17, ZipWith18, ZipWith19, ZipWith2, ZipWith20, ZipWith21, ZipWith22, ZipWith3, ZipWith4, ZipWith5, ZipWith6, ZipWith7, ZipWith8, ZipWith9, ZipWithN
public interface Graph<S extends Shape,M>
Not intended to be directly extended by user classes

See Also:
  • pekko.stream.stage.GraphStage

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Graph.GraphMapMatVal<S extends Shape,M>
    Scala API, see https://github.com/akka/akka/issues/28501 for discussion why this can't be an instance method on class Graph.

  • Method Summary

    Modifier and Type
    Method
    Description
    Graph<S,M>
    addAttributes(Attributes attr)
    Add the given attributes to this Graph.
    Graph<S,M>
    async()
    Put an asynchronous boundary around this Graph
    Graph<S,M>
    async(String dispatcher)
    Put an asynchronous boundary around this Graph
    Graph<S,M>
    async(String dispatcher, int inputBufferSize)
    Put an asynchronous boundary around this Graph
    Attributes
    getAttributes()
     
    Graph<S,M>
    named(String name)
    Specifies the name of the Graph.
    S
    shape()
    The shape of a graph is all that is externally visible: its inlets and outlets.
    org.apache.pekko.stream.impl.TraversalBuilder
    traversalBuilder()
    INTERNAL API.
    Graph<S,M>
    withAttributes(Attributes attr)
    Replace the attributes of this Flow with the given ones.

  • Method Details

    • shape

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

    • traversalBuilder

      org.apache.pekko.stream.impl.TraversalBuilder traversalBuilder()
      INTERNAL API.

      Every materializable element must be backed by a stream layout module

    • withAttributes

      Graph<S,M> withAttributes(Attributes attr)
      Replace the attributes of this Flow with the given ones. If this Flow 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.

    • named

      Graph<S,M> named(String name)
      Specifies the name of the Graph. If the name is null or empty the name is ignored, i.e. Attributes.none is returned.

    • async

      Graph<S,M> async()
      Put an asynchronous boundary around this Graph

    • async

      Graph<S,M> async(String dispatcher)
      Put an asynchronous boundary around this Graph

      Parameters:
      dispatcher - Run the graph on this dispatcher

    • async

      Graph<S,M> async(String dispatcher, int inputBufferSize)
      Put an asynchronous boundary around this Graph

      Parameters:
      dispatcher - Run the graph on this dispatcher
      inputBufferSize - Set the input buffer to this size for the graph

    • addAttributes

      Graph<S,M> addAttributes(Attributes attr)
      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.

    • getAttributes

      Attributes getAttributes()