Package org.apache.pulsar.broker.transaction.buffer.impl

Class TransactionBufferDisable

java.lang.Object
org.apache.pulsar.broker.transaction.buffer.impl.TransactionBufferDisable
All Implemented Interfaces:
TransactionBuffer
public class TransactionBufferDisable extends Object implements TransactionBuffer
Transaction buffer disable.

  • Constructor Details

    • TransactionBufferDisable

      public TransactionBufferDisable(Topic topic)

  • Method Details

    • getTransactionMeta

      public CompletableFuture<TransactionMeta> getTransactionMeta(org.apache.pulsar.client.api.transaction.TxnID txnID)
      Description copied from interface: TransactionBuffer
      Return the metadata of a transaction in the buffer.
      Specified by:
      getTransactionMeta in interface TransactionBuffer
      Parameters:
      txnID - the transaction id
      Returns:
      a future represents the result of the operation

    • appendBufferToTxn

      public CompletableFuture<Position> appendBufferToTxn(org.apache.pulsar.client.api.transaction.TxnID txnId, long sequenceId, io.netty.buffer.ByteBuf buffer)
      Description copied from interface: TransactionBuffer
      Append the buffer to the transaction buffer.

      The entry will be indexed by txnId and sequenceId.

      Specified by:
      appendBufferToTxn in interface TransactionBuffer
      Parameters:
      txnId - the transaction id
      sequenceId - the sequence id of the entry in this transaction buffer.
      buffer - the entry buffer
      Returns:
      a future represents the result of the operation.

    • openTransactionBufferReader

      public CompletableFuture<TransactionBufferReader> openTransactionBufferReader(org.apache.pulsar.client.api.transaction.TxnID txnID, long startSequenceId)
      Description copied from interface: TransactionBuffer
      Open a TransactionBufferReader to read entries of a given transaction starting from the provided sequenceId.
      Specified by:
      openTransactionBufferReader in interface TransactionBuffer
      Parameters:
      txnID - transaction id
      startSequenceId - the sequence id to start read
      Returns:
      a future represents the result of open operation.

    • commitTxn

      public CompletableFuture<Void> commitTxn(org.apache.pulsar.client.api.transaction.TxnID txnID, long lowWaterMark)
      Description copied from interface: TransactionBuffer
      Commit the transaction and seal the buffer for this transaction.

      If a transaction is sealed, no more entries can be TransactionBuffer.appendBufferToTxn(TxnID, long, ByteBuf).

      Specified by:
      commitTxn in interface TransactionBuffer
      Parameters:
      txnID - the transaction id
      lowWaterMark - the low water mark of this transaction
      Returns:
      a future represents the result of commit operation.

    • abortTxn

      public CompletableFuture<Void> abortTxn(org.apache.pulsar.client.api.transaction.TxnID txnID, long lowWaterMark)
      Description copied from interface: TransactionBuffer
      Abort the transaction and all the entries of this transaction will be discarded.
      Specified by:
      abortTxn in interface TransactionBuffer
      Parameters:
      txnID - the transaction id
      lowWaterMark - the low water mark of this transaction
      Returns:
      a future represents the result of abort operation.

    • purgeTxns

      public CompletableFuture<Void> purgeTxns(List<Long> dataLedgers)
      Description copied from interface: TransactionBuffer
      Purge all the data of the transactions who are committed and stored in the provided data ledgers.

      This method will be called by the broker before they delete the ledgers. It ensures that all the transactions committed in those ledgers can be purged.

      Specified by:
      purgeTxns in interface TransactionBuffer
      Parameters:
      dataLedgers - the list of data ledgers.
      Returns:
      a future represents the result of purge operations.

    • clearSnapshot

      public CompletableFuture<Void> clearSnapshot()
      Description copied from interface: TransactionBuffer
      Clear up the snapshot of the TransactionBuffer.
      Specified by:
      clearSnapshot in interface TransactionBuffer
      Returns:
      Clear up operation result.

    • closeAsync

      public CompletableFuture<Void> closeAsync()
      Description copied from interface: TransactionBuffer
      Close the buffer asynchronously.
      Specified by:
      closeAsync in interface TransactionBuffer
      Returns:

    • isTxnAborted

      public boolean isTxnAborted(org.apache.pulsar.client.api.transaction.TxnID txnID, Position readPosition)
      Description copied from interface: TransactionBuffer
      Check if the txn is aborted. TODO: To avoid broker oom, we will load the aborted txn from snapshot on demand. So we need the readPosition to check if the txn is loaded.
      Specified by:
      isTxnAborted in interface TransactionBuffer
      Parameters:
      txnID - TxnID txnId.
      readPosition - the persistent position of the txn message.
      Returns:
      whether the txn is aborted.

    • syncMaxReadPositionForNormalPublish

      public void syncMaxReadPositionForNormalPublish(Position position, boolean isMarkerMessage)
      Description copied from interface: TransactionBuffer
      Sync max read position for normal publish.
      Specified by:
      syncMaxReadPositionForNormalPublish in interface TransactionBuffer
      Parameters:
      position - Position the position to sync.
      isMarkerMessage - whether the message is marker message.

    • getMaxReadPosition

      public Position getMaxReadPosition()
      Description copied from interface: TransactionBuffer
      Get the can read max position.
      Specified by:
      getMaxReadPosition in interface TransactionBuffer
      Returns:
      the stable position.

    • getSnapshotType

      public AbortedTxnProcessor.SnapshotType getSnapshotType()
      Description copied from interface: TransactionBuffer
      Get the snapshot type. The snapshot type can be either "Single" or "Segment". In "Single" mode, a single snapshot log is used to record the transaction buffer stats. In "Segment" mode, a snapshot segment topic is used to record the stats, and a separate snapshot segment index topic is used to index these stats.
      Specified by:
      getSnapshotType in interface TransactionBuffer
      Returns:
      the snapshot type

    • getTransactionInBufferStats

      public org.apache.pulsar.common.policies.data.TransactionInBufferStats getTransactionInBufferStats(org.apache.pulsar.client.api.transaction.TxnID txnID)
      Description copied from interface: TransactionBuffer
      Get transaction in buffer stats.
      Specified by:
      getTransactionInBufferStats in interface TransactionBuffer
      Returns:
      the transaction in buffer stats.

    • getStats

      public org.apache.pulsar.common.policies.data.TransactionBufferStats getStats(boolean lowWaterMarks, boolean segmentStats)
      Description copied from interface: TransactionBuffer
      Get transaction stats in buffer.
      Specified by:
      getStats in interface TransactionBuffer
      Returns:
      the transaction stats in buffer.

    • getStats

      public org.apache.pulsar.common.policies.data.TransactionBufferStats getStats(boolean lowWaterMarks)
      Description copied from interface: TransactionBuffer
      Get transaction stats in buffer.
      Specified by:
      getStats in interface TransactionBuffer
      Returns:
      the transaction stats in buffer.

    • checkIfTBRecoverCompletely

      public CompletableFuture<Void> checkIfTBRecoverCompletely()
      Description copied from interface: TransactionBuffer
      Wait TransactionBuffer recovers completely.
      Specified by:
      checkIfTBRecoverCompletely in interface TransactionBuffer
      Returns:
      a future that will be completed after the transaction buffer recover completely.

    • getOngoingTxnCount

      public long getOngoingTxnCount()
      Specified by:
      getOngoingTxnCount in interface TransactionBuffer

    • getAbortedTxnCount

      public long getAbortedTxnCount()
      Specified by:
      getAbortedTxnCount in interface TransactionBuffer

    • getCommittedTxnCount

      public long getCommittedTxnCount()
      Specified by:
      getCommittedTxnCount in interface TransactionBuffer