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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphStageWithMaterializedValue
  2. Graph
  3. AnyRef
  4. 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

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] to any2stringadd[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] to ArrowAssoc[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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  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] to Ensuring[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] to Ensuring[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] to Ensuring[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] to Ensuring[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: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] to StringFormat[GraphStageWithMaterializedValue[S, M]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def initialAttributes: Attributes
    Attributes
    protected
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def named(name: String): Graph[S, M]
    Definition Classes
    Graph
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def withAttributes(attr: Attributes): Graph[S, M]
    Definition Classes
    GraphStageWithMaterializedValueGraph
  33. def [B](y: B): (GraphStageWithMaterializedValue[S, M], B)
    Implicit
    This member is added by an implicit conversion from GraphStageWithMaterializedValue[S, M] to ArrowAssoc[GraphStageWithMaterializedValue[S, M]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Graph[S, M]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped