kafka.server.share

Class SharePartition

java.lang.Object

kafka.server.share.SharePartition

public class SharePartition
extends Object

The SharePartition is used to track the state of a partition that is shared between multiple consumers. The class maintains the state of the records that have been fetched from the leader and are in-flight.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Optional<Throwable>>	acknowledge(String memberId, List<org.apache.kafka.server.share.ShareAcknowledgementBatch> acknowledgementBatch) Acknowledge the fetched records for the share partition.
CompletableFuture<List<org.apache.kafka.common.message.ShareFetchResponseData.AcquiredRecords>>	acquire(String memberId, org.apache.kafka.storage.internals.log.FetchPartitionData fetchPartitionData) Acquire the fetched records for the share partition.
long	nextFetchOffset() The next fetch offset is used to determine the next offset that should be fetched from the leader.
CompletableFuture<Optional<Throwable>>	releaseAcquiredRecords(String memberId) Release the acquired records for the share partition.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

nextFetchOffset

public long nextFetchOffset()

The next fetch offset is used to determine the next offset that should be fetched from the leader. The offset should be the next offset after the last fetched batch but there could be batches/ offsets that are either released by acknowledgement API or lock timed out hence the next fetch offset might be different from the last batch next offset. Hence, method checks if the next fetch offset should be recomputed else returns the last computed next fetch offset.

Returns:

The next fetch offset that should be fetched from the leader.

acquire

public CompletableFuture<List<org.apache.kafka.common.message.ShareFetchResponseData.AcquiredRecords>> acquire(String memberId,
                                                                                                               org.apache.kafka.storage.internals.log.FetchPartitionData fetchPartitionData)

Acquire the fetched records for the share partition. The acquired records are added to the in-flight records and the next fetch offset is updated to the next offset that should be fetched from the leader.

Parameters:

memberId - The member id of the client that is fetching the record.

fetchPartitionData - The fetched records for the share partition.

Returns:

A future which is completed when the records are acquired.

acknowledge

public CompletableFuture<Optional<Throwable>> acknowledge(String memberId,
                                                          List<org.apache.kafka.server.share.ShareAcknowledgementBatch> acknowledgementBatch)

Acknowledge the fetched records for the share partition. The accepted batches are removed from the in-flight records once persisted. The next fetch offset is updated to the next offset that should be fetched from the leader, if required.

Parameters:

memberId - The member id of the client that is fetching the record.

acknowledgementBatch - The acknowledgement batch list for the share partition.

Returns:

A future which is completed when the records are acknowledged.

releaseAcquiredRecords

public CompletableFuture<Optional<Throwable>> releaseAcquiredRecords(String memberId)

Release the acquired records for the share partition. The next fetch offset is updated to the next offset that should be fetched from the leader.

Parameters:

memberId - The member id of the client whose records shall be released.

Returns:

A future which is completed when the records are released.