PartitionAssignmentHandler

akka.kafka.scaladsl.PartitionAssignmentHandler

The API is new and may change in further releases.

Allows the user to execute user code when Kafka rebalances partitions between consumers, or an Alpakka Kafka consumer is stopped. Use with care: These callbacks are called synchronously on the same thread Kafka's poll() is called. A warning will be logged if a callback takes longer than the configured partition-handler-warning.

There is no point in calling Committable's commit methods as their committing won't be executed as long as any of the callbacks in this class are called. Calling commitSync on the passed akka.kafka.RestrictedConsumer is available.

This complements the methods of Kafka's ConsumerRebalanceListener with an onStop callback which is called before Consumer.close.

Attributes

Source:
PartitionAssignmentHandler.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Value members

Abstract methods

def onAssign(assignedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

Attributes

assignedTps

The list of partitions that are now assigned to the consumer (may include partitions previously assigned to the consumer)

consumer

The akka.kafka.RestrictedConsumer gives some access to the internally used Consumer

Source:
PartitionAssignmentHandler.scala
def onLost(lostTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

Called when partition metadata has changed and partitions no longer exist. This can occur if a topic is deleted or if the leader's metadata is stale. See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsLost

Called when partition metadata has changed and partitions no longer exist. This can occur if a topic is deleted or if the leader's metadata is stale. See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsLost

Attributes

consumer

The akka.kafka.RestrictedConsumer gives some access to the internally used Consumer

lostTps

The list of partitions that are no longer valid

Source:
PartitionAssignmentHandler.scala
def onRevoke(revokedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit
def onStop(currentTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

Attributes

consumer

The akka.kafka.RestrictedConsumer gives some access to the internally used Consumer

currentTps

The list of partitions that are currently assigned to the consumer

Source:
PartitionAssignmentHandler.scala