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

    (Since version Akka 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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Balance[T] toany2stringadd[Balance[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Balance[T], B)
    Implicit
    This member is added by an implicit conversion from Balance[T] toArrowAssoc[Balance[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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
  9. 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
  10. def async: Graph[UniformFanOutShape[T, T], NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. def createLogic(inheritedAttributes: Attributes): GraphStageLogic
    Definition Classes
    BalanceGraphStage
  13. final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)
  14. val eagerCancel: Boolean
  15. def ensuring(cond: (Balance[T]) => Boolean, msg: => Any): Balance[T]
    Implicit
    This member is added by an implicit conversion from Balance[T] toEnsuring[Balance[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (Balance[T]) => Boolean): Balance[T]
    Implicit
    This member is added by an implicit conversion from Balance[T] toEnsuring[Balance[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): Balance[T]
    Implicit
    This member is added by an implicit conversion from Balance[T] toEnsuring[Balance[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): Balance[T]
    Implicit
    This member is added by an implicit conversion from Balance[T] toEnsuring[Balance[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. def getAttributes: Attributes
    Definition Classes
    Graph
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. val in: Inlet[T]
  25. def initialAttributes: Attributes
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. 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 org.apache.pekko.stream.Graph.
    Definition Classes
    GraphMapMatVal
  28. 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
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. val out: IndexedSeq[Outlet[T]]
  33. val outputPorts: Int
  34. 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
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    Balance → AnyRef → Any
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. val waitForAllDownstreams: Boolean
  41. 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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Balance[T] toStringFormat[Balance[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (Balance[T], B)
    Implicit
    This member is added by an implicit conversion from Balance[T] toArrowAssoc[Balance[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from GraphStage[UniformFanOutShape[T, T]]

Inherited from Graph[UniformFanOutShape[T, T], NotUsed]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion GraphMapMatVal fromBalance[T] to GraphMapMatVal[UniformFanOutShape[T, T], NotUsed]

Inherited by implicit conversion any2stringadd fromBalance[T] to any2stringadd[Balance[T]]

Inherited by implicit conversion StringFormat fromBalance[T] to StringFormat[Balance[T]]

Inherited by implicit conversion Ensuring fromBalance[T] to Ensuring[Balance[T]]

Inherited by implicit conversion ArrowAssoc fromBalance[T] to ArrowAssoc[Balance[T]]

Ungrouped