Packages

trait Control extends AnyRef

Materialized value of the consumer Source.

See Controlled shutdown

Source
Consumer.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
DrainingControl, NoopControl, FakeControl
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Control
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def 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.

  2. abstract def metrics: Future[Map[MetricName, Metric]]

    Exposes underlying consumer or producer metrics (as reported by underlying Kafka client library)

  3. abstract 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

  4. abstract 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.

Concrete Value Members

  1. 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.