IBM MQ C++ classes

The IBM MQ C++ classes encapsulate the IBM 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 IBM MQ data-structure members (see C++ and MQI cross-reference ). For detailed descriptions, see Attributes of objects.
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 API reason codes ) that can be expected from those methods that fail. For an exhaustive list of reason codes that can occur for an object of a class, consult the parent class documentation. The documented list of reason codes for a class does not include the reason codes for parent classes.

Note:

Objects of these classes are not thread-safe. This ensures optimal performance, but take care not to access any object from more than one thread.
It is recommended that, for a multithreaded program, a separate ImqQueueManager object is used for each thread. Each manager object must have its own independent collection of other objects, ensuring that objects in different threads are isolated from one another.

The classes are:

C++ and MQI cross-reference
This collection of topics contains information relating C++ to the MQI.
ImqAuthenticationRecord C++ class
This class encapsulates an authentication information record (MQAIR) for use during execution of the ImqQueueManager::connect method, for custom TLS client connections.
ImqBinary C++ class
This class encapsulates a binary byte array that can be used for ImqMessage accounting token, correlation id, and message id values. It allows easy assignment, copying, and comparison.
ImqCache C++ class
Use this class to hold or marshal data in memory.
ImqChannel C++ class
This class encapsulates a channel definition (MQCD) for use during execution of the Manager::connect method, for custom client connections.
ImqCICSBridgeHeader C++ class
This class encapsulates specific features of the MQCIH data structure.
ImqDeadLetterHeader C++ class
This class encapsulates features of the MQDLH data structure.
ImqDistributionList C++ class
This class encapsulates a dynamic distribution list that references one or more queues for the purpose of sending a message or messages to multiple destinations.
ImqError C++ class
This abstract class provides information on errors associated with an object.
ImqGetMessageOptions C++ class
This class encapsulates the MQGMO data structure
ImqHeader C++ class
This abstract class encapsulates common features of the MQDLH data structure.
ImqIMSBridgeHeader C++ class
This class encapsulates features of the MQIIH data structure.
ImqItem C++ class
This abstract class represents an item, perhaps one of several, within a message.
ImqMessage C++ class
This class encapsulates an MQMD data structure and also handles the construction and reconstruction of message data.
ImqMessageTracker C++ class
This class encapsulates those attributes of an ImqMessage or ImqQueue object that can be associated with either object.
ImqNamelist C++ class
This class encapsulates a namelist.
ImqObject C++ class
This class is abstract. When an object of this class is destroyed, it is automatically closed, and its ImqQueueManager connection severed.
ImqProcess C++ class
This class encapsulates an application process (an IBM MQ object of type MQOT_PROCESS) that can be triggered by a trigger monitor.
ImqPutMessageOptions C++ class
This class encapsulates the MQPMO data structure.
ImqQueue C++ class
This class encapsulates a message queue (an IBM MQ object of type MQOT_Q).
ImqQueueManager C++ class
This class encapsulates a queue manager (an IBM MQ object of type MQOT_Q_MGR).
ImqReferenceHeader C++ class
This class encapsulates features of the MQRMH data structure.
ImqString C++ class
This class provides character string storage and manipulation for null-terminated strings.
ImqTrigger C++ class
This class encapsulates the MQTM (trigger message) data structure.
ImqWorkHeader C++ class
This class encapsulates specific features of the MQWIH data structure.

Parent topic: Developing applications reference