org.apache.pulsar.client.api.transaction

Interface TransactionBufferClient

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public interface TransactionBufferClient

The transaction buffer client to commit and abort transactions on topics or subscription. The transaction buffer client is used by transaction coordinator to end transactions.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<TxnID>	abortTxnOnSubscription(String topic, String subscription, long txnIdMostBits, long txnIdLeastBits, long lowWaterMark) Abort the transaction associated with the topic subscription.
CompletableFuture<TxnID>	abortTxnOnTopic(String topic, long txnIdMostBits, long txnIdLeastBits, long lowWaterMark) Abort the transaction associated with the topic.
void	close()
CompletableFuture<TxnID>	commitTxnOnSubscription(String topic, String subscription, long txnIdMostBits, long txnIdLeastBits, long lowWaterMark) Commit the transaction associated with the topic subscription.
CompletableFuture<TxnID>	commitTxnOnTopic(String topic, long txnIdMostBits, long txnIdLeastBits, long lowWaterMark) Commit the transaction associated with the topic.

Method Detail

commitTxnOnTopic

CompletableFuture<TxnID> commitTxnOnTopic(String topic,
                                          long txnIdMostBits,
                                          long txnIdLeastBits,
                                          long lowWaterMark)

Commit the transaction associated with the topic.

Parameters:

topic - topic name

txnIdMostBits - the most bits of txn id

txnIdLeastBits - the least bits of txn id

lowWaterMark - the low water mark of this txn;

Returns:

the future represents the commit result

abortTxnOnTopic

CompletableFuture<TxnID> abortTxnOnTopic(String topic,
                                         long txnIdMostBits,
                                         long txnIdLeastBits,
                                         long lowWaterMark)

Abort the transaction associated with the topic.

Parameters:

topic - topic name

txnIdMostBits - the most bits of txn id

txnIdLeastBits - the least bits of txn id

lowWaterMark - the low water mark of this txn

Returns:

the future represents the abort result

commitTxnOnSubscription

CompletableFuture<TxnID> commitTxnOnSubscription(String topic,
                                                 String subscription,
                                                 long txnIdMostBits,
                                                 long txnIdLeastBits,
                                                 long lowWaterMark)

Commit the transaction associated with the topic subscription.

Parameters:

topic - topic name

subscription - subscription name

txnIdMostBits - the most bits of txn id

txnIdLeastBits - the least bits of txn id

lowWaterMark - the low water mark of this txn

Returns:

the future represents the commit result

abortTxnOnSubscription

CompletableFuture<TxnID> abortTxnOnSubscription(String topic,
                                                String subscription,
                                                long txnIdMostBits,
                                                long txnIdLeastBits,
                                                long lowWaterMark)

Abort the transaction associated with the topic subscription.

Parameters:

topic - topic name

subscription - subscription name

txnIdMostBits - the most bits of txn id

txnIdLeastBits - the least bits of txn id

lowWaterMark - the low water mark of this txn

Returns:

the future represents the abort result

close

void close()