Package org.apache.activemq.artemis.core.paging.cursor

Interface PageSubscription

All Known Implementing Classes:
PageSubscriptionImpl
public interface PageSubscription

  • Method Details

    • getPagingStore

      PagingStore getPagingStore()

    • stop

      void stop()

    • counterSnapshot

      void counterSnapshot()
      Save a snapshot of the current counter value in the journal

    • notEmpty

      void notEmpty()
      This is a callback to inform the PageSubscription that something was routed, so the empty flag can be cleared

    • bookmark

      void bookmark(PagePosition position) throws Exception
      Throws:
      Exception

    • getCounter

      PageSubscriptionCounter getCounter()

    • getMessageCount

      long getMessageCount()

    • isCounterPending

      boolean isCounterPending()

    • getPersistentSize

      long getPersistentSize()

    • getId

      long getId()

    • isPersistent

      boolean isPersistent()

    • isPaging

      boolean isPaging()
      Used as a delegate method to PagingStore.isPaging()

    • iterator

      PageIterator iterator()

    • iterator

      PageIterator iterator(boolean browsing)

    • destroy

      void destroy() throws Exception
      Throws:
      Exception

    • scheduleCleanupCheck

      void scheduleCleanupCheck()

    • cleanupEntries

      void cleanupEntries(boolean completeDelete) throws Exception
      Throws:
      Exception

    • onPageModeCleared

      void onPageModeCleared(Transaction tx) throws Exception
      Throws:
      Exception

    • disableAutoCleanup

      void disableAutoCleanup()

    • enableAutoCleanup

      void enableAutoCleanup()

    • ack

      void ack(PagedReference ref) throws Exception
      Throws:
      Exception

    • contains

      boolean contains(PagedReference ref) throws Exception
      Throws:
      Exception

    • isAcked

      boolean isAcked(PagedMessage pagedMessage)

    • confirmPosition

      void confirmPosition(PagePosition ref) throws Exception
      Throws:
      Exception

    • ackTx

      void ackTx(Transaction tx, PagedReference position, boolean fromDelivery) throws Exception
      Throws:
      Exception

    • ackTx

      default void ackTx(Transaction tx, PagedReference position) throws Exception
      Throws:
      Exception

    • confirmPosition

      void confirmPosition(Transaction tx, PagePosition position, boolean fromDelivery) throws Exception
      Throws:
      Exception

    • getFirstPage

      long getFirstPage()
      Returns the first page in use or MAX_LONG if none is in use.
      Returns:
      the first page in use or MAX_LONG if none is in use

    • reloadACK

      void reloadACK(PagePosition position)

    • reloadPageCompletion

      boolean reloadPageCompletion(PagePosition position) throws Exception
      Throws:
      Exception

    • reloadPageInfo

      void reloadPageInfo(long pageNr)

    • positionIgnored

      void positionIgnored(PagePosition position)
      To be called when the cursor decided to ignore a position.

    • lateDeliveryRollback

      void lateDeliveryRollback(PagePosition position)

    • reloadPreparedACK

      void reloadPreparedACK(Transaction tx, PagePosition position)
      To be used to avoid a redelivery of a prepared ACK after load

    • processReload

      void processReload() throws Exception
      Throws:
      Exception

    • addPendingDelivery

      void addPendingDelivery(PagedMessage pagedMessage)

    • redeliver

      void redeliver(PageIterator iterator, PagedReference reference)

    • printDebug

      void printDebug()

    • isComplete

      boolean isComplete(long page)

    • forEachConsumedPage

      void forEachConsumedPage(Consumer<ConsumedPage> pageCleaner)

    • queryMessage

      PagedMessage queryMessage(PagePosition pos)
      To be used to requery the reference

    • setQueue

      void setQueue(Queue queue)

    • getQueue

      Queue getQueue()

    • onDeletePage

      void onDeletePage(Page deletedPage) throws Exception
      Throws:
      Exception

    • removePendingDelivery

      void removePendingDelivery(PagedMessage pagedMessage)

    • locatePageInfo

      ConsumedPage locatePageInfo(long pageNr)