Package org.apache.activemq.broker.region.cursors

Class QueueDispatchPendingList

  • All Implemented Interfaces:
    Iterable<MessageReference>, PendingList
    public class QueueDispatchPendingList
extends Object
implements PendingList
    An abstraction that keeps the correct order of messages that need to be dispatched to consumers, but also hides the fact that there might be redelivered messages that should be dispatched ahead of any other paged in messages. Direct usage of this class is recommended as you can control when redeliveries need to be added vs regular pending messages (the next set of messages that can be dispatched) Created by ceposta

      • Constructor Detail

        • QueueDispatchPendingList

          public QueueDispatchPendingList()

      • Method Detail

        • isEmpty

          public boolean isEmpty()
          Description copied from interface: PendingList
          Returns true if there are no Messages in the PendingList currently.
          Specified by:
          isEmpty in interface PendingList
          Returns:
          true if the PendingList is currently empty.

        • clear

          public void clear()
          Description copied from interface: PendingList
          Discards all Messages currently held in the PendingList.
          Specified by:
          clear in interface PendingList

        • addMessageFirst

          public PendingNode addMessageFirst​(MessageReference message)
          Messages added are added directly to the pagedInPendingDispatch set of messages. If you're trying to add a message that is marked redelivered add it using addMessageForRedelivery() method
          Specified by:
          addMessageFirst in interface PendingList
          Parameters:
          message - The MessageReference that is to be added to this list.
          Returns:
          the pending node.

        • addMessageLast

          public PendingNode addMessageLast​(MessageReference message)
          Messages added are added directly to the pagedInPendingDispatch set of messages. If you're trying to add a message that is marked redelivered add it using addMessageForRedelivery() method
          Specified by:
          addMessageLast in interface PendingList
          Parameters:
          message - The MessageReference that is to be added to this list.
          Returns:
          the pending node.

        • remove

          public PendingNode remove​(MessageReference message)
          Description copied from interface: PendingList
          Removes the given MessageReference from the PendingList if it is contained within.
          Specified by:
          remove in interface PendingList
          Parameters:
          message - The MessageReference that is to be removed to this list.
          Returns:
          the PendingNode that contains the removed message or null if the message was not present in this list.

        • size

          public int size()
          Description copied from interface: PendingList
          Returns the number of MessageReferences that are awaiting dispatch.
          Specified by:
          size in interface PendingList
          Returns:
          current count of the pending messages.

        • iterator

          public Iterator<MessageReference> iterator()
          Description copied from interface: PendingList
          Returns an iterator over the pending Messages. The subclass controls how the returned iterator actually traverses the list of pending messages allowing for the order to vary based on factors like Message priority or some other mechanism.
          Specified by:
          iterator in interface Iterable<MessageReference>
          Specified by:
          iterator in interface PendingList
          Returns:
          an Iterator that returns MessageReferences contained in this list.

        • contains

          public boolean contains​(MessageReference message)
          Description copied from interface: PendingList
          Query the PendingList to determine if the given message is contained within.
          Specified by:
          contains in interface PendingList
          Parameters:
          message - The Message that is the target of this query.
          Returns:
          true if the MessageReference is contained in this list.

        • values

          public Collection<MessageReference> values()
          Description copied from interface: PendingList
          Returns a new Collection that contains all the MessageReferences currently held in this PendingList. The elements of the list are ordered using the same rules as the subclass uses for iteration.
          Specified by:
          values in interface PendingList
          Returns:
          a new Collection containing this lists MessageReferences.

        • addAll

          public void addAll​(PendingList pendingList)
          Description copied from interface: PendingList
          Adds all the elements of the given PendingList to this PendingList.
          Specified by:
          addAll in interface PendingList
          Parameters:
          pendingList - The PendingList that is to be added to this collection.

        • setPrioritizedMessages

          public void setPrioritizedMessages​(boolean prioritizedMessages)

        • hasRedeliveries

          public boolean hasRedeliveries()

        • addForRedelivery

          public void addForRedelivery​(List<MessageReference> list,
                             boolean noConsumers)