HawkListener:getDurables

Method

Purpose

This method (on all platforms) gets information on durables on this server.

Note 

As this method is deprecated, use the method getConsumers instead.

Remarks

The durableRegExp 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.

Type

Synchronous, IMPACT_INFO

Arguments

 

Name

Type

Description

durableRegExp

String

Durable Name. Empty argument string provides information on all durables.

Returns

 

Name

Type

Description

name

String

Name of this durable

topicName

String

Name of the topic that this durable subscribes to

active

Boolean

The flag passed to indicate whether the durable is connected

clientID

String

Client ID associated with this durable

consumerID

Long

The value indicating the ID of consumer

userName

String

Name of the user, if active, connected, and authenticated

pendingMessageSize

Long

The value indicating the total size, in bytes, of messages waiting to be delivered to this durable

pendingMessageCount

Long

The value indicating the number of messages waiting to be delivered to this durable

deliveredMessageCount

Long

The value indicating the number of delivered messages

noLocalEnabled

Boolean

The flag passed to indicate whether the durable will not receive messages published on its own connection

static

Boolean

The flag passed to indicate whether the durable is statically defined