Package org.apache.pekko.stream.scaladsl

Class MergePreferred<T>

java.lang.Object

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

org.apache.pekko.stream.stage.GraphStage<MergePreferred.MergePreferredShape<T>>

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

All Implemented Interfaces:

Graph<MergePreferred.MergePreferredShape<T>,NotUsed>

public final class MergePreferred<T>
extends GraphStage<MergePreferred.MergePreferredShape<T>>

Merge several streams, taking elements as they arrive from input streams (picking from preferred when several have elements ready).

A MergePreferred has one out port, one preferred input port and 1 or more secondary in ports.

'''Emits when''' one of the inputs has an element available, preferring a specified input if multiple have elements available

'''Backpressures when''' downstream backpressures

'''Completes when''' all upstreams complete (eagerComplete=false) or one upstream completes (eagerComplete=true), default value is false

'''Cancels when''' downstream cancels

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MergePreferred.MergePreferredShape<T>

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

Graph.GraphMapMatVal<S extends Shape,M>

Constructor Summary

Constructors

Constructor	Description
MergePreferred(int secondaryPorts, boolean eagerComplete)

Method Summary

Modifier and Type	Method	Description
static <T> MergePreferred<T>	apply(int secondaryPorts, boolean eagerComplete)	Create a new MergePreferred with the specified number of secondary input ports.
static <T> boolean	apply$default$2()
GraphStageLogic	createLogic(Attributes inheritedAttributes)
boolean	eagerComplete()
Inlet<T>	in(int id)
Attributes	initialAttributes()
Outlet<T>	out()
Inlet<T>	preferred()
int	secondaryPorts()
MergePreferred.MergePreferredShape<T>	shape()	The shape of a graph is all that is externally visible: its inlets and outlets.

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

createLogicAndMaterializedValue

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

withAttributes

Methods inherited from class java.lang.Object

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

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

addAttributes, async, async, async, getAttributes, named

Constructor Details

MergePreferred

public MergePreferred(int secondaryPorts,
 boolean eagerComplete)

Method Details

apply

public static <T> MergePreferred<T> apply(int secondaryPorts,
 boolean eagerComplete)

Create a new MergePreferred with the specified number of secondary input ports.

Parameters:

secondaryPorts - number of secondary input ports

eagerComplete - if true, the merge will complete as soon as one of its inputs completes.

apply$default$2

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

secondaryPorts

public int secondaryPorts()

eagerComplete

public boolean eagerComplete()

initialAttributes

public Attributes initialAttributes()

Overrides:

initialAttributes in class GraphStageWithMaterializedValue<MergePreferred.MergePreferredShape<T>,NotUsed>

shape

public MergePreferred.MergePreferredShape<T> shape()

Description copied from interface: Graph

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

in

public Inlet<T> in(int id)

out

public Outlet<T> out()

preferred

public Inlet<T> preferred()

createLogic

public GraphStageLogic createLogic(Attributes inheritedAttributes)

Specified by:

createLogic in class GraphStage<MergePreferred.MergePreferredShape<T>>