Class/Object

akka.stream.scaladsl

BidiFlow

Related Docs: object BidiFlow | package scaladsl

Permalink

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

    Permalink

Type Members

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

    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 BidiFlow[I1, O1, I2, O2, Mat] to any2stringadd[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)

    Permalink
    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 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): BidiFlow[I1, O1, I2, O2, Mat]

    Permalink

    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 stages).

    Definition Classes
    BidiFlowGraph
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def asJava: javadsl.BidiFlow[I1, O1, I2, O2, Mat]

    Permalink
  9. def async: BidiFlow[I1, O1, I2, O2, Mat]

    Permalink

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    BidiFlowGraph
  10. def atop[OO1, II2, Mat2](bidi: Graph[BidiShape[O1, OO1, II2, I2], Mat2]): BidiFlow[I1, OO1, II2, O2, Mat]

    Permalink

    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.

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

    Permalink

    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.

  12. def clone(): AnyRef

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

    Permalink
    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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (BidiFlow[I1, O1, I2, O2, Mat]) ⇒ Boolean): BidiFlow[I1, O1, I2, O2, Mat]

    Permalink
    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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): BidiFlow[I1, O1, I2, O2, Mat]

    Permalink
    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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): BidiFlow[I1, O1, I2, O2, Mat]

    Permalink
    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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def join[Mat2](flow: Graph[FlowShape[O1, I2], Mat2]): Flow[I1, O2, Mat]

    Permalink

    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: Graph[FlowShape[O1, I2], Mat2])(combine: (Mat, Mat2) ⇒ M): Flow[I1, O2, M]

    Permalink

    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 mapMaterializedValue[Mat2](f: (Mat) ⇒ Mat2): BidiFlow[I1, O1, I2, O2, Mat2]

    Permalink

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

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

    Permalink

    Add a name attribute to this Flow.

    Add a name attribute to this Flow.

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

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  30. def reversed: BidiFlow[I2, O2, I1, O1, Mat]

    Permalink

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

  31. val shape: BidiShape[I1, O1, I2, O2]

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

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  34. val traversalBuilder: TraversalBuilder

    Permalink

    INTERNAL API.

    INTERNAL API.

    Every materializable element must be backed by a stream layout module

    Definition Classes
    BidiFlowGraph
  35. final def wait(): Unit

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

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

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

    Permalink

    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 stages).

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

    Permalink
    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 ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

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 any2stringadd[BidiFlow[I1, O1, I2, O2, Mat]]

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

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

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

Ungrouped