Packages

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(traversalBuilder: TraversalBuilder, shape: BidiShape[I1, O1, I2, O2])

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. 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
  2. def asJava[JI1 <: I1, JO1 >: O1, JI2 <: I2, JO2 >: O2, JMat >: Mat]: javadsl.BidiFlow[JI1, JO1, JI2, JO2, JMat]
  3. def async(dispatcher: String, inputBufferSize: Int): BidiFlow[I1, O1, I2, O2, Mat]

    Put an asynchronous boundary around this BidiFlow

    Put an asynchronous boundary around this BidiFlow

    dispatcher

    Run the graph on this dispatcher

    inputBufferSize

    Set the input buffer to this size for the graph

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

    Put an asynchronous boundary around this BidiFlow

    Put an asynchronous boundary around this BidiFlow

    dispatcher

    Run the graph on this dispatcher

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

    Put an asynchronous boundary around this BidiFlow

    Put an asynchronous boundary around this BidiFlow

    Definition Classes
    BidiFlow → Graph
  6. def atop[OO1, II2, Mat2](bidi: Graph[BidiShape[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.

  7. def atopMat[OO1, II2, Mat2, M](bidi: Graph[BidiShape[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.

  8. def getAttributes: Attributes
    Definition Classes
    BidiFlow → Graph
  9. def join[Mat2](flow: Graph[FlowShape[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.

  10. def joinMat[Mat2, M](flow: Graph[FlowShape[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.

  11. def mapMaterializedValue[Mat2](f: (Mat) => Mat2): BidiFlow[I1, O1, I2, O2, Mat2]

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

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

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

  14. 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
    BidiFlow → Graph
  15. val traversalBuilder: TraversalBuilder

    INTERNAL API.

    INTERNAL API.

    Every materializable element must be backed by a stream layout module

    Definition Classes
    BidiFlow → Graph
  16. 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