Package akka.stream.stage

Class GraphStageWithMaterializedValue<S extends Shape,M>

java.lang.Object

akka.stream.stage.GraphStageWithMaterializedValue<S,M>

All Implemented Interfaces:

Graph<S,M>

Direct Known Subclasses:

AbstractGraphStageWithMaterializedValue, ActorRefBackpressureSource, ActorRefSource, AeronSink, AeronSource, BroadcastHub, ConnectionSourceStage, Decoder, Encoder, FileOutputStage, FileSource, FlatMapPrefix, FutureFlow, GraphStage, GraphStages.FutureFlattenSource, GraphStages.IgnoreSink$, GraphStages.TickSource, HeadOptionStage, InboundControlJunction, InputStreamSinkStage, InputStreamSource, KillSwitches.UniqueBidiKillSwitchStage$, KillSwitches.UniqueKillSwitchStage$, LazySink, LazySource, MaybeSource$, MergeHub, OutboundControlJunction, OutgoingConnectionStage, OutputStreamGraphStage, OutputStreamSourceStage, PartitionHub, QueueSink, QueueSource, SendQueue, SeqStage, SetupFlowStage, SetupSinkStage, SetupSourceStage, SinkRefStageImpl, SourceRefStageImpl, TakeLastStage, TestSinkStage, TestSourceStage

public abstract class GraphStageWithMaterializedValue<S extends Shape,M>
extends java.lang.Object
implements 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.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.stream.Graph

Graph.GraphMapMatVal<S extends Shape,M>

Constructor Summary

Constructors

Constructor	Description
GraphStageWithMaterializedValue()

Method Summary

Modifier and Type	Method	Description
abstract scala.Tuple2<GraphStageLogic,M>	createLogicAndMaterializedValue(Attributes inheritedAttributes)
scala.Tuple2<GraphStageLogic,M>	createLogicAndMaterializedValue(Attributes inheritedAttributes, Materializer materializer)	Grants access to the materializer before preStart of the graph stage logic is invoked.
protected Attributes	initialAttributes()
TraversalBuilder	traversalBuilder()	INTERNAL API
Graph<S,M>	withAttributes(Attributes attr)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.stream.Graph

addAttributes, async, async, async, named, shape

Constructor Detail

GraphStageWithMaterializedValue

public GraphStageWithMaterializedValue()

Method Detail

createLogicAndMaterializedValue

public scala.Tuple2<GraphStageLogic,M> createLogicAndMaterializedValue(Attributes inheritedAttributes,
                                                                             Materializer materializer)

Grants access to the materializer before preStart of the graph stage logic is invoked.

INTERNAL API

createLogicAndMaterializedValue

public abstract scala.Tuple2<GraphStageLogic,M> createLogicAndMaterializedValue(Attributes inheritedAttributes)
                                                                               throws java.lang.Exception

Throws:

java.lang.Exception

initialAttributes

protected Attributes initialAttributes()

traversalBuilder

public final TraversalBuilder traversalBuilder()

INTERNAL API

Specified by:

traversalBuilder in interface Graph<S extends Shape,M>

withAttributes

public final Graph<S,M> withAttributes(Attributes attr)

Specified by:

withAttributes in interface Graph<S extends Shape,M>