WebSphere Message Service Client for C/C++, Version 2.0.2 Operating Systems: AIX, Linux, Solaris, Windows

ConnectionMetaData

Inheritance hierarchy:
xms::PropertyContext
   |
   +----xms::ConnectionMetaData

A ConnectionMetaData object provides information about a connection.

For a list of the XMS defined properties of a ConnectionMetaData object, see Properties of ConnectionMetaData.

Methods

Summary of methods:
Method Description
getHandle Get the handle that a C application would use to access the connection metadata.
getJMSXProperties Get a list of the names of the JMS defined message properties supported by the connection.
isNull Determine whether the ConnectionMetaData object is a null object.

getHandle – Get Handle

Interface:
xmsHConnMetaData getHandle() const;

Get the handle that a C application would use to access the connection metadata.

Parameters:
None
Returns:
The handle for the connection metadata.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getJMSXProperties – Get JMS Defined Message Properties

Interface:
Iterator getJMSXProperties() const;

Get a list of the names of the JMS defined message properties supported by the connection.

The method returns an iterator that encapsulates a list of Property objects, where each Property object encapsulates the name of a JMS defined message property. The application can then use the iterator to retrieve the name of each JMS defined message property in turn.

JMS defined message properties are not supported by a real-time connection to a broker.

Note: The equivalent JMS method performs a slightly different function. The JMS method returns an enumeration of the names of the JMS defined message properties.
Parameters:
None
Returns:
The Iterator object.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

isNull – Check Whether Null

Interface:
xmsBOOL isNull() const;

Determine whether the ConnectionMetaData object is a null object.

Parameters:
None
Returns:
  • xmsTRUE, if the ConnectionMetaData object is a null object.
  • xmsFALSE, if the ConnectionMetaData object is not a null object.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Inherited methods


Reference topic

Terms of Use | Rate this page

Last updated: 24 May 2011

(C) Copyright IBM Corporation 2005, 2011. All Rights Reserved.