public abstract class PrefetchSubscription extends AbstractSubscription
Modifier and Type | Field and Description |
---|---|
protected List<MessageReference> |
dispatched |
protected Object |
dispatchLock |
protected PendingMessageCursor |
pending |
protected Object |
pendingLock |
protected AtomicInteger |
prefetchExtension |
protected Scheduler |
scheduler |
protected SystemUsage |
usageManager |
protected boolean |
usePrefetchExtension |
broker, context, destinationFilter, destinations, info
Constructor and Description |
---|
PrefetchSubscription(Broker broker,
SystemUsage usageManager,
ConnectionContext context,
ConsumerInfo info) |
PrefetchSubscription(Broker broker,
SystemUsage usageManager,
ConnectionContext context,
ConsumerInfo info,
PendingMessageCursor cursor) |
Modifier and Type | Method and Description |
---|---|
void |
acknowledge(ConnectionContext context,
MessageAck ack)
Used when client acknowledge receipt of dispatched message.
|
protected abstract void |
acknowledge(ConnectionContext context,
MessageAck ack,
MessageReference node)
Used during acknowledgment to remove the message.
|
void |
add(ConnectionContext context,
Destination destination)
The subscription will be receiving messages from the destination.
|
void |
add(MessageReference node)
Used to add messages that match the subscription.
|
protected void |
assertAckMatchesDispatched(MessageAck ack)
Checks an ack versus the contents of the dispatched list.
|
protected abstract boolean |
canDispatch(MessageReference node)
Use when a matched message is about to be dispatched to the client.
|
int |
countBeforeFull() |
protected MessageDispatch |
createMessageDispatch(MessageReference node,
Message message) |
protected boolean |
dispatch(MessageReference node) |
void |
dispatchPending() |
long |
getDequeueCounter() |
long |
getDispatchedCounter() |
int |
getDispatchedQueueSize() |
long |
getEnqueueCounter() |
int |
getInFlightSize() |
int |
getMaxAuditDepth() |
int |
getMaxProducersToAudit() |
PendingMessageCursor |
getPending() |
long |
getPendingMessageSize() |
int |
getPendingQueueSize() |
protected int |
getPrefetchExtension() |
protected abstract boolean |
isDropped(MessageReference node) |
boolean |
isFull()
Used to determine if the broker can dispatch to the consumer.
|
boolean |
isHighWaterMark() |
boolean |
isLowWaterMark() |
boolean |
isRecoveryRequired()
Informs the Broker if the subscription needs to intervention to recover it's state
e.g.
|
boolean |
isUsePrefetchExtension() |
protected void |
onDispatch(MessageReference node,
Message message) |
void |
processMessageDispatchNotification(MessageDispatchNotification mdn)
Used by a Slave Broker to update dispatch infomation
|
Response |
pullMessage(ConnectionContext context,
MessagePull pull)
Allows a message to be pulled on demand by a client
|
List<MessageReference> |
remove(ConnectionContext context,
Destination destination)
The subscription will be no longer be receiving messages from the destination.
|
List<MessageReference> |
remove(ConnectionContext context,
Destination destination,
List<MessageReference> dispatched) |
protected void |
sendToDLQ(ConnectionContext context,
MessageReference node,
Throwable poisonCause) |
void |
setMaxAuditDepth(int maxAuditDepth) |
void |
setMaxProducersToAudit(int maxProducersToAudit) |
void |
setPending(PendingMessageCursor pending) |
protected void |
setPendingBatchSize(PendingMessageCursor pending,
int numberToDispatch) |
void |
setPrefetchSize(int prefetchSize) |
void |
setUsePrefetchExtension(boolean usePrefetchExtension) |
void |
updateConsumerPrefetch(int newPrefetch)
inform the MessageConsumer on the client to change it's prefetch
|
addDestination, addRecoveredMessage, doAddRecoveredMessage, gc, getActiveMQDestination, getConsumedCount, getConsumerInfo, getContext, getCursorMemoryHighWaterMark, getInFlightMessageSize, getInFlightUsage, getInfo, getObjectName, getPrefetchSize, getSelector, getSelectorExpression, getSubscriptionStatistics, getTimeOfLastMessageAck, incrementConsumedCount, isBrowser, isSlowConsumer, isWildcard, matches, matches, removeDestination, resetConsumedCount, setCursorMemoryHighWaterMark, setObjectName, setSelector, setSlowConsumer, setTimeOfLastMessageAck, unmatched
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
destroy
protected PendingMessageCursor pending
protected final List<MessageReference> dispatched
protected final AtomicInteger prefetchExtension
protected boolean usePrefetchExtension
protected final SystemUsage usageManager
protected final Object pendingLock
protected final Object dispatchLock
public PrefetchSubscription(Broker broker, SystemUsage usageManager, ConnectionContext context, ConsumerInfo info, PendingMessageCursor cursor) throws javax.jms.JMSException
javax.jms.JMSException
public PrefetchSubscription(Broker broker, SystemUsage usageManager, ConnectionContext context, ConsumerInfo info) throws javax.jms.JMSException
javax.jms.JMSException
public Response pullMessage(ConnectionContext context, MessagePull pull) throws Exception
Exception
public void add(MessageReference node) throws Exception
Subscription
Exception
InterruptedException
IOException
public void processMessageDispatchNotification(MessageDispatchNotification mdn) throws Exception
Subscription
Exception
public final void acknowledge(ConnectionContext context, MessageAck ack) throws Exception
Subscription
acknowledge
in interface Subscription
acknowledge
in class AbstractSubscription
IOException
Exception
protected void assertAckMatchesDispatched(MessageAck ack) throws javax.jms.JMSException
ack
- javax.jms.JMSException
- if it does not matchprotected void sendToDLQ(ConnectionContext context, MessageReference node, Throwable poisonCause) throws IOException, Exception
context
- node
- poisonCause
- IOException
Exception
public int getInFlightSize()
public boolean isFull()
public boolean isLowWaterMark()
public boolean isHighWaterMark()
public int countBeforeFull()
countBeforeFull
in interface Subscription
countBeforeFull
in class AbstractSubscription
public int getPendingQueueSize()
public long getPendingMessageSize()
public int getDispatchedQueueSize()
public long getDequeueCounter()
public long getDispatchedCounter()
public long getEnqueueCounter()
public boolean isRecoveryRequired()
Subscription
isRecoveryRequired
in interface Subscription
isRecoveryRequired
in class AbstractSubscription
PendingMessageCursor
public PendingMessageCursor getPending()
public void setPending(PendingMessageCursor pending)
public void add(ConnectionContext context, Destination destination) throws Exception
Subscription
add
in interface Subscription
add
in class AbstractSubscription
Exception
public List<MessageReference> remove(ConnectionContext context, Destination destination) throws Exception
Subscription
remove
in interface Subscription
remove
in class AbstractSubscription
Exception
public List<MessageReference> remove(ConnectionContext context, Destination destination, List<MessageReference> dispatched) throws Exception
Exception
public void dispatchPending() throws IOException
IOException
protected void setPendingBatchSize(PendingMessageCursor pending, int numberToDispatch)
protected boolean dispatch(MessageReference node) throws IOException
IOException
protected void onDispatch(MessageReference node, Message message)
public void updateConsumerPrefetch(int newPrefetch)
newPrefetch
- protected MessageDispatch createMessageDispatch(MessageReference node, Message message)
node
- message
- protected abstract boolean canDispatch(MessageReference node) throws IOException
node
- IOException
protected abstract boolean isDropped(MessageReference node)
protected abstract void acknowledge(ConnectionContext context, MessageAck ack, MessageReference node) throws IOException
IOException
public int getMaxProducersToAudit()
public void setMaxProducersToAudit(int maxProducersToAudit)
public int getMaxAuditDepth()
public void setMaxAuditDepth(int maxAuditDepth)
public boolean isUsePrefetchExtension()
public void setUsePrefetchExtension(boolean usePrefetchExtension)
protected int getPrefetchExtension()
public void setPrefetchSize(int prefetchSize)
setPrefetchSize
in class AbstractSubscription
Copyright © 2005–2016 The Apache Software Foundation. All rights reserved.