This repository demonstrates a way to call IBM MQ from applications running in a Node.js environment.
Most MQI verbs and parameters are implemented here. Where there are missing details within the verbs, these are shown by TODO markers in the source files.
It is assumed that someone using this package does have a basic understanding of the procedural MQI, as that is needed to decide which options and fields may need to be set for each verb.
Note: This has changed significantly from the 0.9.2 version of the module onwards.
The main verbs -
Get - have
true synchronous and asynchronous variations. The default is that the verbs
are asynchronous, to be more natural in a Node.js environment. When given a
OpenSync) then the verb is synchronous. Callback functions are now required
for the OpenSync and SubSync verbs to obtain the object handles; these are not returned
explicitly from the function calls.
The remaining verbs continue to internally make synchronous calls to the underlying MQI services. Callback functions can still be used to indicate completion of the operation, with function return values and exceptions being available if you want to treat them more synchronously rather than pseudo-async.
For the asynchronous functions, a callback function is mandatory.
Note that MQ also has a concept of Asynchronous Put (an MQPMO option) usable from
client applications. That can be used in conjunction with a later call to the
function to determine the success of the Put calls, but it is not related to
Synchronous compatibility option
If you wish to continue to use the original pseudo-async calls made by this module
without changing the verbs to use the Sync variants, then you can set the SyncMQICompat
true. This variable should be considered a temporary migration path; it
will likely be removed at some point in the future.
Most of the core MQI verbs (excluding the GET variants) have Promise-based alternatives
named with a
...Promise suffix (eg
ConnxPromise). This can help with removal of much
of the typical callback nesting. See the amqsputp.js sample for a demonstration
of how these can be used. There is no Get-based Promise because the async Get operation invokes
callbacks multiple times as messages appear.
This implementation includes two mechanisms for retrieving messages from a queue:
- GetSync() is the call that does an MQGET(wait) synchronously. In a Node environment, it blocks the execution thread until it completes. That may be OK for an immediate retrieval where the wait time is set to zero, but it is not recommended for any times where you want to wait a while for a message to arrive. Some of the samples use this function for simplicity, where the Get() is not the interesting aspect being demonstrated.
- Get() is the call that works asynchronously. The callback given as a parameter to this function is invoked asynchronously. The function remains active after delivering a message to permit receipt of multiple messages. To stop the callback being called for further messages, use the GetDone() function. This behaviour is similar to how the MQI MQCB callback invocation works.
The asynchronous retrieval is implemented using a polling MQGET(immediate) operation. Originally, this package used the MQCB and MQCTL functions to work fully asynchronously, but the threading model used within the MQ libraries does not work well with the Node model, and testing demonstrated deadlocks that could not be solved without changes to the underlying MQ products. The polling is done by default every 10 seconds; applications can override that by calling the setTuningParameters function.
Sample programs amqsget and amqsgeta demonstrate the two different techniques.
There are already some other ways to access MQ from Node.js:
- Take a look at the MQ Light client available from NPM. MQ supports connections from MQ Light clients via AMQP channels.
- The MQTT protocol has an implementation here. MQ supports connections from MQTT clients via the XR service and Telemetry channels.
- MQ V9.0.4 includes a simple REST API for messaging that is accessible from any environment. See here for more information.
These interfaces may be suitable for many messaging applications, even though they do not give access to the full services available from MQ such as transactions.
All the application-level MQI verbs are implemented.
However there is now a definition and sample program to manipulate the Dead Letter Header (MQDLH). This should be considered experimental for now - there may be better ways to work with the structures. There is also a definition for the MQRFH2 structure header, though not for the individual folders and properties that may be added to that structure.
The amqsget sample shows ways to process the returned message, including extracting details from the MQDLH and MQRFH2 structures if they are part of the message.
Local queue manager connectivity
The C MQ library is dynamically loaded at runtime. By default, this package will
try to load the library from the
node_modules directory associated with the
For platforms where the MQ Redistributable Client exists and has been installed, this means that local bindings connections will not work to connect to a queue manager, even if there is also a full MQ installation on the machine. Only client connections can be used by the Redistributable Client libraries. Trying to connect to a local queue manager will likely result in an MQRC_Q_MGR_NAME_ERROR (2058) error.
To override this default behaviour and to permit use of local bindings connections, the full MQ installation libraries must be used instead. There are two mechanisms to do this:
- Set the
MQIJS_NOREDISTenvironment variable during
npm installso that the Redist Client package is not downloaded and installed in the
- Set the
MQIJS_PREFER_INSTALLED_LIBRARYenvironment variable at runtime
The use of the Redist Client libraries is preferred wherever possible, so that new function can be introduced regardless of the version of MQ that has been "properly" installed on a machine.
Client connections work in the usual way.
- Definitions can be set up externally via CCDT or the MQSERVER environment variable
- Definitions can be set up programmatically via the MQCD and MQSCO structures passed to Connx()
To force client connections, even when there is a full MQ server set of libraries installed and loaded:
- The program can set the
MQCNO_CLIENT_BINDINGflag in the MQCNO options during Connx()
- You can set the
MQ_CONNECT_TYPEenvironment variable to "CLIENT".
The package includes a couple of verbs that are not standard in the MQI.
- GetDone() is used to end asynchronous retrieval of messages.
- GetSync() is equivalent of the traditional MQGET operation.
- Lookup() extracts strings corresponding to MQI numbers, similar to the MQConstants.lookup() method in Java.
- node version 10.20 or greater. Older versions will no longer work because of requirements from the ffi-napi package
- On platforms other than Windows and Linux x64, you must also install the MQ client package
I have run it on Windows, where the NPM 'windows-build-tools' package also needed to be installed first. See this document for more information on Windows.
To install this package, you can pull it straight from the NPM repository. You can also refer to it in a package.json file for automatic installation.
mkdir <something> cd <something> npm install ibmmq
Installation of the package will automatically install any prerequisite packages downloadable from the npm repository.
It also requires the MQ C client libraries to be installed/available.
For Windows and Linux x64, the npm installation process tries to access the Redistributable Client packages and unpack them automatically. The installation of this library succeeds even if the download and unpack of the MQ runtime libraries fails in some way.
Note: IBM removes older levels of the Redistributable Client packages when they become unsupported. If you want to continue to use older versions of this package (which will reference those unsupported MQ versions) then you will have to keep a local copy of the tar/zip files and unpack it as part of your build process, using the MQIJS_* environment variables to control installation and runtime.
If you do not want this automatic installation of the MQ runtime, then set the
MQIJS_NOREDIST to any value before running npm install.
The MQ libraries are then be found at runtime using mechanisms such as
LD_LIBRARY_PATH (Linux) or
The post-installation program will usually be pointing at the most recent Continuous Delivery
version of MQ (for example 220.127.116.11). These versions of MQ do not have fixpacks released. However
you can override both the version (VRM) and fixpack to be installed, assuming that full VRMF
level is still available for download. Setting the environment variables
MQIJS_FIXPACK will select a specific Redistributable Client package to be installed. Note that
installing an older VRM than the default in the current version of this package may not work, if
newer options have been introduced to the MQI. At the time of writing this paragraph, the latest
version of MQ was 9.2.0 (with no later CD releases), but there was also a 18.104.22.168 fixpack. If
you want to pick that up instead of the base 9.2.0 referred to in postinstall.js, then
MQIJS_FIXPACK=1 before running
npm install. Once newer CD levels are available, then the
postinstall script will point at those instead by default.
The MQ client package for MacOS can be found at
Download a suitable version and unpack it in a local directory.
The environment variable
DYLD_LIBRARY_PATH then needs to be set to the lib64 directory within
that tree before running the program.
Errors and warnings during build
If you get an error message such as "gyp: No Xcode or CLT version detected" while
npm install you may need to install the developer tools. Usually
xcode-select --install will deal with this.
You may also see a number of warnings from the C++ compiler as it compiles some of the FFI prerequisite packages. While undesirable, there should be no actual errors shown and the generated code does seem to work ok.
For other MQ-supported platforms and environments, the C runtime can be installed from your MQ installation media, or from the full Client downloads at this site.
The Redistributable Client packages for Windows and Linux x64 are also available directly from this site.
See the samples README file for more information about the sample programs.
The samples directory includes a Dockerfile that can be used as the basis of generating an independent container to run MQ programs. The run.docker script builds and executes the container. Environment variables are used in the Dockerfile and the script to control connection to the queue manager.
The package contains JSDoc comments that can be formatted using the makedoc script in the root directory. The generated documentation is then accessible via a web browser.
This package is provided as-is with no guarantees of support or updates. You cannot use IBM formal support channels (Cases/PMRs) for assistance with material in this repository.
There are also no guarantees of compatibility with any future versions of the package; the API is subject to change based on any feedback. Versioned releases are made in this repository to assist with using stable APIs. Future versions will follow semver guidance so that breaking changes will only be done with a new major version number.
Issues and Contributions
For feedback and issues relating specifically to this package, please use the GitHub issue tracker.
Contributions to this package can be accepted under the terms of the IBM Contributor License Agreement, found in the file CLA.md of this repository. When submitting a pull request, you must include a statement stating you accept the terms in the CLA.
Thanks to the IBM App Connect team for the initial implementation of the asynchronous MQI variations. Their work has been adopted and adapted into this library.