Class/Object

akka.stream.scaladsl

Balance

Related Docs: object Balance | package scaladsl

Permalink

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
Linear Supertypes
GraphStage[UniformFanOutShape[T, T]], GraphStageWithMaterializedValue[UniformFanOutShape[T, T], NotUsed], Graph[UniformFanOutShape[T, T], NotUsed], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Balance
  2. GraphStage
  3. GraphStageWithMaterializedValue
  4. Graph
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Balance(outputPorts: Int, waitForAllDownstreams: Boolean, eagerCancel: Boolean)

    Permalink

  2. new Balance(outputPorts: Int, waitForAllDownstreams: Boolean)

    Permalink
    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]

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    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

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

    Permalink
    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()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink

    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

    Permalink
    Definition Classes
    Any

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

    Permalink

    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]

    Permalink

    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]

    Permalink

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def createLogic(inheritedAttributes: Attributes): GraphStageLogic

    Permalink
    Definition Classes
    Balance → GraphStage

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

    Permalink
    Definition Classes
    GraphStage → GraphStageWithMaterializedValue

  14. val eagerCancel: Boolean

    Permalink

  15. def ensuring(cond: (Balance[T]) ⇒ Boolean, msg: ⇒ Any): Balance[T]

    Permalink
    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

  16. def ensuring(cond: (Balance[T]) ⇒ Boolean): Balance[T]

    Permalink
    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

  17. def ensuring(cond: Boolean, msg: ⇒ Any): Balance[T]

    Permalink
    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

  18. def ensuring(cond: Boolean): Balance[T]

    Permalink
    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

  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  22. def formatted(fmtstr: String): String

    Permalink
    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()

  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  25. val in: Inlet[T]

    Permalink

  26. def initialAttributes: Attributes

    Permalink
    Definition Classes
    Balance → GraphStageWithMaterializedValue

  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Graph

  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  32. val out: IndexedSeq[Outlet[T]]

    Permalink

  33. val outputPorts: Int

    Permalink

  34. val shape: UniformFanOutShape[T, T]

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef

  36. def toString(): String

    Permalink
    Definition Classes
    Balance → AnyRef → Any

  37. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. val waitForAllDownstreams: Boolean

    Permalink

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

    Permalink
    Definition Classes
    GraphStageWithMaterializedValue → Graph

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

    Permalink
    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

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