Trait

akka.kafka.scaladsl

PartitionAssignmentHandler

Related Doc: package scaladsl

Permalink

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
Linear Supertypes
AnyRef, Any
Known Subclasses
AsyncCallbacks, Chain, EmptyPartitionAssignmentHandler
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PartitionAssignmentHandler
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink

    See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsAssigned

    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

  2. abstract def onRevoke(revokedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

    Permalink

    See org.apache.kafka.clients.consumer.ConsumerRebalanceListener#onPartitionsRevoked

    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

  3. abstract def onStop(revokedTps: Set[TopicPartition], consumer: RestrictedConsumer): Unit

    Permalink

    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

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped