Class BroadcastHub$
- java.lang.Object
-
- akka.stream.scaladsl.BroadcastHub$
-
public class BroadcastHub$ extends java.lang.Object
Creates aSink
that receives elements from its upstream producer and broadcasts them to a dynamic set of consumers. After theSink
returned by this method is materialized, it returns aSource
as materialized value. ThisSource
can be materialized an arbitrary number of times and each materialization will receive the broadcast elements from the originalSink
.Every new materialization of the
Sink
results in a new, independent hub, which materializes to its ownSource
for consuming theSink
of that materialization.If the original
Sink
is failed, then the failure is immediately propagated to all of its materializedSource
s (possibly jumping over already buffered elements). If the originalSink
is completed, then all correspondingSource
s are completed. Both failure and normal completion is "remembered" and later materializations of theSource
will see the same (failure or completion) state.Source
s that are cancelled are simply removed from the dynamic set of consumers.param: bufferSize Buffer size used by the producer. Gives an upper bound on how "far" from each other two concurrent consumers can be in terms of element. If this buffer is full, the producer is backpressured. Must be a power of two and less than 4096.
-
-
Field Summary
Fields Modifier and Type Field Description static BroadcastHub$
MODULE$
Static reference to the singleton instance of this Scala object.
-
Constructor Summary
Constructors Constructor Description BroadcastHub$()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> Sink<T,Source<T,NotUsed>>
sink()
Creates aSink
that receives elements from its upstream producer and broadcasts them to a dynamic set of consumers.<T> Sink<T,Source<T,NotUsed>>
sink(int bufferSize)
-
-
-
Field Detail
-
MODULE$
public static final BroadcastHub$ MODULE$
Static reference to the singleton instance of this Scala object.
-
-
Method Detail
-
sink
public <T> Sink<T,Source<T,NotUsed>> sink()
Creates aSink
that receives elements from its upstream producer and broadcasts them to a dynamic set of consumers. After theSink
returned by this method is materialized, it returns aSource
as materialized value. ThisSource
can be materialized arbitrary many times and each materialization will receive the broadcast elements from the originalSink
.Every new materialization of the
Sink
results in a new, independent hub, which materializes to its ownSource
for consuming theSink
of that materialization.If the original
Sink
is failed, then the failure is immediately propagated to all of its materializedSource
s (possibly jumping over already buffered elements). If the originalSink
is completed, then all correspondingSource
s are completed. Both failure and normal completion is "remembered" and later materializations of theSource
will see the same (failure or completion) state.Source
s that are cancelled are simply removed from the dynamic set of consumers.- Returns:
- (undocumented)
-
-