HawkListener:getTopics
Method
Purpose
This method (on all platforms) gets information on topics on this server.
Remarks
The topicRegExp argument is a pattern match using regular expressions. Test any regular expressions you plan to use in rulebases by first using them interactively to ensure they return the desired results.The cursorInitialPosition and cursorSize arguments allows to return only a set number of topics instead of all topics.
Type
Synchronous, IMPACT_INFO
Arguments
Name |
Type |
Description |
topicRegExp |
String |
Topic Name. Empty argument string provides information on all topics. |
topicType |
String |
Topic type. Empty argument string provides information on all topics. |
cursorInitialPosition |
Integer |
Initial position of the cursor. |
cursorSize |
Integer |
Size of the cursor to determine the number of topics to return. |
Returns
Name |
Type |
Description |
name |
String |
Name of this topic |
description |
String |
Description of this topic |
pendingMessageSize |
Long |
The value indicating the total size for all pending messages for this topic |
pendingMessageSizeUsage |
Double |
The value indicating the total size as a fraction of maxBytes for this topic |
pendingMessageCount |
Long |
The value indicating the total number of pending messages for this topic |
pendingMessageCountUsage |
Double |
The value indicating the total number of pending messages as a fraction of maxMsgs for this topic |
consumerCount |
Integer |
Number of consumers for this topic |
subscriberCount |
Integer |
Number of subscribers for this topic |
subscriptionCount |
Integer |
Number of subscription for this topic. For EMS 8.0, due to the shared subscription feature (between subscribers) in the jms-2.0 specifications, the value of The field is visible only if you specify EMS version 8.0 in the |
durableCount |
Integer |
Number of durable subscribers for this topic |
durableSubscriptionCount |
Integer |
Number of durable subscriptions for this topic. For EMS 8.0, due to the shared subscription feature (between subscribers) in the jms-2.0 specifications, the value of The field is visible only if you specify EMS version 8.0 in the |
activeDurableCount |
Integer |
Number of active durable subscribers for this topic |
expiryOverride |
Long |
The value indicating the expiry override property |
Boolean |
The flag passed to indicate whether the topic is failsafe |
|
flowControl |
Long |
The value indicating the target max size of pending messages in bytes before flow control starts |
global |
Boolean |
The flag passed to indicate whether the topic is global |
hasSenderName |
Boolean |
The flag passed to indicate whether the sender_name property is set |
maxBytes |
Long |
The value indicating the maximum number of message bytes that the server will store for pending messages bound for this topic |
Long |
The value indicating the maximum number of messages that the server will store for pending messages bound for this topic |
|
overflowPolicy |
String |
Overflow policy for this topic |
secure |
Boolean |
The flag passed to indicate whether the topic is secure |
senderNameEnforced |
Boolean |
The flag passed to indicate whether the sender_name_enforced property is set |
static |
Boolean |
The flag passed to indicate whether the topic is static |
temporary |
Boolean |
The flag passed to indicate whether the topic is temporary |
channel |
String |
Multicast channel for this topic |
outboundByteRate |
Long |
The value indicating the outbound bytes per second |
outboundMessageRate |
Long |
The value indicating the outbound messages per second |
outboundTotalBytes |
Long |
The value indicating the outbound total bytes |
outboundTotalMessages |
Long |
The value indicating the outbound total messages |
inboundByteRate |
Long |
The value indicating the inbound bytes per second |
inboundMessageRate |
Long |
The value indicating the inbound messages per second |
Long |
The value indicating the inbound total bytes |
|
inboundTotalMessages |
Long |
The value indicating the inbound total messages |