Packages

c

akka.kafka.javadsl.Consumer

DrainingControl

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
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DrainingControl
  2. Control
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def drainAndShutdown(ec: Executor): CompletionStage[T]

    Stop producing messages from the Source, wait for stream completion and shut down the consumer Source.

    Stop producing messages from the Source, wait for stream completion and shut down the consumer Source. It will wait for outstanding offset commit requests to finish before shutting down.

  7. def drainAndShutdown[S](streamCompletion: CompletionStage[S], ec: Executor): CompletionStage[S]

    Stop producing messages from the Source, wait for stream completion and shut down the consumer Source so that all consumed messages reach the end of the stream.

    Stop producing messages from the Source, wait for stream completion and shut down the consumer Source so 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
    DrainingControlControl
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. 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
    DrainingControlControl
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def isShutdown: CompletionStage[Done]

    Shutdown status.

    Shutdown status. The CompletionStage will be completed when the stage has been shut down and the underlying KafkaConsumer has been closed. Shutdown can be triggered from downstream cancellation, errors, or #shutdown.

    Definition Classes
    DrainingControlControl
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. 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
    DrainingControlControl
  19. 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
    DrainingControlControl
  20. val streamCompletion: CompletionStage[T]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Control

Inherited from AnyRef

Inherited from Any

Ungrouped