Package org.apache.activemq.broker.region

Class DurableTopicSubscription

java.lang.Object

org.apache.activemq.broker.region.AbstractSubscription

org.apache.activemq.broker.region.PrefetchSubscription

org.apache.activemq.broker.region.DurableTopicSubscription

All Implemented Interfaces:

Subscription, SubscriptionRecovery, org.apache.activemq.usage.UsageListener

public class DurableTopicSubscription
extends PrefetchSubscription
implements org.apache.activemq.usage.UsageListener

Field Summary

Fields inherited from class org.apache.activemq.broker.region.PrefetchSubscription

dispatched, dispatchLock, pending, pendingLock, scheduler, usageManager

Fields inherited from class org.apache.activemq.broker.region.AbstractSubscription

broker, context, destinationFilter, destinations, info, prefetchExtension

Constructor Summary

Constructors

Constructor	Description
DurableTopicSubscription(Broker broker, SystemUsage usageManager, ConnectionContext context, org.apache.activemq.command.ConsumerInfo info, boolean keepDurableSubsActive)

Method Summary

Modifier and Type	Method	Description
protected void	acknowledge(ConnectionContext context, org.apache.activemq.command.MessageAck ack, org.apache.activemq.broker.region.MessageReference node)	Used during acknowledgment to remove the message.
void	activate(SystemUsage memoryManager, ConnectionContext context, org.apache.activemq.command.ConsumerInfo info, RegionBroker regionBroker)
void	add(ConnectionContext context, Destination destination)	The subscription will be receiving messages from the destination.
void	add(org.apache.activemq.broker.region.MessageReference node)	Used to add messages that match the subscription.
protected boolean	canDispatch(org.apache.activemq.broker.region.MessageReference node)	Use when a matched message is about to be dispatched to the client.
protected org.apache.activemq.command.MessageDispatch	createMessageDispatch(org.apache.activemq.broker.region.MessageReference node, org.apache.activemq.command.Message message)
void	deactivate(boolean keepDurableSubsActive, long lastDeliveredSequenceId)
void	destroy()	Release any references that we are holding.
void	dispatchPending()
protected void	doAddRecoveredMessage(org.apache.activemq.broker.region.MessageReference message)
void	gc()	The subscription should release as may references as it can to help the garbage collector reclaim memory.
final long	getOfflineTimestamp()
int	getPendingQueueSize()
SubscriptionKey	getSubscriptionKey()
final boolean	isActive()
protected boolean	isDropped(org.apache.activemq.broker.region.MessageReference node)
boolean	isEmpty(Topic topic)
boolean	isEnableMessageExpirationOnActiveDurableSubs()
boolean	isFull()	Used to determine if the broker can dispatch to the consumer.
boolean	isKeepDurableSubsActive()
void	onUsageChanged(org.apache.activemq.usage.Usage usage, int oldPercentUsage, int newPercentUsage)
protected void	processExpiredAck(ConnectionContext context, Destination dest, org.apache.activemq.broker.region.MessageReference node)
void	removePending(org.apache.activemq.broker.region.MessageReference node)
void	setOfflineTimestamp(long timestamp)
protected void	setPendingBatchSize(PendingMessageCursor pending, int numberToDispatch)
void	setSelector(String selector)	Attempts to change the current active selector on the subscription.
String	toString()
protected boolean	trackedInPendingTransaction(org.apache.activemq.broker.region.MessageReference node)
void	unmatched(org.apache.activemq.broker.region.MessageReference node)	store will have a pending ack for all durables, irrespective of the selector so we need to ack if node is un-matched

Methods inherited from class org.apache.activemq.broker.region.PrefetchSubscription

acknowledge, assertAckMatchesDispatched, countBeforeFull, dispatch, getDequeueCounter, getDispatchedCounter, getDispatchedQueueSize, getEnqueueCounter, getInFlightSize, getMaxAuditDepth, getMaxProducersToAudit, getPending, getPendingMessageSize, isHighWaterMark, isLowWaterMark, isRecoveryRequired, onDispatch, processMessageDispatchNotification, pullMessage, remove, remove, sendToDLQ, setMaxAuditDepth, setMaxProducersToAudit, setPending, setPrefetchSize, updateConsumerPrefetch

Methods inherited from class org.apache.activemq.broker.region.AbstractSubscription

addDestination, addRecoveredMessage, contractPrefetchExtension, decrementPrefetchExtension, expandPrefetchExtension, getActiveMQDestination, getConsumedCount, getConsumerInfo, getContext, getCursorMemoryHighWaterMark, getDestinations, getInFlightMessageSize, getInFlightUsage, getInfo, getObjectName, getPrefetchExtension, getPrefetchSize, getSelector, getSelectorExpression, getSubscriptionStatistics, getTimeOfLastMessageAck, incrementConsumedCount, isBrowser, isSlowConsumer, isUsePrefetchExtension, isWildcard, matches, matches, removeDestination, resetConsumedCount, setCursorMemoryHighWaterMark, setObjectName, setSlowConsumer, setTimeOfLastMessageAck, setUsePrefetchExtension, wakeupDestinationsForDispatch

Methods inherited from class java.lang.Object

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

Constructor Details

DurableTopicSubscription

public DurableTopicSubscription(Broker broker,
 SystemUsage usageManager,
 ConnectionContext context,
 org.apache.activemq.command.ConsumerInfo info,
 boolean keepDurableSubsActive)
                         throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

