final class Valve[A] extends GraphStageWithMaterializedValue[FlowShape[A, A], Future[ValveSwitch]]

Materializes into a Future of ValveSwitch which provides a the method flip that stops or restarts the flow of elements passing through the stage. As long as the valve is closed it will backpressure.

Note that closing the valve could result in one element being buffered inside the stage, and if the stream completes or fails while being closed, that element may be lost.

Linear Supertypes
GraphStageWithMaterializedValue[FlowShape[A, A], Future[ValveSwitch]], Graph[FlowShape[A, A], Future[ValveSwitch]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Valve
  2. GraphStageWithMaterializedValue
  3. Graph
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Valve(mode: SwitchMode)

    mode

    state of the valve at the startup of the flow (by default Open)

Type Members

  1. type Shape = FlowShape[A, A]
    Definition Classes
    Graph

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. def addAttributes(attr: Attributes): Graph[FlowShape[A, A], Future[ValveSwitch]]
    Definition Classes
    Graph
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def async(dispatcher: String, inputBufferSize: Int): Graph[FlowShape[A, A], Future[ValveSwitch]]
    Definition Classes
    Graph
  7. def async(dispatcher: String): Graph[FlowShape[A, A], Future[ValveSwitch]]
    Definition Classes
    Graph
  8. def async: Graph[FlowShape[A, A], Future[ValveSwitch]]
    Definition Classes
    Graph
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, Future[ValveSwitch])
    Definition Classes
    Valve → GraphStageWithMaterializedValue
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. val in: Inlet[A]
  17. def initialAttributes: Attributes
    Attributes
    protected
    Definition Classes
    GraphStageWithMaterializedValue
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def named(name: String): Graph[FlowShape[A, A], Future[ValveSwitch]]
    Definition Classes
    Graph
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. val out: Outlet[A]
  24. val shape: FlowShape[A, A]
    Definition Classes
    Valve → Graph
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  30. final def withAttributes(attr: Attributes): Graph[FlowShape[A, A], Future[ValveSwitch]]
    Definition Classes
    GraphStageWithMaterializedValue → Graph

Inherited from GraphStageWithMaterializedValue[FlowShape[A, A], Future[ValveSwitch]]

Inherited from Graph[FlowShape[A, A], Future[ValveSwitch]]

Inherited from AnyRef

Inherited from Any

Ungrouped