trait PartitionAssignmentHandler extends AnyRef
The API is new and may change in further releases.
Allows 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 CommittableOffset
's commit methods as their committing won't be executed as long as any of
the callbacks in this class are called.
This complements the methods of Kafka's ConsumerRebalanceListener with
an onStop
callback.
- Annotations
- @ApiMayChange()
- Source
- PartitionAssignmentHandler.scala
- Alphabetic
- By Inheritance
- PartitionAssignmentHandler
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract def onAssign(assignedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit
See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsAssigned
- assignedTps
The list of partitions that are now assigned to the consumer (may include partitions previously assigned to the consumer)
- consumer
A restricted version of the internally used Consumer
- abstract def onRevoke(revokedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit
See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsRevoked
- revokedTps
The list of partitions that were assigned to the consumer on the last rebalance
- consumer
A restricted version of the internally used Consumer
- abstract def onStop(revokedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit
Called before a consumer is closed.
Called before a consumer is closed. See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsRevoked
- revokedTps
The list of partitions that are currently assigned to the consumer
- consumer
A restricted version of the internally used Consumer
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])