How the CICS-WebSphere MQ API-crossing exit is called

Using the CICS-WebSphere MQ API-crossing exit degrades the performance of WebSphere® MQ for z/OS® , so plan your use of it carefully. When enabled, the CICS-WebSphere MQ API-crossing exit is called in the following circumstances.

  • CSQCAPX is called by all applications that use the CICS-WebSphere MQ adapter.
  • CSQCAPX is called every time one of the following MQI calls is made:
    • MQCB
    • MQCTL
    • MQCLOSE
    • MQGET
    • MQINQ
    • MQOPEN
    • MQPUT
    • MQPUT1
    • MQSET
    • MQSTAT
    • MQSUB
    • MQSUBRQ
    CSQCAPX is called both before and after a call.
  • During processing for asynchronous message consumption, CSQCAPX is called in three circumstances:
    • Before calling the WebSphere MQ routine CSQAVICD, if data conversion is required for a message before passing it to the callback routine.
    • Before and after calls to the callback routine.
    For these calls, the WebSphere MQ MQI parameter list that is referenced by the MQXP_PCOPYPARM fields in the parameter list passed to CSQCAPX contains the same data that is passed to a callback routine, that is, the MQMD, MQGMO, Buffer, and Context.

CSQCAPX is not called for the function calls for message properties and message handles, which are the MQCRTMH, MQDLTMH, MQSETMP, MQINQMP, MQDLTMP, MQMHBUF, and MQBUFMH calls.

To reduce excessive use of TCB switching, you should ensure that the exit program is defined as THREADSAFE.

The exit program is called once before a call is executed, and once after the call is executed. On the "before" type of exit call, the exit program can modify any of the parameters on the MQI call, suppress the call completely, or allow the call to be processed. If the call is processed, the exit is called again after the call has completed.

The exit program is not recursive. Any MQI calls made inside the exit do not call the exit program for a second time.



fg15280_.html | Timestamp icon Last updated: Monday, 5 June 2017