org.apache.pulsar.broker.transaction.pendingack

Interface PendingAckHandle

All Known Implementing Classes:

PendingAckHandleDisabled, PendingAckHandleImpl

public interface PendingAckHandle

Handle for processing pending acks for transactions.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	abortTxn(org.apache.pulsar.client.api.transaction.TxnID txnId, Consumer consumer) Abort a transaction.
boolean	checkIsCanDeleteConsumerPendingAck(PositionImpl position) Judge the all ack set point have acked by normal ack and transaction pending ack.
void	clearIndividualPosition(Position position) When the position is actually deleted, we can use this method to clear the cache for individual ack messages.
CompletableFuture<Void>	commitTxn(org.apache.pulsar.client.api.transaction.TxnID txnID, Map<String,Long> properties) Commit a transaction.
CompletableFuture<Void>	cumulativeAcknowledgeMessage(org.apache.pulsar.client.api.transaction.TxnID txnID, List<PositionImpl> positions) Acknowledge message(s) for an ongoing transaction.
CompletableFuture<Void>	individualAcknowledgeMessage(org.apache.pulsar.client.api.transaction.TxnID txnID, List<org.apache.commons.lang3.tuple.MutablePair<PositionImpl,Integer>> positions) Acknowledge message(s) for an ongoing transaction.
void	syncBatchPositionAckSetForTransaction(PositionImpl position) Sync the position ack set, in order to clean up the cache of this position for pending ack handle.

Method Detail

individualAcknowledgeMessage

CompletableFuture<Void> individualAcknowledgeMessage(org.apache.pulsar.client.api.transaction.TxnID txnID,
                                                     List<org.apache.commons.lang3.tuple.MutablePair<PositionImpl,Integer>> positions)

Acknowledge message(s) for an ongoing transaction.

It can be of PulsarApi.CommandAck.AckType.Individual. Single messages acked by ongoing transaction will be put in pending_ack state and only marked as deleted after transaction is committed.

If transaction is aborted all messages acked by it will be put back to pending state.

Client will not send batch size to server, we get the batch size from consumer pending ack. When we get the Batch size, we can accurate batch ack of this position.

Parameters:

txnID - TxnIDTransactionID of an ongoing transaction trying to sck message.

positions - MutablePair the pair of positions and these batch size.

Returns:

the future of this operation.

Throws:

TransactionConflictException - if the ack with transaction is conflict with pending ack.

BrokerServiceException.NotAllowedException - if Use this method incorrectly eg. not use PositionImpl or cumulative ack with a list of positions.

cumulativeAcknowledgeMessage

CompletableFuture<Void> cumulativeAcknowledgeMessage(org.apache.pulsar.client.api.transaction.TxnID txnID,
                                                     List<PositionImpl> positions)

Acknowledge message(s) for an ongoing transaction.

It can be of PulsarApi.CommandAck.AckType.Cumulative. Single messages acked by ongoing transaction will be put in pending_ack state and only marked as deleted after transaction is committed.

For a moment, we only allow one transaction cumulative ack multiple times when the position is greater than the old one.

We have a transaction with cumulative ack, if other transaction want to cumulative ack, we will return TransactionConflictException.

If an ongoing transaction cumulative acked a message and then try to ack single message which is greater than that one it cumulative acked, it'll succeed.

Parameters:

txnID - TxnIDTransactionID of an ongoing transaction trying to sck message.

positions - MutablePair the pair of positions and these batch size.

Returns:

the future of this operation.

Throws:

TransactionConflictException - if the ack with transaction is conflict with pending ack.

BrokerServiceException.NotAllowedException - if Use this method incorrectly eg. not use PositionImpl or cumulative ack with a list of positions.

commitTxn

CompletableFuture<Void> commitTxn(org.apache.pulsar.client.api.transaction.TxnID txnID,
                                  Map<String,Long> properties)

Commit a transaction.

Parameters:

txnID - TxnID to identify the transaction.

properties - Additional user-defined properties that can be associated with a particular cursor position.

Returns:

the future of this operation.

abortTxn

CompletableFuture<Void> abortTxn(org.apache.pulsar.client.api.transaction.TxnID txnId,
                                 Consumer consumer)

Abort a transaction.

Parameters:

txnId - TxnID to identify the transaction.

consumer - Consumer which aborting transaction.

Returns:

the future of this operation.

syncBatchPositionAckSetForTransaction

void syncBatchPositionAckSetForTransaction(PositionImpl position)

Sync the position ack set, in order to clean up the cache of this position for pending ack handle.

Parameters:

position - Position which position need to sync and carry it batch size

checkIsCanDeleteConsumerPendingAck

boolean checkIsCanDeleteConsumerPendingAck(PositionImpl position)

Judge the all ack set point have acked by normal ack and transaction pending ack.

Parameters:

position - Position which position need to check

clearIndividualPosition

void clearIndividualPosition(Position position)

When the position is actually deleted, we can use this method to clear the cache for individual ack messages.

Parameters:

position - Position which position need to clear