Method Details

isActive

public final boolean isActive()

getOfflineTimestamp

public final long getOfflineTimestamp()

setOfflineTimestamp

public void setOfflineTimestamp(long timestamp)

isFull

public boolean isFull()

Description copied from class: PrefetchSubscription

Used to determine if the broker can dispatch to the consumer.

Specified by:

isFull in interface Subscription

Overrides:

isFull in class PrefetchSubscription

Returns:

true if the subscription is full

gc

public void gc()

Description copied from interface: Subscription

The subscription should release as may references as it can to help the garbage collector reclaim memory.

Specified by:

gc in interface Subscription

Overrides:

gc in class AbstractSubscription

unmatched

public void unmatched(org.apache.activemq.broker.region.MessageReference node)
               throws IOException

store will have a pending ack for all durables, irrespective of the selector so we need to ack if node is un-matched

Specified by:

unmatched in interface Subscription

Overrides:

unmatched in class AbstractSubscription

Throws:

IOException

setPendingBatchSize

protected void setPendingBatchSize(PendingMessageCursor pending,
 int numberToDispatch)

Overrides:

setPendingBatchSize in class PrefetchSubscription

add

public void add(ConnectionContext context,
 Destination destination)
         throws Exception

Description copied from interface: Subscription

The subscription will be receiving messages from the destination.

Specified by:

add in interface Subscription

Overrides:

add in class PrefetchSubscription

Throws:

Exception

isEmpty

public boolean isEmpty(Topic topic)

activate

public void activate(SystemUsage memoryManager,
 ConnectionContext context,
 org.apache.activemq.command.ConsumerInfo info,
 RegionBroker regionBroker)
              throws Exception

Throws:

Exception

deactivate

public void deactivate(boolean keepDurableSubsActive,
 long lastDeliveredSequenceId)
                throws Exception

Throws:

Exception

createMessageDispatch

protected org.apache.activemq.command.MessageDispatch createMessageDispatch(org.apache.activemq.broker.region.MessageReference node,
 org.apache.activemq.command.Message message)

Overrides:

createMessageDispatch in class PrefetchSubscription

Returns:

MessageDispatch

add

public void add(org.apache.activemq.broker.region.MessageReference node)
         throws Exception

Description copied from interface: Subscription

Used to add messages that match the subscription.

Specified by:

add in interface Subscription

Overrides:

add in class PrefetchSubscription

Throws:

Exception

InterruptedException

IOException

dispatchPending

public void dispatchPending()
                     throws IOException

Overrides:

dispatchPending in class PrefetchSubscription

Throws:

IOException

removePending

public void removePending(org.apache.activemq.broker.region.MessageReference node)
                   throws IOException

Throws:

IOException

processExpiredAck

protected void processExpiredAck(ConnectionContext context,
 Destination dest,
 org.apache.activemq.broker.region.MessageReference node)

Overrides:

processExpiredAck in class PrefetchSubscription

doAddRecoveredMessage

protected void doAddRecoveredMessage(org.apache.activemq.broker.region.MessageReference message)
                              throws Exception

Overrides:

doAddRecoveredMessage in class AbstractSubscription

Throws:

Exception

getPendingQueueSize

public int getPendingQueueSize()

Specified by:

getPendingQueueSize in interface Subscription

Overrides:

getPendingQueueSize in class PrefetchSubscription

Returns:

number of messages pending delivery

setSelector

public void setSelector(String selector)
                 throws jakarta.jms.InvalidSelectorException

Description copied from interface: Subscription

Attempts to change the current active selector on the subscription. This operation is not supported for persistent topics.

Specified by:

setSelector in interface Subscription

Overrides:

setSelector in class AbstractSubscription

Throws:

jakarta.jms.InvalidSelectorException

canDispatch

protected boolean canDispatch(org.apache.activemq.broker.region.MessageReference node)

Description copied from class: PrefetchSubscription

Use when a matched message is about to be dispatched to the client.

Specified by:

canDispatch in class PrefetchSubscription

Returns:

false if the message should not be dispatched to the client (another sub may have already dispatched it for example).

trackedInPendingTransaction

protected boolean trackedInPendingTransaction(org.apache.activemq.broker.region.MessageReference node)

Overrides:

trackedInPendingTransaction in class PrefetchSubscription

acknowledge

protected void acknowledge(ConnectionContext context,
 org.apache.activemq.command.MessageAck ack,
 org.apache.activemq.broker.region.MessageReference node)
                    throws IOException

Description copied from class: PrefetchSubscription

Used during acknowledgment to remove the message.

Specified by:

acknowledge in class PrefetchSubscription

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getSubscriptionKey

public SubscriptionKey getSubscriptionKey()

destroy

public void destroy()

Release any references that we are holding.

Specified by:

destroy in interface Subscription

onUsageChanged

public void onUsageChanged(org.apache.activemq.usage.Usage usage,
 int oldPercentUsage,
 int newPercentUsage)

Specified by:

onUsageChanged in interface org.apache.activemq.usage.UsageListener

isDropped

protected boolean isDropped(org.apache.activemq.broker.region.MessageReference node)

Specified by:

isDropped in class PrefetchSubscription

isKeepDurableSubsActive

public boolean isKeepDurableSubsActive()

isEnableMessageExpirationOnActiveDurableSubs

public boolean isEnableMessageExpirationOnActiveDurableSubs()