akka.stream.alpakka.azure.eventhubs.scaladsl.Consumer
DrainingControl
Companion object DrainingControl
trait DrainingControl[T] extends Control
Combines control and stream completion materialized values, which allows 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()(implicit ec: ExecutionContext): Future[T]
- abstract def isShutdown: Future[Done]
- Definition Classes
- Control
- abstract def shutdown(): Future[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(): Future[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: Future[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()
- def drainAndShutdown[T](streamCompletion: Future[T])(implicit ec: ExecutionContext): Future[T]
Stop producing messages and wait for downstream completion or failure before shutting down the source; to ensure that all consumed events reach the end of the stream.
Stop producing messages and wait for downstream completion or failure before shutting down the source; to ensure that all consumed events reach the end of the stream. 'streamCompletion' will typically be the materialized value of a sink (e.g. 'Sink.ignore').
- Definition Classes
- Control
- 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()