MSMQWrappers v1.10

Welcome to MSMQWrappers, a set of C++ classes to provide a complete C++ encapsulation of MSMQ (Microsoft Message Queuing).

The classes provided are: MSMQ::CCursor, MSMQ::CQueue, CMSMQ::CSearch, MSMQ::CSecurityContext, ATL::CComPropVariant, ATL::ComPropVariant2, & MSMQ::CPropVariantAutoFree.

CCursor provides a class based encapsulation of a cursor as returned via MQCreateCursor.

CQueue provides a class based encapsulation of a queue as returned via MQOpenQueue.

CSearch provides a class based encapsulation of a search as returned via MQLocateBegin.

CSecurityContext provides a class based encapsulation of a security context as returned via MQGetSecurityContextEx.

CComPropVariant provides a class based encapsulation of a SDK PROPVARIANT structure with automatic lifetime management of the resources which a PROPVARIANT can contain. Internally MSMQ makes extensive use of this structure which is similar to the good old COM VARIANT structure. I would have expected there to be a built in ATL class to do this wrapping but there isn't one I could find. This class is modeled upon the ATL CComVariant class and as such I decided to put it in the "ATL" namespace instead of "MSMQ". This class is self contained in its own right and should prove useful in ATL COM development when dealing with the PROPVARIANT structure.

CComPropVariant2 is similar to CComPropVariant except that the lifetime management of the resources which the PROPVARIANT can contain is left up to client code to manage. This is the memory model primarily adopted by MSMQ. Similar to CComPropVariant class, it makes initializing the VARTYPE and various union elements of a PROPVARIANT much easier to code and understand.

CPropVariantAutoFree is another wrapper for the PROPVARIANT structure which provides automatic cleanup of memory allocated via MSMQ via MQFreeMemory in its destructor. Again this C++ encapsulation reduces the amount of boilerplate code you need to write when programming to the MSMQ API. For various examples of using this class in addition to the CComPropVariant(2) classes please see the MSMQDemo.cpp source code module.

Going forward I may add additional wrapper classes to make dealing with the various array structures such as MQQUEUEPROPS, MQMSGPROPS, MQMGMTPROPS etc used in MSMQ easier to program to as well as reducing the boilerplate code required to setup each of these structures. Please let me know your thoughts on this. The development of MSMQWrappers took a number of weeks of hard work researching, developing and testing and hopefully you should find them useful in your C++ MSMQ programming efforts.

Features

• Provides two simple C++ Header only modules to easily encapsulate MSMQ.
• Integrates with STL's string classes for easier client coding.
• Should make it easier to use MSMQ from C++ going forward.

Usage

• To use the various MSMQWrappers classes in your project simply #include MSMQWrappers.h and PropVariantWrapper.h the test application in your application.
• The classes are only supported on VC 2017 or later.
• Included in the download is a VC 2017 console based application which exercises all of the various classes functionality. You will of course need to have MSMQ installed on your machine. To fully exercise some of the functionality in the demo app you will need to have your computer joined to a corporate AD environment.

Copyright

• You are allowed to include the source code in any product (commercial, shareware, freeware or otherwise) when your product is released in binary form.
• You are allowed to modify the source code in any way you want except you cannot modify the copyright details at the top of each module.
• If you want to distribute source code with your application, then you are only allowed to distribute versions released by the author. This is to maintain a single distribution point for the source code.

History

v1.10 (19 May 2023)

• Updated copyright details.
• Updated modules to indicate that it needs to be compiled using /std:c++17. Thanks to Martin Richter for reporting this issue.

v1.09 (19 February 2022)

• Updated copyright details.
• Updated the code to use C++ uniform initialization for all variable declarations

v1.08 (31 October 2021)

• Updated copyright details.
• Fixed incorrect fallthrough in switch statement in CPropVariantAutoFree::FreeMemory.

v1.07 (2 February 2020)

• Updated copyright details
• Fixed more Clang-Tidy static code analysis warnings in the code.

v1.06 (18 December 2019)

• Updated initialization of various structs to use C++ 11 list initialization
• Fixed various Clang-Tidy static code analysis warnings in the code.

v1.05 (15 September 2019)

• Fixed a number of compiler warnings when the code is compiled with VS 2019 Preview

v1.04 (20 April 2019)

• Updated copyright details.
• Updated the code to clean compile on VC 2019

v1.03 (22 September 2018)

• Updated copyright details.
• Fixed a number of C++ core guidelines compiler warnings. These changes mean that the code will now only compile on VC 2017 or later.

v1.02 (19 December 2017)

• Updated copyright details.
• Updated the code to compile cleanly when _ATL_NO_AUTOMATIC_NAMESPACE is defined.
• Verified there has been no further additions to MSMQ from the latest Windows 10 SDK
• Fixed up a compilation warning in VC 2015 in the MSMQDemo.cpp module.

v1.01 (22 November 2015)

• Updated copyright details.
• Updated the code to clean compile at warning level 4
• Updated the code to clean compile on VC 2015
• Added comprehensive SAL annotations to all the code
• Replaced all occurrences of NULL with nullptr throughout the code

v1.0 (5 May 2014)

• Initial Public release

Contacting the Author

PJ Naughter
Email: pjna@naughter.com
Web: http://www.naughter.com
19 May 2023