Interfaces, MQSeries access (OMMQI) is packaged separately from OmniMark. The following describes version 1.0 of Interfaces, MQSeries access (OMMQI).

OMMQI is the OmniMark MQSeries interface library, a set of functions which makes the IBM MQSeries client API available to OmniMark programs. This library requires an installed and configured IBM MQSeries client version 5.2 or later.

The library consists of the following files:

• "ommqi.dll" (Windows) or "ommqi.so" (UNIX) -- the dynamic link library file that contains the OmniMark MQSeries functions.
• "ommqi.xin" -- the OmniMark include file which contains the OMX components and functions contained in the OMMQI library.
• "ommqimac.xin" -- the OmniMark include file which contains the primary MQSeries macro definitions provided by IBM. This file is included by ommqi.xin.
• "ommqimac2.xin" -- the OmniMark include file which contains the remainder of the MQSeries macro definitions provided by IBM. This file is included by ommqi.xin.

The OMMQI Functions and OMX Components

OMMQI functions allow you to:

• connect to and disconnect from an MQSeries server (mq-connect, mq-connectx and mq-disconnect)
• open and close queues and distribution lists (mq-open and mq-close)
• put messages onto queues (mq-put and mq-put1)
• get messages from queues (mq-get)
• manage units of work (mq-commit and mq-backout)
• set and get attributes of MQSeries objects (mq-inquire, mq-inquire-names and mq-set)

The primary OMX components in this library are used to encapsulate connections to queue managers and IBM MQSeries objects (such as queues):

• mq-connection -- encapsulates a connection to a queue manager
• mq-object -- encapsulates a connection to an IBM MQSeries objects such as a queue

OMX components are available for each of the implemented MQSeries client API structures, as well as functions for getting and setting their values. See the Object Descriptions document for details.

Requirements

To use the OMMQI functions in your OmniMark program, you have to add the following statement to your program:

      include "ommqi.xin"

OMMQI Generated Exceptions

Two types of external exceptions can be throw by the OMMQI: validation exceptions from the OmniMark library, and MQSeries errors from the MQSeries client library. See the ommqi error handling document for details.

Functions    mq-backout    mq-close    mq-commit    mq-connect    mq-connection    mq-connectx    mq-disconnect    mq-get    mq-get-entire-return-status    mq-get-function-status    mq-get-logging-level    mq-get-throw-on-warnings    mq-inquire    mq-inquire-names    mq-object    mq-open    mq-put    mq-put1message    mq-set    mq-set-logging-level    mq-set-throw-on-warnings

Platforms    HP/UX    IBM AIX    Linux (Intel)    MS Windows 98/ME    MS Windows NT/2000/XP    Sun Solaris

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]