NoopControl

akka.kafka.scaladsl.Consumer$.NoopControl$
object NoopControl extends Control

An implementation of Control to be used as an empty value, all methods return a failed future.

Attributes

Source:
Consumer.scala
Graph
Supertypes
trait Control
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Concrete methods

override def isShutdown: Future[Done]

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.

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.

Attributes

Definition Classes
Source:
Consumer.scala

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)

Attributes

Definition Classes
Source:
Consumer.scala
override 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

Attributes

Definition Classes
Source:
Consumer.scala
override def stop(): Future[Done]

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.

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.

Attributes

Definition Classes
Source:
Consumer.scala

Inherited methods

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. Failures in stream completion will be propagated, the source will be shut down anyway.

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.

Attributes

Inherited from:
Control
Source:
Consumer.scala