Class/Object

org.squbs.streams

Timeout

Related Docs: object Timeout | package streams

Permalink

final class Timeout[In, Out, Context] extends GraphStage[BidiShape[(In, Context), (In, Context), (Out, Context), (Try[Out], Context)]] with LazyLogging

A bidi GraphStage that is joined with flows to add timeout functionality. This bidi stage is used with flows that do not guarantee the message ordering. So, it requires a context to be carried along with the elements to uniquely identify each element.

Emits when an element is available from the joined Flow or an element has already timed out

Backpressures when the downstream backpressures

Completes when upstream completes

Cancels when downstream cancels

                       +------+
      (In, Context) ~> |      | ~> (In, Context)
                       | bidi |
(Try[Out], Context) <~ |      | <~ (Out, Context)
                       +------+
In

the type of the elements pulled from the upstream along with the Context

Out

the type of the elements that are pushed by the joined Flow along with the Context. This then gets wrapped with a Try and pushed downstream with a Context

Context

the type of the context that is carried around along with the elements.

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

Instance Constructors

  1. new Timeout(settings: TimeoutSettings[In, Out, Context])

    Permalink

    settings

    @see TimeoutSettings

Type Members

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

    Permalink
    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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def addAttributes(attr: Attributes): Graph[BidiShape[(In, Context), (In, Context), (Out, Context), (Try[Out], Context)], 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, Context), (In, Context), (Out, Context), (Try[Out], Context)], NotUsed]

    Permalink
    Definition Classes
    Graph

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

    Permalink
    Definition Classes
    Graph

  8. def async: Graph[BidiShape[(In, Context), (In, Context), (Out, Context), (Try[Out], Context)], 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
    Timeout → 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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  17. def initialAttributes: Attributes

    Permalink
    Definition Classes
    Timeout → GraphStageWithMaterializedValue

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging

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

    Permalink
    Definition Classes
    Graph

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

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. val shape: BidiShape[(In, Context), (In, Context), (Out, Context), (Try[Out], Context)]

    Permalink
    Definition Classes
    Timeout → Graph

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

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    Timeout → AnyRef → Any

  27. val uniqueId: (Context) ⇒ Any

    Permalink

  28. final def wait(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    GraphStageWithMaterializedValue → Graph

Inherited from LazyLogging

Inherited from GraphStage[BidiShape[(In, Context), (In, Context), (Out, Context), (Try[Out], Context)]]

Inherited from GraphStageWithMaterializedValue[BidiShape[(In, Context), (In, Context), (Out, Context), (Try[Out], Context)], NotUsed]

Inherited from Graph[BidiShape[(In, Context), (In, Context), (Out, Context), (Try[Out], Context)], NotUsed]

Inherited from AnyRef

Inherited from Any

Ungrouped