Class/Object

akka.stream.contrib

Valve

Related Docs: object Valve | package contrib

Permalink

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

Materializes into a 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], ValveSwitch], Graph[FlowShape[A, A], 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)

    Permalink

    mode

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

Type Members

  1. type Shape = FlowShape[A, A]

    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[FlowShape[A, A], ValveSwitch]

    Permalink
    Definition Classes
    Graph
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def async: Graph[FlowShape[A, A], ValveSwitch]

    Permalink
    Definition Classes
    Graph
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, ValveSwitch)

    Permalink
    Definition Classes
    Valve → GraphStageWithMaterializedValue
  9. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. val in: Inlet[A]

    Permalink
  15. def initialAttributes: Attributes

    Permalink
    Attributes
    protected
    Definition Classes
    GraphStageWithMaterializedValue
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. final lazy val module: Module

    Permalink
    Definition Classes
    GraphStageWithMaterializedValue → Graph
  18. def named(name: String): Graph[FlowShape[A, A], ValveSwitch]

    Permalink
    Definition Classes
    Graph
  19. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. val out: Outlet[A]

    Permalink
  23. val shape: FlowShape[A, A]

    Permalink
    Definition Classes
    Valve → Graph
  24. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def withAttributes(attr: Attributes): Graph[FlowShape[A, A], ValveSwitch]

    Permalink
    Definition Classes
    GraphStageWithMaterializedValue → Graph

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped