akka.stream.scaladsl

Class Interleave<T>

java.lang.Object

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

akka.stream.stage.GraphStage<UniformFanInShape<T,T>>

akka.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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Graph<S,M>	addAttributes(Attributes attr)
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 Graph<S,M>	async()
GraphStageLogic	createLogic(Attributes inheritedAttributes)
static scala.Tuple2<GraphStageLogic,NotUsed>	createLogicAndMaterializedValue(Attributes inheritedAttributes)
boolean	eagerClose()
scala.collection.immutable.IndexedSeq<Inlet<T>>	in()
protected static Attributes	initialAttributes()
int	inputPorts()
static StreamLayout.Module	module()
static Graph<S,M>	named(java.lang.String name)
Outlet<T>	out()
int	segmentSize()
UniformFanInShape<T,T>	shape() The shape of a graph is all that is externally visible: its inlets and outlets.
java.lang.String	toString()
static Graph<S,M>	withAttributes(Attributes attr)

Methods inherited from class akka.stream.stage.GraphStage

createLogicAndMaterializedValue

Methods inherited from class akka.stream.stage.GraphStageWithMaterializedValue

initialAttributes, module, withAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.stream.Graph

addAttributes, async, named

Constructor Detail

Interleave

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

Method Detail

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.

Returns:

(undocumented)

named

public static Graph<S,M> named(java.lang.String name)

async

public static Graph<S,M> async()

addAttributes

public static Graph<S,M> addAttributes(Attributes attr)

initialAttributes

protected static Attributes initialAttributes()

module

public static final StreamLayout.Module module()

withAttributes

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

createLogicAndMaterializedValue

public static final scala.Tuple2<GraphStageLogic,NotUsed> createLogicAndMaterializedValue(Attributes inheritedAttributes)

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.

Returns:

(undocumented)

createLogic

public GraphStageLogic createLogic(Attributes inheritedAttributes)

Specified by:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object