final class DrainingControl[T] extends Control
Combine control and a stream completion signal materialized values into one, so that the stream can be stopped in a controlled way without losing commits.
- Source
- Consumer.scala
- Alphabetic
- By Inheritance
- DrainingControl
- Control
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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(ec: Executor): CompletionStage[T]
Stop producing messages from the
Source, wait for stream completion and shut down the consumerSource.Stop producing messages from the
Source, wait for stream completion and shut down the consumerSource. It will wait for outstanding offset commit requests to finish before shutting down. - def drainAndShutdown[S](streamCompletion: CompletionStage[S], ec: Executor): CompletionStage[S]
Stop producing messages from the
Source, wait for stream completion and shut down the consumerSourceso that all consumed messages reach the end of the stream.Stop producing messages from the
Source, wait for stream completion and shut down the consumerSourceso that all consumed messages reach the end of the stream. Failures in stream completion will be propagated, the source will be shut down anyway.- Definition Classes
- DrainingControl → 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 getMetrics: CompletionStage[Map[MetricName, Metric]]
Exposes underlying consumer or producer metrics (as reported by underlying Kafka client library)
Exposes underlying consumer or producer metrics (as reported by underlying Kafka client library)
- Definition Classes
- DrainingControl → Control
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isShutdown: CompletionStage[Done]
Shutdown status.
Shutdown status. The
CompletionStagewill be completed when the stage has been shut down and the underlyingKafkaConsumerhas been closed. Shutdown can be triggered from downstream cancellation, errors, or #shutdown.- Definition Classes
- DrainingControl → Control
- 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()
- def shutdown(): CompletionStage[Done]
Shutdown the consumer
Source.Shutdown the consumer
Source. It will wait for outstanding offset commit requests before shutting down.- Definition Classes
- DrainingControl → Control
- def stop(): CompletionStage[Done]
Stop producing messages from the
Source.Stop producing messages from the
Source. This does not stop underlying kafka consumer and does not unsubscribe from any topics/partitions.Call #shutdown to close consumer
- Definition Classes
- DrainingControl → Control
- val streamCompletion: CompletionStage[T]
- 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()