c

akka.stream.stage

GraphStageWithMaterializedValue

abstract class GraphStageWithMaterializedValue[+S <: Shape, +M] extends Graph[S, M]

Scala API: A GraphStage represents a reusable graph stream processing operator.

Extend this GraphStageWithMaterializedValue if you want to provide a materialized value, represented by the type parameter M. If your GraphStage does not need to provide a materialized value you can instead extende GraphStage which materializes a NotUsed value.

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.

See also AbstractGraphStageWithMaterializedValue for Java DSL for this operator.

Source
GraphStage.scala
Linear Supertypes
Graph[S, M], 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, AbstractGraphStageWithMaterializedValue, GraphStage
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphStageWithMaterializedValue
  2. Graph
  3. AnyRef
  4. 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 GraphStageWithMaterializedValue()

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 createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, M)
    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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toany2stringadd[GraphStageWithMaterializedValue[S, M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GraphStageWithMaterializedValue[S, M], B)
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toArrowAssoc[GraphStageWithMaterializedValue[S, M]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addAttributes(attr: Attributes): Graph[S, M]

    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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def async(dispatcher: String, inputBufferSize: Int): Graph[S, M]

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

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    Graph
  10. def async: Graph[S, M]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. def ensuring(cond: (GraphStageWithMaterializedValue[S, M]) => Boolean, msg: => Any): GraphStageWithMaterializedValue[S, M]
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toEnsuring[GraphStageWithMaterializedValue[S, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (GraphStageWithMaterializedValue[S, M]) => Boolean): GraphStageWithMaterializedValue[S, M]
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toEnsuring[GraphStageWithMaterializedValue[S, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): GraphStageWithMaterializedValue[S, M]
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toEnsuring[GraphStageWithMaterializedValue[S, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): GraphStageWithMaterializedValue[S, M]
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toEnsuring[GraphStageWithMaterializedValue[S, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def getAttributes: Attributes
    Definition Classes
    Graph
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def initialAttributes: Attributes
    Attributes
    protected
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def mapMaterializedValue[M2](f: (M) => 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 GraphStageWithMaterializedValue[S, M] toGraphMapMatVal[S, M] 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
  24. def named(name: String): Graph[S, M]

    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
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def withAttributes(attr: Attributes): Graph[S, M]

    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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toStringFormat[GraphStageWithMaterializedValue[S, M]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (GraphStageWithMaterializedValue[S, M], B)
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] toArrowAssoc[GraphStageWithMaterializedValue[S, M]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Graph[S, M]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion GraphMapMatVal fromGraphStageWithMaterializedValue[S, M] to GraphMapMatVal[S, M]

Inherited by implicit conversion any2stringadd fromGraphStageWithMaterializedValue[S, M] to any2stringadd[GraphStageWithMaterializedValue[S, M]]

Inherited by implicit conversion StringFormat fromGraphStageWithMaterializedValue[S, M] to StringFormat[GraphStageWithMaterializedValue[S, M]]

Inherited by implicit conversion Ensuring fromGraphStageWithMaterializedValue[S, M] to Ensuring[GraphStageWithMaterializedValue[S, M]]

Inherited by implicit conversion ArrowAssoc fromGraphStageWithMaterializedValue[S, M] to ArrowAssoc[GraphStageWithMaterializedValue[S, M]]

Ungrouped