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
- Alphabetic
- By Inheritance
- GraphStage
- GraphStageWithMaterializedValue
- Graph
- AnyRef
- Any
- by GraphMapMatVal
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new GraphStage()
Type Members
Abstract Value Members
- abstract def createLogic(inheritedAttributes: Attributes): GraphStageLogic
- Annotations
- @throws(classOf[Exception])
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toany2stringadd[GraphStage[S]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (GraphStage[S], B)
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toArrowAssoc[GraphStage[S]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def async(dispatcher: String, inputBufferSize: Int): Graph[S, NotUsed]
Put an asynchronous boundary around this
GraphPut 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
- def async(dispatcher: String): Graph[S, NotUsed]
Put an asynchronous boundary around this
GraphPut an asynchronous boundary around this
Graph- dispatcher
Run the graph on this dispatcher
- Definition Classes
- Graph
- def async: Graph[S, NotUsed]
Put an asynchronous boundary around this
GraphPut an asynchronous boundary around this
Graph- Definition Classes
- Graph
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)
- Definition Classes
- GraphStage → GraphStageWithMaterializedValue
- def ensuring(cond: (GraphStage[S]) => Boolean, msg: => Any): GraphStage[S]
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toEnsuring[GraphStage[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (GraphStage[S]) => Boolean): GraphStage[S]
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toEnsuring[GraphStage[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): GraphStage[S]
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toEnsuring[GraphStage[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): GraphStage[S]
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toEnsuring[GraphStage[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def getAttributes: Attributes
- Definition Classes
- Graph
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def initialAttributes: Attributes
- Attributes
- protected
- Definition Classes
- GraphStageWithMaterializedValue
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toStringFormat[GraphStage[S]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (GraphStage[S], B)
- Implicit
- This member is added by an implicit conversion from GraphStage[S] toArrowAssoc[GraphStage[S]] 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.