akka.stream.impl

Class StreamLayout.StructuralInfoModule

java.lang.Object

akka.stream.impl.StreamLayout.StructuralInfoModule

All Implemented Interfaces:

StreamLayout.Module, java.io.Serializable, scala.Equals, scala.Product

Enclosing class:

StreamLayout

public static final class StreamLayout.StructuralInfoModule
extends java.lang.Object
implements StreamLayout.Module, scala.Product, scala.Serializable

INTERNAL API

When fusing a Graph a part of the internal stage wirings are hidden within akka.stream.impl.fusing.GraphInterpreter#GraphAssembly objects that are optimized for high-speed execution. This structural information module contains the wirings in a more accessible form, allowing traversal from port to upstream or downstream port and from there to the owning module (or graph vertex).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

StructuralInfoModule(scala.collection.immutable.Set<StreamLayout.Module> subModules, Shape shape, scala.collection.immutable.Map<OutPort,InPort> downstreams, scala.collection.immutable.Map<InPort,OutPort> upstreams, scala.collection.immutable.Map<InPort,StreamLayout.Module> inOwners, scala.collection.immutable.Map<OutPort,StreamLayout.Module> outOwners, scala.collection.immutable.List<scala.Tuple2<StreamLayout.Module,StreamLayout.MaterializedValueNode>> matValues, StreamLayout.MaterializedValueNode materializedValueComputation, Attributes attributes)

Method Summary

Modifier and Type	Method and Description
Attributes	attributes()
StreamLayout.Module	carbonCopy() The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided.
scala.collection.immutable.Map<OutPort,InPort>	downstreams()
scala.collection.immutable.Map<InPort,StreamLayout.Module>	inOwners()
scala.collection.immutable.Set<InPort>	inPorts()
boolean	isFused()
StreamLayout.MaterializedValueNode	materializedValueComputation()
scala.collection.immutable.List<scala.Tuple2<StreamLayout.Module,StreamLayout.MaterializedValueNode>>	matValues()
scala.collection.immutable.Map<OutPort,StreamLayout.Module>	outOwners()
scala.collection.immutable.Set<OutPort>	outPorts()
StreamLayout.Module	replaceShape(Shape s) Verify that the given Shape has the same ports and return a new module with that shape.
Shape	shape()
scala.collection.immutable.Set<StreamLayout.Module>	subModules()
scala.collection.immutable.Map<InPort,OutPort>	upstreams()
StreamLayout.StructuralInfoModule	withAttributes(Attributes attributes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.stream.impl.StreamLayout.Module

compose, compose, composeNoMat, equals, fuse, fuse, hashCode, isAtomic, isBidiFlow, isCopied, isFlow, isRunnable, isSealed, isSink, isSource, transformMaterializedValue, wire

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

StructuralInfoModule

public StructuralInfoModule(scala.collection.immutable.Set<StreamLayout.Module> subModules,
                            Shape shape,
                            scala.collection.immutable.Map<OutPort,InPort> downstreams,
                            scala.collection.immutable.Map<InPort,OutPort> upstreams,
                            scala.collection.immutable.Map<InPort,StreamLayout.Module> inOwners,
                            scala.collection.immutable.Map<OutPort,StreamLayout.Module> outOwners,
                            scala.collection.immutable.List<scala.Tuple2<StreamLayout.Module,StreamLayout.MaterializedValueNode>> matValues,
                            StreamLayout.MaterializedValueNode materializedValueComputation,
                            Attributes attributes)

Method Detail

inPorts

public final scala.collection.immutable.Set<InPort> inPorts()

Specified by:

inPorts in interface StreamLayout.Module

outPorts

public final scala.collection.immutable.Set<OutPort> outPorts()

Specified by:

outPorts in interface StreamLayout.Module

subModules

public scala.collection.immutable.Set<StreamLayout.Module> subModules()

Specified by:

subModules in interface StreamLayout.Module

shape

public Shape shape()

Specified by:

shape in interface StreamLayout.Module

downstreams

public scala.collection.immutable.Map<OutPort,InPort> downstreams()

Specified by:

downstreams in interface StreamLayout.Module

upstreams

public scala.collection.immutable.Map<InPort,OutPort> upstreams()

Specified by:

upstreams in interface StreamLayout.Module

inOwners

public scala.collection.immutable.Map<InPort,StreamLayout.Module> inOwners()

outOwners

public scala.collection.immutable.Map<OutPort,StreamLayout.Module> outOwners()

matValues

public scala.collection.immutable.List<scala.Tuple2<StreamLayout.Module,StreamLayout.MaterializedValueNode>> matValues()

materializedValueComputation

public StreamLayout.MaterializedValueNode materializedValueComputation()

Specified by:

materializedValueComputation in interface StreamLayout.Module

attributes

public Attributes attributes()

Specified by:

attributes in interface StreamLayout.Module

isFused

public boolean isFused()

Specified by:

isFused in interface StreamLayout.Module

replaceShape

public StreamLayout.Module replaceShape(Shape s)

Description copied from interface: StreamLayout.Module

Verify that the given Shape has the same ports and return a new module with that shape. Concrete implementations may throw UnsupportedOperationException where applicable.

Please note that this method MUST NOT be implemented using a CopiedModule since the purpose of replaceShape can also be to rearrange the ports (as in BidiFlow.reversed) and that purpose would be defeated.

Specified by:

replaceShape in interface StreamLayout.Module

Parameters:

s - (undocumented)

Returns:

(undocumented)

carbonCopy

public StreamLayout.Module carbonCopy()

Description copied from interface: StreamLayout.Module

The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided. Where a full copy is not possible or desirable, use a CopiedModule. The shape of the resulting module MUST NOT contain the same ports as this module’s shape.

Specified by:

carbonCopy in interface StreamLayout.Module

Returns:

(undocumented)

withAttributes

public StreamLayout.StructuralInfoModule withAttributes(Attributes attributes)

Specified by:

withAttributes in interface StreamLayout.Module