|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PendingMessageCursor
Interface to pending message (messages awaiting disptach to a consumer) cursor
Method Summary | |
---|---|
void |
add(ConnectionContext context,
Destination destination)
Add a destination |
void |
addMessageFirst(MessageReference node)
add message to await dispatch |
void |
addMessageLast(MessageReference node)
add message to await dispatch |
void |
addRecoveredMessage(MessageReference node)
Add a message recovered from a retroactive policy |
void |
clear()
clear all pending messages |
void |
destroy()
destroy the cursor |
void |
gc()
free up any internal buffers |
int |
getMaxAuditDepth()
|
int |
getMaxBatchSize()
|
int |
getMaxProducersToAudit()
|
int |
getMemoryUsageHighWaterMark()
|
ActiveMQMessageAudit |
getMessageAudit()
|
SystemUsage |
getSystemUsage()
|
boolean |
hasMessagesBufferedToDeliver()
|
boolean |
hasNext()
|
boolean |
hasSpace()
|
boolean |
isEmpty()
|
boolean |
isEmpty(Destination destination)
check if a Destination is Empty for this cursor |
boolean |
isEnableAudit()
|
boolean |
isFull()
|
boolean |
isRecoveryRequired()
Informs the Broker if the subscription needs to intervention to recover it's state e.g. |
boolean |
isTransient()
|
boolean |
isUseCache()
|
MessageReference |
next()
|
LinkedList<MessageReference> |
pageInList(int maxItems)
Page in a restricted number of messages and increment the reference count |
void |
release()
hint to the cursor to release any locks it might have grabbed after a reset |
void |
remove()
remove the message at the cursor position |
List<MessageReference> |
remove(ConnectionContext context,
Destination destination)
remove a destination |
void |
remove(MessageReference node)
remove a node |
void |
reset()
reset the cursor |
void |
resetForGC()
Give the cursor a hint that we are about to remove messages from memory only |
void |
rollback(MessageId id)
remove from auditing the message id |
void |
setEnableAudit(boolean enableAudit)
|
void |
setMaxAuditDepth(int depth)
Set the maximum depth of message ids to track |
void |
setMaxBatchSize(int maxBatchSize)
Set the max batch size |
void |
setMaxProducersToAudit(int value)
set the maximum number of producers to track at one time |
void |
setMemoryUsageHighWaterMark(int memoryUsageHighWaterMark)
|
void |
setMessageAudit(ActiveMQMessageAudit audit)
set the audit |
void |
setSystemUsage(SystemUsage systemUsage)
Set the UsageManager |
void |
setUseCache(boolean useCache)
use a cache to improve performance |
int |
size()
|
Methods inherited from interface org.apache.activemq.Service |
---|
start, stop |
Method Detail |
---|
void add(ConnectionContext context, Destination destination) throws Exception
context
- destination
-
Exception
List<MessageReference> remove(ConnectionContext context, Destination destination) throws Exception
context
- destination
-
Exception
boolean isEmpty()
boolean isEmpty(Destination destination)
destination
-
void reset()
void release()
void addMessageLast(MessageReference node) throws Exception
node
-
IOException
Exception
void addMessageFirst(MessageReference node) throws Exception
node
-
Exception
void addRecoveredMessage(MessageReference node) throws Exception
node
-
Exception
boolean hasNext()
MessageReference next()
void remove()
int size()
void clear()
boolean isRecoveryRequired()
int getMaxBatchSize()
void setMaxBatchSize(int maxBatchSize)
maxBatchSize
- void resetForGC()
void remove(MessageReference node)
node
- void gc()
void setSystemUsage(SystemUsage systemUsage)
systemUsage
- SystemUsage
SystemUsage getSystemUsage()
int getMemoryUsageHighWaterMark()
void setMemoryUsageHighWaterMark(int memoryUsageHighWaterMark)
memoryUsageHighWaterMark
- the memoryUsageHighWaterMark to setboolean isFull()
boolean hasSpace()
boolean hasMessagesBufferedToDeliver()
void destroy() throws Exception
Exception
LinkedList<MessageReference> pageInList(int maxItems)
maxItems
-
void setMaxProducersToAudit(int value)
value
- int getMaxProducersToAudit()
void setMaxAuditDepth(int depth)
depth
- int getMaxAuditDepth()
boolean isEnableAudit()
void setEnableAudit(boolean enableAudit)
enableAudit
- the enableAudit to setboolean isTransient()
void setMessageAudit(ActiveMQMessageAudit audit)
audit
- ActiveMQMessageAudit getMessageAudit()
void setUseCache(boolean useCache)
useCache
- boolean isUseCache()
void rollback(MessageId id)
id
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |