final class BidiFlow[I1, O1, I2, O2, Mat] extends Graph[BidiShape[I1, O1, I2, O2], Mat]

Source
BidiFlow.scala
Linear Supertypes
Graph[BidiShape[I1, O1, I2, O2], Mat], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BidiFlow
  2. Graph
  3. AnyRef
  4. 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 BidiFlow(delegate: scaladsl.BidiFlow[I1, O1, I2, O2, Mat])

Type Members

  1. type Shape = BidiShape[I1, O1, I2, O2]

    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 BidiFlow[I1, O1, I2, O2, Mat] toany2stringadd[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BidiFlow[I1, O1, I2, O2, Mat], B)
    Implicit
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] toArrowAssoc[BidiFlow[I1, O1, I2, O2, Mat]] 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): BidiFlow[I1, O1, I2, O2, Mat]

    Add the given attributes to this Source.

    Add the given attributes to this Source. Further calls to withAttributes will not remove these attributes. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing operators).

    Definition Classes
    BidiFlow → Graph
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asScala: scaladsl.BidiFlow[I1, O1, I2, O2, Mat]
  9. def async(dispatcher: String, inputBufferSize: Int): BidiFlow[I1, O1, I2, O2, Mat]

    Put an asynchronous boundary around this Flow

    Put an asynchronous boundary around this Flow

    dispatcher

    Run the graph on this dispatcher

    inputBufferSize

    Set the input buffer to this size for the graph

    Definition Classes
    BidiFlow → Graph
  10. def async(dispatcher: String): BidiFlow[I1, O1, I2, O2, Mat]

    Put an asynchronous boundary around this Flow

    Put an asynchronous boundary around this Flow

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    BidiFlow → Graph
  11. def async: BidiFlow[I1, O1, I2, O2, Mat]

    Put an asynchronous boundary around this Flow

    Put an asynchronous boundary around this Flow

    Definition Classes
    BidiFlow → Graph
  12. def atop[OO1, II2, Mat2, M](bidi: BidiFlow[O1, OO1, II2, I2, Mat2], combine: Function2[Mat, Mat2, M]): BidiFlow[I1, OO1, II2, O2, M]

    Add the given BidiFlow as the next step in a bidirectional transformation 161

    Add the given BidiFlow as the next step in a bidirectional transformation 161

    pipeline. By convention protocol stacks are growing to the left: the right most is the bottom layer, the closest to the metal.

        +----------------------------+
    | Resulting BidiFlow         |
    |                            |
    |  +------+        +------+  |
I1 ~~> |      |  ~O1~> |      | ~~> OO1
    |  | this |        | bidi |  |
O2 <~~ |      | <~I2~  |      | <~~ II2
    |  +------+        +------+  |
    +----------------------------+

    The combine function is used to compose the materialized values of this flow and that flow into the materialized value of the resulting BidiFlow.

  13. def atop[OO1, II2, Mat2](bidi: BidiFlow[O1, OO1, II2, I2, Mat2]): BidiFlow[I1, OO1, II2, O2, Mat]

    Add the given BidiFlow as the next step in a bidirectional transformation pipeline.

    Add the given BidiFlow as the next step in a bidirectional transformation pipeline. By convention protocol stacks are growing to the left: the right most is the bottom layer, the closest to the metal.

        +----------------------------+
    | Resulting BidiFlow         |
    |                            |
    |  +------+        +------+  |
I1 ~~> |      |  ~O1~> |      | ~~> OO1
    |  | this |        | bidi |  |
O2 <~~ |      | <~I2~  |      | <~~ II2
    |  +------+        +------+  |
    +----------------------------+

    The materialized value of the combined BidiFlow will be the materialized value of the current flow (ignoring the other BidiFlow’s value), use atopMat if a different strategy is needed.

  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  15. def ensuring(cond: (BidiFlow[I1, O1, I2, O2, Mat]) => Boolean, msg: => Any): BidiFlow[I1, O1, I2, O2, Mat]
    Implicit
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] toEnsuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (BidiFlow[I1, O1, I2, O2, Mat]) => Boolean): BidiFlow[I1, O1, I2, O2, Mat]
    Implicit
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] toEnsuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): BidiFlow[I1, O1, I2, O2, Mat]
    Implicit
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] toEnsuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): BidiFlow[I1, O1, I2, O2, Mat]
    Implicit
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] toEnsuring[BidiFlow[I1, O1, I2, O2, Mat]] 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
    BidiFlow → 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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def join[Mat2, M](flow: Flow[O1, I2, Mat2], combine: Function2[Mat, Mat2, M]): Flow[I1, O2, M]

    Add the given Flow as the final step in a bidirectional transformation pipeline.

    Add the given Flow as the final step in a bidirectional transformation pipeline. By convention protocol stacks are growing to the left: the right most is the bottom layer, the closest to the metal.

        +---------------------------+
    | Resulting Flow            |
    |                           |
    |  +------+        +------+ |
