tibemsConsumerInfo_GetDetailedStatistics

Function

Purpose

Get detailed statistics for a wildcarded consumer.

C Declaration

tibems_status tibemsConsumerInfo_GetDetailedStatistics(
   tibemsConsumerInfo consumerInfo,
   tibemsCollection* collection);

COBOL Call

CALL "tibemsConsumerInfo_GetDetailedStatistics"
 USING BY VALUE consumerInfo,
       BY REFERENCE  collection,
       RETURNING tibems-status
END-CALL.
Note: collection has usage pointer.

Parameters

Parameter Description
consumerInfo Get statistics for this consumer.
collection Store the collection of tibemsDetailedDestStat objects in this location.

Remarks

Return detailed statistics for the consumer, giving a breakdown of the consumer's aggregate statistics across all destinations that it has received messages on.

This function returns NULL when there are no detailed statistics available for the consumer. This can happen for any of the following reasons:

  • The consumer is not a wildcarded consumer.
  • Detailed statistics are disabled in the server.
  • Detailed statistics were not included into this consumerInfo object by the function tibemsAdmin_GetConsumers that was used to obtain the object.

See Also

tibemsAdmin_GetConsumers

tibemsCollection