Class/Object

org.squbs.streams

TimeoutOrdered

Related Docs: object TimeoutOrdered | package streams

Permalink

final class TimeoutOrdered[In, Out] extends GraphStage[BidiShape[In, In, Out, Try[Out]]]

A bidi GraphStage that is joined with flows to add timeout functionality. This bidi stage is used with flows that guarantee the message ordering.

Emits when an element is available from the wrapped flow or an element has already timed out

Backpressures when the downstream backpressures

Completes when upstream completes

Cancels when downstream cancels

            +------+
      In ~> |      | ~> In
            | bidi |
Try[Out] <~ |      | <~ Out
            +------+
In

the type of the elements pulled from the upstream and pushed down to joined flow

Out

the type of the elements that are pushed to downstream

Linear Supertypes
GraphStage[BidiShape[In, In, Out, Try[Out]]], GraphStageWithMaterializedValue[BidiShape[In, In, Out, Try[Out]], NotUsed], Graph[BidiShape[In, In, Out, Try[Out]], NotUsed], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimeoutOrdered
  2. GraphStage
  3. GraphStageWithMaterializedValue
  4. Graph
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TimeoutOrdered(timeout: FiniteDuration, cleanUp: (Out) ⇒ Unit)

    Permalink

    timeout

    the duration after which the processing of an element would be considered timed out.

    cleanUp

    an optional clean up function to be applied on timed out elements when pushed

Type Members

  1. type Shape = BidiShape[In, In, Out, Try[Out]]

    Permalink
    Definition Classes
    Graph

  2. case class TimeoutTracker(startTime: Long, isTimedOut: Boolean) extends Product with Serializable

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def addAttributes(attr: Attributes): Graph[BidiShape[In, In, Out, Try[Out]], NotUsed]

    Permalink
    Definition Classes
    Graph

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def async(dispatcher: String, inputBufferSize: Int): Graph[BidiShape[In, In, Out, Try[Out]], NotUsed]

    Permalink
    Definition Classes
    Graph

  7. def async(dispatcher: String): Graph[BidiShape[In, In, Out, Try[Out]], NotUsed]

    Permalink
    Definition Classes
    Graph

  8. def async: Graph[BidiShape[In, In, Out, Try[Out]], NotUsed]

    Permalink
    Definition Classes
    Graph

  9. def clone(): AnyRef

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

  10. def createLogic(inheritedAttributes: Attributes): GraphStageLogic

    Permalink
    Definition Classes
    TimeoutOrdered → GraphStage

  11. final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)

    Permalink
    Definition Classes
    GraphStage → GraphStageWithMaterializedValue

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

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

  15. val fromWrapped: Inlet[Out]

    Permalink

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. val in: Inlet[In]

    Permalink

  19. def initialAttributes: Attributes

    Permalink
    Definition Classes
    TimeoutOrdered → GraphStageWithMaterializedValue

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  21. def named(name: String): Graph[BidiShape[In, In, Out, Try[Out]], NotUsed]

    Permalink
    Definition Classes
    Graph

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. val out: Outlet[Try[Out]]

    Permalink

  26. val shape: BidiShape[In, In, Out, Try[Out]]

    Permalink
    Definition Classes
    TimeoutOrdered → Graph

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  28. def toString(): String

    Permalink
    Definition Classes
    TimeoutOrdered → AnyRef → Any

  29. val toWrapped: Outlet[In]

    Permalink

  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def withAttributes(attr: Attributes): Graph[BidiShape[In, In, Out, Try[Out]], NotUsed]

    Permalink
    Definition Classes
    GraphStageWithMaterializedValue → Graph

Inherited from GraphStage[BidiShape[In, In, Out, Try[Out]]]

Inherited from GraphStageWithMaterializedValue[BidiShape[In, In, Out, Try[Out]], NotUsed]

Inherited from Graph[BidiShape[In, In, Out, Try[Out]], NotUsed]

Inherited from AnyRef

Inherited from Any

Ungrouped