QueueMessageCount Property
The message count returned by various queue operations.
Syntax
amqpclassic.getQueueMessageCount([callback])
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getQueueMessageCount([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setQueueMessageCount([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property is populated with a message count after calling certain queue-related methods.
After calling... | This property will reflect... |
DeclareQueue | The number of messages currently in the queue. |
PurgeQueue | The number of messages purged from the queue. |
DeleteQueue | THe number of messages deleted along with the queue. |
This property is read-only and not available at design time.
Data Type
Integer