The Reference Message sample programs

The Reference Message samples allow a large object to be transferred from one node to another (usually on different systems) without the need for the object to be stored on IBM MQ queues at either the source or the destination nodes.

A set of sample programs is provided to demonstrate how Reference Messages can be put to a queue, received by message exits, and taken from a queue. The sample programs use Reference Messages to move files. To move other objects such as databases, or if we want to perform security checks, define your own exit, based on the sample, amqsxrm.

The version of the Reference Message exit sample program to use depends on the platform on which the channel is running:

• On all platforms, use amqsxrma at the sending end.
• Use amqsxrma at the receiving end if the receiver is running under any platform except IBM i.
• If the receiver is running under IBM i, use amqsxrm4.

.

• Notes for IBM i users
  To receive a Reference Message using the sample message exit, specify a file in the root file system of IFS or any subdirectory so that a stream file can be created.
• Running the Reference Message samples
  Use this example to find out how to run Reference Message sample application AMQSPRM on UNIX, Linux, and Windows, or AMQSPRMA on IBM i. The example shows how Reference Messages can be put to a queue, received by message exits, and taken from a queue.
• Design of the Put Reference Message sample (amqsprma.c, AMQSPRM4)
  This topic gives a detailed description of a Put Reference Message sample.
• Design of the Reference Message Exit sample (amqsxrma.c, AMQSXRM4)
  This sample recognizes Reference Messages with an object type that matches the object type in the message exit user data field of the channel definition.
• Design of the Get Reference Message sample (amqsgrma.c, AMQSGRM4)
  This topic explains the design of the Get Reference Message sample.

Parent topic: Use the sample programs on Multiplatforms