Package org.apache.pekko.stream.scaladsl

Class Interleave<T>

java.lang.Object

org.apache.pekko.stream.stage.GraphStageWithMaterializedValue<S,NotUsed>

org.apache.pekko.stream.stage.GraphStage<UniformFanInShape<T,T>>

org.apache.pekko.stream.scaladsl.Interleave<T>

All Implemented Interfaces:

Graph<UniformFanInShape<T,T>,NotUsed>

public final class Interleave<T>
extends GraphStage<UniformFanInShape<T,T>>

Interleave represents deterministic merge which takes N elements per input stream, in-order of inputs, emits them downstream and then cycles/"wraps-around" the inputs.

'''Emits when''' element is available from current input (depending on phase)

'''Backpressures when''' downstream backpressures

'''Completes when''' all upstreams complete (eagerClose=false) or one upstream completes (eagerClose=true)

'''Cancels when''' downstream cancels

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pekko.stream.Graph

Graph.GraphMapMatVal<S extends Shape,M>

Constructor Summary

Constructors

Constructor	Description
Interleave(int inputPorts, int segmentSize, boolean eagerClose)

Method Summary

Modifier and Type	Method	Description
static <T> Graph<UniformFanInShape<T,T>,NotUsed>	apply(int inputPorts, int segmentSize, boolean eagerClose)	Create a new Interleave with the specified number of input ports and given size of elements to take from each input.
static <T> boolean	apply$default$3()
GraphStageLogic	createLogic(Attributes inheritedAttributes)
boolean	eagerClose()
scala.collection.immutable.IndexedSeq<Inlet<T>>	in()
int	inputPorts()
Outlet<T>	out()
int	segmentSize()
UniformFanInShape<T,T>	shape()	The shape of a graph is all that is externally visible: its inlets and outlets.
String	toString()

Methods inherited from class org.apache.pekko.stream.stage.GraphStage

createLogicAndMaterializedValue

Methods inherited from class org.apache.pekko.stream.stage.GraphStageWithMaterializedValue

initialAttributes, withAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pekko.stream.Graph

addAttributes, async, async, async, getAttributes, named

Constructor Details

Interleave

public Interleave(int inputPorts,
 int segmentSize,
 boolean eagerClose)

Method Details

apply

public static <T>
Graph<UniformFanInShape<T,T>,NotUsed> apply(int inputPorts,
 int segmentSize,
 boolean eagerClose)

Create a new Interleave with the specified number of input ports and given size of elements to take from each input.

Parameters:

inputPorts - number of input ports

segmentSize - number of elements to send downstream before switching to next input port

eagerClose - if true, interleave completes upstream if any of its upstream completes.

apply$default$3

public static <T> boolean apply$default$3()

inputPorts

public int inputPorts()

segmentSize

public int segmentSize()

eagerClose

public boolean eagerClose()

in

public scala.collection.immutable.IndexedSeq<Inlet<T>> in()

out

public Outlet<T> out()

shape

public UniformFanInShape<T,T> shape()

Description copied from interface: Graph

The shape of a graph is all that is externally visible: its inlets and outlets.

createLogic

public GraphStageLogic createLogic(Attributes inheritedAttributes)

Specified by:

createLogic in class GraphStage<UniformFanInShape<T,T>>

toString

public String toString()

Overrides:

toString in class Object