Packages

final class Balance[T] extends GraphStage[UniformFanOutShape[T, T]]

Fan-out the stream to several streams. Each upstream element is emitted to the first available downstream consumer. It will not shut down until the subscriptions for at least two downstream subscribers have been established.

A Balance has one in port and 2 or more out ports.

Emits when any of the outputs stops backpressuring; emits the element to the first available output

Backpressures when all of the outputs backpressure

Completes when upstream completes

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

Source
Graph.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Balance
  2. GraphStage
  3. GraphStageWithMaterializedValue
  4. Graph
  5. AnyRef
  6. Any
Implicitly
  1. by GraphMapMatVal
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Balance(outputPorts: Int, waitForAllDownstreams: Boolean, eagerCancel: Boolean)
  2. new Balance(outputPorts: Int, waitForAllDownstreams: Boolean)
    Annotations
    @Deprecated @deprecated
    Deprecated

    (Since version 2.5.12) Use the constructor which also specifies the eagerCancel parameter

Type Members

  1. type Shape = UniformFanOutShape[T, T]

    Type-level accessor for the shape parameter of this graph.

    Type-level accessor for the shape parameter of this graph.

    Definition Classes
    Graph

Value Members

  1. def addAttributes(attr: Attributes): Graph[UniformFanOutShape[T, T], NotUsed]

    Add the given attributes to this Graph.

    Add the given attributes to this Graph. If the specific attribute was already present on this graph this means the added attribute will be more specific than the existing one. If this Source is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

    Definition Classes
    Graph
  2. def async(dispatcher: String, inputBufferSize: Int): Graph[UniformFanOutShape[T, T], NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    inputBufferSize

    Set the input buffer to this size for the graph

    Definition Classes
    Graph
  3. def async(dispatcher: String): Graph[UniformFanOutShape[T, T], NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    Graph
  4. def async: Graph[UniformFanOutShape[T, T], NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph
  5. def createLogic(inheritedAttributes: Attributes): GraphStageLogic
    Definition Classes
    BalanceGraphStage
  6. final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)
  7. val eagerCancel: Boolean
  8. def getAttributes: Attributes
    Definition Classes
    Graph
  9. val in: Inlet[T]
  10. def initialAttributes: Attributes
  11. def mapMaterializedValue[M2](f: (NotUsed) => M2): Graph[UniformFanOutShape[T, T], M2]

    Transform the materialized value of this Graph, leaving all other properties as they were.

    Transform the materialized value of this Graph, leaving all other properties as they were.

    f

    function to map the graph's materialized value

    Implicit
    This member is added by an implicit conversion from Balance[T] toGraphMapMatVal[UniformFanOutShape[T, T], NotUsed] performed by method GraphMapMatVal in akka.stream.Graph.
    Definition Classes
    GraphMapMatVal
  12. def named(name: String): Graph[UniformFanOutShape[T, T], NotUsed]

    Specifies the name of the Graph.

    Specifies the name of the Graph. If the name is null or empty the name is ignored, i.e. #none is returned.

    Definition Classes
    Graph
  13. val out: IndexedSeq[Outlet[T]]
  14. val outputPorts: Int
  15. val shape: UniformFanOutShape[T, T]

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

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

    Definition Classes
    BalanceGraph
  16. def toString(): String
    Definition Classes
    Balance → AnyRef → Any
  17. val waitForAllDownstreams: Boolean
  18. final def withAttributes(attr: Attributes): Graph[UniformFanOutShape[T, T], NotUsed]

    Replace the attributes of this Flow with the given ones.

    Replace the attributes of this Flow with the given ones. If this Flow is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

    Definition Classes
    GraphStageWithMaterializedValueGraph