Collapse All Expand All Members: Show All Members: Filtered Members: Filtered Members: Filtered

Include Protected Members
Include Inherited Members

.NET Framework Class Library
ConsumerInfo..::.Details Class Methods Properties See Also

[TIBCO.EMS .NET Admin client library 5.1 documentation]

A ConsumerInfo object represents a message consumer. GetConsumers()()()

The ConsumerInfo..::.Details type exposes the following members.

# Methods

| Name | Description
--- | --- | ---
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
| GetCurrentMsgCountSentByServer | Returns number of messages sent to consumer and not yet acknowledged by consumer's session. For topic consumers this number is included into the number of pending messages returned by {GetPendingMessageCount()()()}.
| GetCurrentMsgSizeSentByServer | Returns 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 {GetPendingMessageSize()()()}.
| GetDestinationPrefetch | Returns destination prefetch value. This returns actual destination prefetch value used by the server at run time. Return value is a positive prefetch value or {PREFETCH_NONE} which is available for queues.
| GetElapsedSinceLastAcknowledged | Returns number of milliseconds 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. It can be used, for example, to identify consumers which receive messages but do not acknowledge them for some reason, etc.
| GetElapsedSinceLastSent | Returns number of milliseconds elapsed since last time the server sent a message to this consumer. This value, while returned in milliseconds, has a precision of 1 second. It should be used for informational purposes only.
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.)
| GetPrefetchDelivered | Returns number of prefetch messages delivered to consumer by the server. This value should be ignored for consumers on no-prefetch queues. For consumers receiving messages on any destination with positive prefetch value, this value is never more than the prefetch value of the destination. While normally this value cannot be used to identify the status of the consumer, it can be used in conjunction with other consumer information values to identify consumers who stopped receiving messages due to application-specific problems.
| GetRouteName | Returns queue owner's server name if this consumer's destination is a routed queue. Returns null for topic consumers and for queue consumers receiving messages from queues local to the server.
| GetSessionAcknowledgeMode | Returns consumer's session acknowledge mode as a constant defined in {Admin}.
| GetTotalAcknowledgedCount | Returns total number of messages which were delivered to this consumer and have been acknowledged by consumer's session. This value should be used for informational purposes only.
| GetTotalMsgCountSentByServer | Returns total number of messages the server sent to this consumer since consumer was created. This value includes resends of the same message due to consumer's session recover or rollback. This value does not represent true number of unique messages received by this consumer and should be used only for statistical and informational purposes.
| GetType | Gets the Type of the current instance. (Inherited from Object.)
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.)
| ToString | Returns string representation of this object. (Overrides Object..::.ToString()()().)

# Properties

| Name | Description
--- | --- | ---
| Active | Returns true if this consumer is active. Active consumers are consumers to which the server can send messages to. Only queue consumers which never called Receive() remain in inactive state. Queue consumers which called Receive() at least once or are configured with the message callback, and all topic consumers are always active. This method can identify inactive queue consumers which never called Receive() and, while present, never receive any messages from the server even in presence of pending messages in corresponding queue.
| System | Returns true if this consumer has been created automatically by the system. If this method returns false, this consumer has been created by user application. If this method returns true this consumer has been created automatically by the system. There are several types of consumers the system may create automatically.

# See Also

ConsumerInfo..::.Details Class
TIBCO.EMS.ADMIN Namespace