IMQI.HPP header file, multiple, threads, multithreaded program" /> WebSphere MQ C++ classes

 

WebSphere MQ C++ classes

 

The WebSphere MQ C++ classes encapsulate the WebSphere MQ Message Queue Interface (MQI). There is a single C++ header file, imqi.hpp, which covers all of these classes.

For each class, the following information is shown:

Class hierarchy diagram

A class diagram showing the class in its inheritance relation to its immediate parent classes, if any.

Other relevant classes

Document links to other relevant classes, such as parent classes, and the classes of objects used in method signatures.

Object attributes

Attributes of the class. These are in addition to those attributes defined for any parent classes. Many attributes reflect WebSphere MQ data-structure members (see Appendix B. MQI cross reference). For detailed descriptions, see the WebSphere MQ Application Programming Reference.

Constructors

Signatures of the special methods used to create an object of the class.

Object methods (public)

Signatures of methods that require an instance of the class for their operation, and that have no usage restrictions.

Where it applies, the following information is also shown:

Class methods (public)

Signatures of methods that do not require an instance of the class for their operation, and that have no usage restrictions.

Overloaded (parent class) methods

Signatures of those virtual methods that are defined in parent classes, but exhibit different, polymorphic, behavior for this class.

Object methods (protected)

Signatures of methods that require an instance of the class for their operation, and are reserved for use by the implementations of derived classes. This section is of interest only to class writers, as opposed to class users.

Object data (protected)

Implementation details for object instance data available to the implementations of derived classes. This section is of interest only to class writers, as opposed to class users.

Reason codes

MQRC_* values (see WebSphere MQ Messages) that can be expected from those methods that fail. For an exhaustive list of reason codes that can occur for an object of a given class, consult the parent class documentation. The documented list of reason codes for a given class does not include the reason codes for parent classes.
Notes:

  1. Objects of these classes are not thread-safe. This ensures optimal performance, but take care not to access any given object from more than one thread.

  2. For a multithreaded program, use a separate Manager object for each thread. WebSphere MQ requires a separate queue manager connection for each thread, and does not permit cross-thread operations. Each Manager object must have its own independent collection of and other objects, ensuring that objects in different threads are isolated from one another.

The classes are: