c

akka.stream.stage

GraphStage

abstract class GraphStage[S <: Shape] extends GraphStageWithMaterializedValue[S, NotUsed]

A GraphStage represents a reusable graph stream processing operator.

A GraphStage consists of a Shape which describes its input and output ports and a factory function that creates a GraphStageLogic which implements the processing logic that ties the ports together.

Source
GraphStage.scala
Linear Supertypes
GraphStageWithMaterializedValue[S, NotUsed], Graph[S, NotUsed], AnyRef, Any
Known Subclasses
Balance, Broadcast, Concat, Interleave, Merge, MergeLatest, MergePreferred, MergePrioritized, MergeSequence, MergeSorted, Partition, 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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphStage
  2. GraphStageWithMaterializedValue
  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 GraphStage()

Type Members

  1. type Shape = S

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

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

    Definition Classes
    Graph

Abstract Value Members

  1. abstract def createLogic(inheritedAttributes: Attributes): GraphStageLogic
    Annotations
    @throws(classOf[Exception])
  2. abstract def shape: S

    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
    Graph

Concrete Value Members

  1. def addAttributes(attr: Attributes): Graph[S, NotUsed]

    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 async(dispatcher: String, inputBufferSize: Int): Graph[S, NotUsed]

    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
  3. def async(dispatcher: String): Graph[S, NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    Graph
  4. def async: Graph[S, NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph
  5. final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)
    Definition Classes
    GraphStage → GraphStageWithMaterializedValue
  6. def getAttributes: Attributes
    Definition Classes
    Graph
  7. def mapMaterializedValue[M2](f: (NotUsed) => M2): Graph[S, 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 GraphStage[S] toGraphMapMatVal[S, NotUsed] performed by method GraphMapMatVal in akka.stream.Graph.This conversion will take place only if S is a subclass of stream.Shape (S <: stream.Shape).
    Definition Classes
    GraphMapMatVal
  8. def named(name: String): Graph[S, NotUsed]

    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
  9. final def withAttributes(attr: Attributes): Graph[S, NotUsed]

    Replace the attributes of this Flow with the given ones.

    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.

    Definition Classes
    GraphStageWithMaterializedValue → Graph