I1 ~~> |      |  ~O1~> |      | |
    |  | this |        | flow | |
O2 <~~ |      | <~I2~  |      | |
    |  +------+        +------+ |
    +---------------------------+

    The combine function is used to compose the materialized values of this flow and that flow into the materialized value of the resulting Flow.

  26. def join[Mat2](flow: Flow[O1, I2, Mat2]): Flow[I1, O2, Mat]

    Add the given Flow as the final step in a bidirectional transformation pipeline.

    Add the given Flow as the final step in a bidirectional transformation pipeline. By convention protocol stacks are growing to the left: the right most is the bottom layer, the closest to the metal.

        +---------------------------+
    | Resulting Flow            |
    |                           |
    |  +------+        +------+ |
I1 ~~> |      |  ~O1~> |      | |
    |  | this |        | flow | |
O2 <~~ |      | <~I2~  |      | |
    |  +------+        +------+ |
    +---------------------------+

    The materialized value of the combined Flow will be the materialized value of the current flow (ignoring the other Flow’s value), use joinMat if a different strategy is needed.

  27. def mapMaterializedValue[Mat2](f: Function[Mat, Mat2]): BidiFlow[I1, O1, I2, O2, Mat2]

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

  28. def named(name: String): BidiFlow[I1, O1, I2, O2, Mat]

    Add a name attribute to this Flow.

    Add a name attribute to this Flow.

    Definition Classes
    BidiFlow → 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. def reversed: BidiFlow[I2, O2, I1, O1, Mat]

    Turn this BidiFlow around by 180 degrees, logically flipping it upside down in a protocol stack.

  33. def shape: BidiShape[I1, O1, I2, O2]

    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
    BidiFlow → Graph
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. def traversalBuilder: TraversalBuilder

    INTERNAL API.

    INTERNAL API.

    Every materializable element must be backed by a stream layout module

    Definition Classes
    BidiFlow → Graph
  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. def withAttributes(attr: Attributes): BidiFlow[I1, O1, I2, O2, Mat]

    Change the attributes of this Source to the given ones and seal the list of attributes.

    Change the attributes of this Source to the given ones and seal the list of attributes. This means that further calls will not be able to remove these attributes, but instead add new ones. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing operators).

    Definition Classes
    BidiFlow → Graph

Shadowed Implicit Value Members

  1. def mapMaterializedValue[M2](f: (Mat) => M2): Graph[BidiShape[I1, O1, I2, O2], 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 BidiFlow[I1, O1, I2, O2, Mat] toGraphMapMatVal[BidiShape[I1, O1, I2, O2], Mat] performed by method GraphMapMatVal in akka.stream.Graph.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (bidiFlow: GraphMapMatVal[BidiShape[I1, O1, I2, O2], Mat]).mapMaterializedValue(f)
    Definition Classes
    GraphMapMatVal

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 BidiFlow[I1, O1, I2, O2, Mat] toStringFormat[BidiFlow[I1, O1, I2, O2, Mat]] 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): (BidiFlow[I1, O1, I2, O2, Mat], B)
    Implicit
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] toArrowAssoc[BidiFlow[I1, O1, I2, O2, Mat]] 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 Graph[BidiShape[I1, O1, I2, O2], Mat]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion GraphMapMatVal fromBidiFlow[I1, O1, I2, O2, Mat] to GraphMapMatVal[BidiShape[I1, O1, I2, O2], Mat]

Inherited by implicit conversion any2stringadd fromBidiFlow[I1, O1, I2, O2, Mat] to any2stringadd[BidiFlow[I1, O1, I2, O2, Mat]]

Inherited by implicit conversion StringFormat fromBidiFlow[I1, O1, I2, O2, Mat] to StringFormat[BidiFlow[I1, O1, I2, O2, Mat]]

Inherited by implicit conversion Ensuring fromBidiFlow[I1, O1, I2, O2, Mat] to Ensuring[BidiFlow[I1, O1, I2, O2, Mat]]

Inherited by implicit conversion ArrowAssoc fromBidiFlow[I1, O1, I2, O2, Mat] to ArrowAssoc[BidiFlow[I1, O1, I2, O2, Mat]]

Ungrouped