object BidiFlow

Source
BidiFlow.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BidiFlow
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def bidirectionalIdleTimeout[I, O](timeout: Duration): BidiFlow[I, I, O, O, NotUsed]

    If the time between two processed elements *in any direction* exceed the provided timeout, the stream is failed with a org.apache.pekko.stream.BackpressureTimeoutException.

    If the time between two processed elements *in any direction* exceed the provided timeout, the stream is failed with a org.apache.pekko.stream.BackpressureTimeoutException.

    There is a difference between this operator and having two idleTimeout Flows assembled into a BidiStage. If the timeout is configured to be 1 seconds, then this operator will not fail even though there are elements flowing every second in one direction, but no elements are flowing in the other direction. I.e. this operator considers the *joint* frequencies of the elements in both directions.

    Annotations
    @nowarn()
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def fromFlows[I1, O1, I2, O2, M1, M2](flow1: Graph[FlowShape[I1, O1], M1], flow2: Graph[FlowShape[I2, O2], M2]): BidiFlow[I1, O1, I2, O2, NotUsed]

    Wraps two Flows to create a BidiFlow.

    Wraps two Flows to create a BidiFlow. The materialized value of the resulting BidiFlow is NotUsed.

        +----------------------------+
        | Resulting BidiFlow         |
        |                            |
        |  +----------------------+  |
    I1 ~~> |        Flow1         | ~~> O1
        |  +----------------------+  |
        |                            |
        |  +----------------------+  |
    O2 <~~ |        Flow2         | <~~ I2
        |  +----------------------+  |
        +----------------------------+
  10. def fromFlowsMat[I1, O1, I2, O2, M1, M2, M](flow1: Graph[FlowShape[I1, O1], M1], flow2: Graph[FlowShape[I2, O2], M2], combine: Function2[M1, M2, M]): BidiFlow[I1, O1, I2, O2, M]

    Wraps two Flows to create a BidiFlow.

    Wraps two Flows to create a BidiFlow. The materialized value of the resulting BidiFlow is determined by the combiner function passed in the second argument list.

        +----------------------------+
        | Resulting BidiFlow         |
        |                            |
        |  +----------------------+  |
    I1 ~~> |        Flow1         | ~~> O1
        |  +----------------------+  |
        |                            |
        |  +----------------------+  |
    O2 <~~ |        Flow2         | <~~ I2
        |  +----------------------+  |
        +----------------------------+
  11. def fromFunctions[I1, O1, I2, O2](top: Function[I1, O1], bottom: Function[I2, O2]): BidiFlow[I1, O1, I2, O2, NotUsed]

    Create a BidiFlow where the top and bottom flows are just one simple mapping operator each, expressed by the two functions.

  12. def fromGraph[I1, O1, I2, O2, M](g: Graph[BidiShape[I1, O1, I2, O2], M]): BidiFlow[I1, O1, I2, O2, M]

    A graph with the shape of a BidiFlow logically is a BidiFlow, this method makes it so also in type.

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def identity[A, B]: BidiFlow[A, A, B, B, NotUsed]
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def bidirectionalIdleTimeout[I, O](timeout: FiniteDuration): BidiFlow[I, I, O, O, NotUsed]

    If the time between two processed elements *in any direction* exceed the provided timeout, the stream is failed with a org.apache.pekko.stream.BackpressureTimeoutException.

    If the time between two processed elements *in any direction* exceed the provided timeout, the stream is failed with a org.apache.pekko.stream.BackpressureTimeoutException.

    There is a difference between this operator and having two idleTimeout Flows assembled into a BidiStage. If the timeout is configured to be 1 seconds, then this operator will not fail even though there are elements flowing every second in one direction, but no elements are flowing in the other direction. I.e. this operator considers the *joint* frequencies of the elements in both directions.

    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.5.12) Use the overloaded one which accepts java.time.Duration instead.

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped