org.apache.pulsar.broker.transaction.pendingack.impl

Class PendingAckHandleImpl

java.lang.Object

org.apache.pulsar.broker.transaction.pendingack.impl.PendingAckHandleImpl

All Implemented Interfaces:

PendingAckHandle

public class PendingAckHandleImpl
extends Object
implements PendingAckHandle

The default implementation of PendingAckHandle.

Constructor Summary

Constructors

Constructor and Description
PendingAckHandleImpl(PersistentSubscription persistentSubscription)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PendingAckHandleImpl

public PendingAckHandleImpl(PersistentSubscription persistentSubscription)

Method Detail

individualAcknowledgeMessage

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

Description copied from interface: PendingAckHandle

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.

Specified by:

individualAcknowledgeMessage in interface PendingAckHandle

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.

cumulativeAcknowledgeMessage

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

Description copied from interface: PendingAckHandle

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.

Specified by:

cumulativeAcknowledgeMessage in interface PendingAckHandle

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.

commitTxn

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

Description copied from interface: PendingAckHandle

Commit a transaction.

Specified by:

commitTxn in interface PendingAckHandle

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

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

Description copied from interface: PendingAckHandle

Abort a transaction.

Specified by:

abortTxn in interface PendingAckHandle

Parameters:

txnId - TxnID to identify the transaction.

consumer - Consumer which aborting transaction.

Returns:

the future of this operation.

syncBatchPositionAckSetForTransaction

public void syncBatchPositionAckSetForTransaction(PositionImpl position)

Description copied from interface: PendingAckHandle

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

Specified by:

syncBatchPositionAckSetForTransaction in interface PendingAckHandle

Parameters:

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

checkIsCanDeleteConsumerPendingAck

public boolean checkIsCanDeleteConsumerPendingAck(PositionImpl position)

Description copied from interface: PendingAckHandle

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

Specified by:

checkIsCanDeleteConsumerPendingAck in interface PendingAckHandle

Parameters:

position - Position which position need to check

clearIndividualPosition

public void clearIndividualPosition(Position position)

Description copied from interface: PendingAckHandle

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

Specified by:

clearIndividualPosition in interface PendingAckHandle

Parameters:

position - Position which position need to clear