tibemsConsumerInfo consumerInfo);
USING BY VALUE consumerInfo,
|
|
|
The consumerInfo object to be destroyed.
|
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
This function gets the number of messages sent to but not yet acknowledged by the consumer. For topic consumers, this number is included in the number of pending messages returned by
tibemsConsumerInfo_GetPendingMessageCount.
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
This function gets the combined size of messages sent to consumer and not yet acknowledged by consumer's session. For topic consumers this size is included into the combined size of pending messages returned by
tibemsConsumerInfo_GetPendingMessageSize.
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
tibemsConsumerInfo consumerInfo,
tibemsDestinationType* type);
USING BY VALUE consumerInfo,
tibemsConsumerInfo consumerInfo,
tibemsCollection* collection);
USING BY VALUE consumerInfo,
Returns 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:
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
BY REFERENCE durableName,
This function returns the name of the consumer's durable subscription. Only durable topic consumers have a durable name. The function returns
NULL if the consumer is a non-durable topic subscriber or a queue receiver.
tibems_status tibemsConsumerInfo_GetElapsedSinceLastAcknowledged(
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
This function gets the approximate number of milliseconds that have elapsed since last time a message sent to this consumer was acknowledged by consumer's session. This value, while returned in milliseconds, has a precision of 1 second. This value should be used for informational purposes only. For example, it can be used to identify consumers which receive messages but do not acknowledge them for some reason.
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
This function gets the approximate number of milliseconds that have elapsed since last time the server sent a message to this consumer. The value returned, while given in milliseconds, has a precision of 1 second. It should be used for informational purposes only.
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
This function can be used to retrieve the number of pending messages for a topic consumer only. For queue consumers, the number of pending messages in the corresponding queue must be obtained from the queue. If the consumer is a queue consumer, the function returns
0 (zero).
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
This function can be used to retrieve the combined size of the pending messages for a topic consumer. If the consumer is a queue consumer, the function returns
0 (zero).
tibemsConsumerInfo consumerInfo,
tibemsStatData* statData);
USING BY VALUE consumerInfo,
This function returns NULL when there are no statistics available for the consumer. This can happen for any of the following reasons:
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
This function returns total number of messages the server sent to this consumer since consumer was created. This value include duplicates of messages that were resent after a consumer's session recovery or rollback. Therefore, the count may not represent true number of unique messages received by this consumer and should be used only for statistical and informational purposes.
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
If the consumer is active, the active status is
TRUE. Otherwise,
active is
FALSE. A consumer is active if the server can send messages to it. Only queue consumers which have never called a receive function remain in inactive state.
Queue consumers which called have called tibemsMsgConsumer_Receive,
tibemsMsgConsumer_ReceiveNoWait, or
tibemsMsgConsumer_ReceiveTimeout at least once or are configured with a message callback, and all topic consumers are always active. This function can identify inactive queue consumers which have never called a receive function which and have never received any messages from the server, even when pending messages exist in the corresponding queue.
tibemsConsumerInfo consumerInfo,
USING BY VALUE consumerInfo,
The connection status will be set to TRUE if this consumer is connected to the server, and
FALSE otherwise. Only durable topic subscribers may be in a disconnected state. This function always sets the connection status to
TRUE for queue receivers and non-durable topic consumers.
tibemsConsumerInfo consumerInfo,
tibems_bool* connectionConsumer);
USING BY VALUE consumerInfo,
BY REFERENCE connectionConsumer,
Sets the connection status to TRUE if the consumer is a connection consumer, and
FALSE otherwise. Notice that for disconnected durable topic subscribers the function returns
FALSE even if the durable was created as connection consumer.