akka.stream.scaladsl

BidiFlow

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 Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BidiFlow
  2. Graph
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BidiFlow(module: Module)

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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (BidiFlow[I1, O1, I2, O2, Mat], B)

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to ArrowAssoc[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. 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.

  10. def atopMat[OO1, II2, Mat2, M](bidi: BidiFlow[O1, OO1, II2, I2, Mat2])(combine: (Mat, Mat2) ⇒ M): BidiFlow[I1, OO1, II2, O2, M]

    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 combine function is used to compose the materialized values of this flow and that flow into the materialized value of the resulting BidiFlow.

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def ensuring(cond: (BidiFlow[I1, O1, I2, O2, Mat]) ⇒ Boolean, msg: ⇒ Any): BidiFlow[I1, O1, I2, O2, Mat]

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to Ensuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (BidiFlow[I1, O1, I2, O2, Mat]) ⇒ Boolean): BidiFlow[I1, O1, I2, O2, Mat]

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to Ensuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): BidiFlow[I1, O1, I2, O2, Mat]

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to Ensuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): BidiFlow[I1, O1, I2, O2, Mat]

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to Ensuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. 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.

  24. def joinMat[Mat2, M](flow: Flow[O1, I2, Mat2])(combine: (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.

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

    Definition Classes
    BidiFlowGraph
  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. def reversed: BidiFlow[I2, O2, I1, O1, Mat]

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

  30. val 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
    BidiFlowGraph
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def withAttributes(attr: Attributes): BidiFlow[I1, O1, I2, O2, Mat]

    Definition Classes
    BidiFlowGraph
  37. def [B](y: B): (BidiFlow[I1, O1, I2, O2, Mat], B)

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to ArrowAssoc[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bidiFlow: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bidiFlow: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: BidiFlow[I1, O1, I2, O2, Mat]

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to ArrowAssoc[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bidiFlow: ArrowAssoc[BidiFlow[I1, O1, I2, O2, Mat]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: BidiFlow[I1, O1, I2, O2, Mat]

    Implicit information
    This member is added by an implicit conversion from BidiFlow[I1, O1, I2, O2, Mat] to Ensuring[BidiFlow[I1, O1, I2, O2, Mat]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bidiFlow: Ensuring[BidiFlow[I1, O1, I2, O2, Mat]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Graph[BidiShape[I1, O1, I2, O2], Mat]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped