Packages

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.

See Controlled shutdown

Source
Consumer.scala
Linear Supertypes
Control, AnyRef, Any
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()
  6. def drainAndShutdown()(implicit ec: ExecutionContext): Future[T]

    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.

  7. def drainAndShutdown[S](streamCompletion: Future[S])(implicit ec: ExecutionContext): Future[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
    DrainingControl → Control
  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()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val isShutdown: Future[Done]

    Shutdown status.

    Shutdown status. The Future 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
    DrainingControl → Control
  14. def metrics: Future[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
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def stop(): Future[Done]

    Stop producing messages from the Source and complete the stream.

    Stop producing messages from the Source and complete the stream. The underlying Kafka consumer stays alive so that it can handle commits for the already enqueued messages. It does not unsubscribe from any topics/partitions as that could trigger a consumer group rebalance.

    See Controlled shutdown

    Call #shutdown to close consumer.

    Definition Classes
    DrainingControl → Control
  19. val streamCompletion: Future[T]
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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()

Deprecated Value Members

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

    (Since version 9)

  2. def shutdown(): Future[Done]

    Shut down the consumer Source.

    Shut down the consumer Source.

    The actor backing the source will stay alive for akka.kafka.consumer.stop-timeout so that more commits from enqueued messages can be handled. The actor will wait for acknowledgements of the already sent offset commits from the Kafka broker before shutting down.

    See Controlled shutdown

    Definition Classes
    DrainingControl → Control
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use drainAndShutdown for proper shutdown of the stream.

Inherited from Control

Inherited from AnyRef

Inherited from Any

Ungrouped