akka.stream.scaladsl

Class Broadcast<T>

java.lang.Object

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

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

akka.stream.scaladsl.Broadcast<T>

All Implemented Interfaces:

Graph<UniformFanOutShape<T,T>,NotUsed>

public final class Broadcast<T>
extends GraphStage<UniformFanOutShape<T,T>>

Fan-out the stream to several streams emitting each incoming upstream element to all downstream consumers. It will not shut down until the subscriptions for at least two downstream subscribers have been established.

'''Emits when''' all of the outputs stops backpressuring and there is an input element available

'''Backpressures when''' any of the outputs backpressure

'''Completes when''' upstream completes

'''Cancels when''' If eagerCancel is enabled: when any downstream cancels; otherwise: when all downstreams cancel

Constructor Summary

Constructors

Constructor and Description
Broadcast(int outputPorts, boolean eagerCancel)

Method Summary

Modifier and Type	Method and Description
static Graph<S,M>	addAttributes(Attributes attr)
static <T> Broadcast<T>	apply(int outputPorts, boolean eagerCancel) Create a new Broadcast with the specified number of output ports.
static Graph<S,M>	async()
GraphStageLogic	createLogic(Attributes inheritedAttributes)
static scala.Tuple2<GraphStageLogic,NotUsed>	createLogicAndMaterializedValue(Attributes inheritedAttributes)
boolean	eagerCancel()
Inlet<T>	in()
Attributes	initialAttributes()
static StreamLayout.Module	module()
static Graph<S,M>	named(java.lang.String name)
scala.collection.immutable.IndexedSeq<Outlet<T>>	out()
int	outputPorts()
UniformFanOutShape<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

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

Broadcast

public Broadcast(int outputPorts,
                 boolean eagerCancel)

Method Detail

apply

public static <T> Broadcast<T> apply(int outputPorts,
                                     boolean eagerCancel)

Create a new Broadcast with the specified number of output ports.

Parameters:

outputPorts - number of output ports

eagerCancel - if true, broadcast cancels upstream if any of its downstreams cancel.

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)

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)

outputPorts

public int outputPorts()

eagerCancel

public boolean eagerCancel()

in

public Inlet<T> in()

out

public scala.collection.immutable.IndexedSeq<Outlet<T>> out()

initialAttributes

public Attributes initialAttributes()

Overrides:

initialAttributes in class GraphStageWithMaterializedValue<UniformFanOutShape<T,T>,NotUsed>

shape

public UniformFanOutShape<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<UniformFanOutShape<T,T>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object