« Back to Product

Documentation

IPS_GetInstanceMessageQueueSize

 int IPS_GetInstanceMessageQueueSize ()

Returns

Number of not yet completely processed messages to instances

Description

Warning

This function is intended for internal use only and may change or be removed at any time without notice.

The function returns the number of messages that are to be delivered to instances and have not yet been completely processed by their MessageSink. A message to several instances counts once per instance. In normal operation the value is 0 or very small. A permanently rising value indicates that instances process messages more slowly than they arrive. Which instances are affected can be determined with IPS_GetInstanceMessageStatistics.

The function is available independently of the special switch "MessageQueueWatch".

Example

echo IPS_GetInstanceMessageQueueSize(); // e.g. returns 0
Any questions?