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

Include Protected Members
Include Inherited Members

.NET Framework Class Library
ConsumerInfo Class Methods Properties See Also

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

The ConsumerInfo 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.)
| GetDetails | Returns additional details about this consumer or null. This method returns null if this object has been obtained via {GetConsumersStatistics(Int64, String, DestinationInfo)} method. If this consumer was obtained via methods {GetConsumers()()()} or {GetConsumer(Int64)}, this method returns non-null value containing detailed information about consumer.
| 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.)
| GetPendingMessageCount | Returns number of pending messages for a topic consumer. Notice that only topic consumers have pending messages. For queue consumers the number of pending messages in the corresponding queue must be obtained via the queue itself.
| GetPendingMessageSize | Returns combined size of pending messages for a topic consumer.
| GetSelector | Returns consumer's selector or null. Notice that ConsumerInfo may or may not have the consumer's selector information depending on the way it was obtained, however method {HasSelector()()()} can be called in all cases to determine if consumer has a selector. Method {GetConsumer(Int64)} always includes the selector text, if present, into returned consumer object. Methods returning multiple consumers include or do not include selector text depending on the flag {GET_SELECTOR}.
| GetType | Gets the Type of the current instance. (Inherited from Object.)
| HasSelector | Returns true if this consumer has selector. Notice the selector itself may or may not be contained in the consumer object, depending on the way consumer information was obtained. However this method can be used in all cases to determine if a consumer has selector. Method {GetConsumer(Int64)} always includes the selector text, if present, into returned consumer object. Methods returning multiple consumers include or do not include selector text depending on the flag {GET_SELECTOR}.
| isConnected | Returns true if this consumer is connected to the server. Only durable topic subscribers may be in disconnected state. This method always returns true for queue receivers and non-durable topic consumers.
| isConnectionConsumer | Returns true if this is connection consumer. Notice that for disconnected durable topic subscribers this method returns false even if the durable has been originally created as connection consumer.
| isMulticast | Returns true if this is a multicast topic consumer.
| isNolocal | Returns true if this is a nolocal topic consumer.
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.)
| ToString | Returns a String that represents the current Object (Overrides Object..::.ToString()()().)

# Properties

| Name | Description
--- | --- | ---
| ConnectionID | Return the consumer's connection ID or 0. If this is a durable topic subscriber which is currently not connected, this method returns 0, which is never a valid connection ID.
| CreateTime | Returns consumer's creation time in milliseconds.
| DestinationName | Returns consumer's destination name.
| DestinationType | Returns consumer's destination type. Returned value is one of {Queue} or {Topic}.
| DetailedStatistics | Returns consumer's detailed statistics.
| DurableName | Returns the name of the consumer's durable subscription or null Only durable topic consumers have durable name. This method returns null for non-durable topic subscribers and queue receivers.
| ID | Returns consumer ID. All consumers have a unique ID
| SessionID | Returns consumer's session ID or 0. If this is a durable topic subscriber which is currently not connected, this method returns 0, which is never a valid session ID
| Statistics | Returns consumer's total statistics.
| Username | Returns consumer's user name or null. This method returns null for disconnected durable subscribers.

# See Also

ConsumerInfo Class
TIBCO.EMS.ADMIN Namespace