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
- Alphabetic
- By Inheritance
- Balance
- GraphStage
- GraphStageWithMaterializedValue
- Graph
- AnyRef
- Any
- by GraphMapMatVal
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Type Members
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Balance[T], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def async(dispatcher: String, inputBufferSize: Int): Graph[UniformFanOutShape[T, T], NotUsed]
Put an asynchronous boundary around this
GraphPut 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
- def async(dispatcher: String): Graph[UniformFanOutShape[T, T], NotUsed]
Put an asynchronous boundary around this
GraphPut an asynchronous boundary around this
Graph- dispatcher
Run the graph on this dispatcher
- Definition Classes
- Graph
- def async: Graph[UniformFanOutShape[T, T], NotUsed]
Put an asynchronous boundary around this
GraphPut an asynchronous boundary around this
Graph- Definition Classes
- Graph
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def createLogic(inheritedAttributes: Attributes): GraphStageLogic
- Definition Classes
- Balance → GraphStage
- final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)
- Definition Classes
- GraphStage → GraphStageWithMaterializedValue
- val eagerCancel: Boolean
- def ensuring(cond: (Balance[T]) => Boolean, msg: => Any): Balance[T]
- def ensuring(cond: (Balance[T]) => Boolean): Balance[T]
- def ensuring(cond: Boolean, msg: => Any): Balance[T]
- def ensuring(cond: Boolean): Balance[T]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def getAttributes: Attributes
- Definition Classes
- Graph
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val in: Inlet[T]
- def initialAttributes: Attributes
- Definition Classes
- Balance → GraphStageWithMaterializedValue
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val out: IndexedSeq[Outlet[T]]
- val outputPorts: Int
- val shape: UniformFanOutShape[T, T]
The shape of a graph is all that is externally visible: its inlets and outlets.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Balance → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- val waitForAllDownstreams: Boolean
- 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
- GraphStageWithMaterializedValue → Graph
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.