Class 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 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)
      • apply$default$2

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

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

        public static Graph<S,​M> async()
      • async

        public static Graph<S,​M> async​(java.lang.String dispatcher)
      • async

        public static Graph<S,​M> async​(java.lang.String dispatcher,
                                             int inputBufferSize)
      • addAttributes

        public static Graph<S,​M> addAttributes​(Attributes attr)
      • 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()
      • out

        public scala.collection.immutable.IndexedSeq<Outlet<T>> out()
      • 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)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object