Balance

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 all downstreams cancel

Source: Graph.scala

Linear Supertypes

GraphStage[UniformFanOutShape[T, T]], GraphStageWithMaterializedValue[UniformFanOutShape[T, T], NotUsed], Graph[UniformFanOutShape[T, T], NotUsed], AnyRef, Any

Type Hierarchy

Instance Constructors

new Balance(outputPorts: Int, waitForAllDownstreams: Boolean)

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

Implicit information
This member is added by an implicit conversion from Balance[T] to any2stringadd[Balance[T]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Balance[T], B)

Implicit information
This member is added by an implicit conversion from Balance[T] to ArrowAssoc[Balance[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addAttributes(attr: Attributes): Graph[UniformFanOutShape[T, T], NotUsed]

Definition Classes
Graph
final def asInstanceOf[T0]: T0

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

Put an asynchronous boundary around this Graph
Put an asynchronous boundary around this Graph

Definition Classes
Graph
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def createLogic(inheritedAttributes: Attributes): GraphStageLogic

Definition Classes
Balance → GraphStage
final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)

Definition Classes
GraphStage → GraphStageWithMaterializedValue
def ensuring(cond: (Balance[T]) ⇒ Boolean, msg: ⇒ Any): Balance[T]

Implicit information
This member is added by an implicit conversion from Balance[T] to Ensuring[Balance[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Balance[T]) ⇒ Boolean): Balance[T]

Implicit information
This member is added by an implicit conversion from Balance[T] to Ensuring[Balance[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Balance[T]

Implicit information
This member is added by an implicit conversion from Balance[T] to Ensuring[Balance[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Balance[T]

Implicit information
This member is added by an implicit conversion from Balance[T] to Ensuring[Balance[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Balance[T] to StringFormat[Balance[T]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
val in: Inlet[T]
def initialAttributes: Attributes

Definition Classes
Balance → GraphStageWithMaterializedValue
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def named(name: String): Graph[UniformFanOutShape[T, T], NotUsed]

Definition Classes
Graph
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
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.
The shape of a graph is all that is externally visible: its inlets and outlets.

Definition Classes
Balance → Graph
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Balance → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val waitForAllDownstreams: Boolean
final def withAttributes(attr: Attributes): Graph[UniformFanOutShape[T, T], NotUsed]

Definition Classes
GraphStageWithMaterializedValue → Graph
def →[B](y: B): (Balance[T], B)

Implicit information
This member is added by an implicit conversion from Balance[T] to ArrowAssoc[Balance[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object Balance | package scaladsl

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

Instance Constructors

new Balance(outputPorts: Int, waitForAllDownstreams: Boolean)

Type Members

type Shape = UniformFanOutShape[T, T]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Balance[T], B)

final def ==(arg0: Any): Boolean

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

final def asInstanceOf[T0]: T0

def async: Graph[UniformFanOutShape[T, T], NotUsed]

def clone(): AnyRef

def createLogic(inheritedAttributes: Attributes): GraphStageLogic

final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)

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

def equals(arg0: Any): Boolean

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

val in: Inlet[T]

def initialAttributes: Attributes

final def isInstanceOf[T0]: Boolean

def named(name: String): Graph[UniformFanOutShape[T, T], NotUsed]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val out: IndexedSeq[Outlet[T]]

val outputPorts: Int

val shape: UniformFanOutShape[T, T]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val waitForAllDownstreams: Boolean

final def withAttributes(attr: Attributes): Graph[UniformFanOutShape[T, T], NotUsed]

def →[B](y: B): (Balance[T], B)

Deprecated Value Members

def finalize(): Unit

Inherited from GraphStage[UniformFanOutShape[T, T]]

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

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped