trait DrainingControl[T] extends Control
Combines control and stream completion materialized values, allowing the stream to be stopped in a controlled way without losing checkpoints
The stream completion materialized value will typically be that of a sink (e.g. 'Sink.ignore')
Not for user extension.
- Annotations
- @DoNotInherit()
- Alphabetic
- By Inheritance
- DrainingControl
- Control
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def drainAndShutdown(executor: Executor): CompletionStage[T]
Overload of 'drainAndShutdown' using this DrainingControl's 'streamCompletion'
- abstract def drainAndShutdown[T](streamCompletion: CompletionStage[T], executor: Executor): CompletionStage[T]
Stop producing messages and wait for downstream completion or failure before shutting down the source.
Stop producing messages and wait for downstream completion or failure before shutting down the source. This ensures that all consumed events reach the end of the stream.
- streamCompletion
typically, the materialized value of a sink (e.g. 'Sink.ignore')
- Definition Classes
- Control
- abstract def isShutdown(): CompletionStage[Done]
- Definition Classes
- Control
- abstract def shutdown(): CompletionStage[Done]
Shutdown the consumer source.
Shutdown the consumer source. The actor backing the source will stay alive to handle downstream checkpoints.
- Definition Classes
- Control
- abstract def stop(): CompletionStage[Done]
Stop emitting events and complete the stream.
Stop emitting events and complete the stream. The actor backing the source will stay alive to handle downstream checkpoints.
- Definition Classes
- Control
- abstract def streamCompletion: CompletionStage[T]
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()