> tibemsStatData
> Type
> Purpose
> Represent statistical data about another object, such as a topic or queue.
> Remarks
> Statistical data contains the total number of messages and their cumulative size. It can also provide message rates, as the number of messages sent each second second and number of bytes each second. Whether or not rate information is available is controlled by the server configuration. If rate collection is turned off, all rate numbers are set to 0. However, in those cases the application can calculate the rates based on absolute numbers taken at periodic intervals.

> Function | Description | Page
> tibemsStatData_GetByteRate | Get the average rate of bytes sent or received each second. | 492
> tibemsStatData_GetMessageRate | Get the rate of messages sent or received each second. | 493
> tibemsStatData_GetTotalBytes | Get the total size of messages sent or received each second. | 494
> tibemsStatData_GetTotalMessages | Get the total number of messages sent or received each second. | 495

> Related Types
> tibemsQueue on page 150
> tibemsTopic on page 156
> tibemsConsumerInfo on page 437
> tibemsProducerInfo on page 462
> tibemsQueueInfo on page 470
> tibemsTopicInfo on page 496
> tibemsStatData_GetByteRate
> Function
> Purpose
> Get the average rate of bytes sent or received each second.
> C Declaration
> tibems_status tibemsStatData_GetByteRate(
> tibemsStatData statData,
> tibems_long* byteRate);
> COBOL Call
> CALL "tibemsStatData_GetByteRate"
> USING BY VALUE statData,
> BY REFERENCE rate_size,
> RETURNING tibems-status
> END-CALL.
> Parameters

> Parameter | Description
> statData | Get the rate for this message consumer, producer, topic, or queue.
> byteRate | The function stores the average byte rate in this location.

> Remarks
> This function gets the average byte rate for messages sent or received per second. For message consumers, this rate reflects the number of messages received by the consumer. For messages producers, it is the rate of messages sent, and for topics and queues the rate includes both inbound and outbound messages.
> tibemsStatData_GetMessageRate
> Function
> Purpose
> Get the rate of messages sent or received each second.
> C Declaration
> tibems_status tibemsStatData_GetMessageRate(
> tibemsStatData statData,
> tibems_long* messageRate);
> COBOL Call
> CALL "tibemsStatData_GetMessageRate"
> USING BY VALUE statData,
> BY REFERENCE rate_msgs,
> RETURNING tibems-status
> END-CALL.
> Parameters

> Parameter | Description
> statData | Get the rate for this message consumer, producer, topic, or queue.
> messageRate | The function stores the average message rate in this location.

> Remarks
> This function gets the average number of messages sent or received per second. For message consumers, this rate reflects the number of messages received by the consumer. For messages producers, it is the rate of messages sent, and for topics and queues the rate includes both inbound and outbound messages.
> tibemsStatData_GetTotalBytes
> Function
> Purpose
> Get the total size of messages sent or received each second.
> C Declaration
> tibems_status tibemsStatData_GetTotalBytes(
> tibemsStatData statData,
> tibems_long* bytes);
> COBOL Call
> CALL "tibemsStatData_GetTotalBytes"
> USING BY VALUE statData,
> BY REFERENCE size,
> RETURNING tibems-status
> END-CALL.
> Parameters

> Parameter | Description
> statData | Get the total message size for this consumer, producer, topic, or queue.
> bytes | The function stores the size of messages in this location.

> Remarks
> This function gets the total size of messages sent or received. For message consumers, this is the size of messages received by the consumer. For messages producers, it is the size of messages sent, and for topics and queues the size includes both inbound and outbound messages.
> tibemsStatData_GetTotalMessages
> Function
> Purpose
> Get the total number of messages sent or received each second.
> C Declaration
> tibems_status tibemsStatData_GetTotalMessages(
> tibemsStatData statData,
> tibems_long* messages);
> COBOL Call
> CALL "tibemsStatData_GetTotalMessages"
> USING BY VALUE statData,
> BY REFERENCE msgs,
> RETURNING tibems-status
> END-CALL.
> Parameters

> Parameter | Description
> statData | Get the total number of messages for this consumer, producer, topic, or queue.
> messages | The function stores the number of messages in this location.

> Remarks
> This function gets the total number of messages sent or received. For message consumers, this is the number of messages received by the consumer. For messages producers, it is the number of messages sent, and for topics and queues the number includes both inbound and outbound messages.

Copyright © TIBCO Software Inc. All Rights Reserved.