tibemsMsg_GetCorrelationID

Function

Purpose

Get the correlation ID header of a message.

C Declaration

tibems_status tibemsMsg_GetCorrelationID(
    tibemsMsg message,
    const char** value );

COBOL Call

CALL "tibemsMsg_GetCorrelationID"
     USING BY VALUE message,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.
Note: message and value have usage pointer.

Parameters

Parameter Description
message Get the correlation ID of this message.
value Store the correlation ID.

Remarks

Correlation ID refers to a related message. For example, when a consumer responds to a request message by sending a reply, it can set the correlation ID of the reply to indicate the request message.

The JMS specification allows three categories of values for the correlation ID property:

  • Message ID

    A message ID is a unique string that the provider assigns to a message. Programs can use these IDs to correlate messages. For example, a program can link a response to a request by setting the correlation ID of a response message to the message ID of the corresponding request message.

    Message ID strings begin with the prefix ID: (which is reserved for this purpose).

  • String

    Programs can also correlate messages using arbitrary strings, with semantics determined by the application.

    These strings must not begin with the prefix ID: (which is reserved for message IDs).

  • Byte Array

    This implementation does not support byte array values for the correlation ID property. The JMS specification does not require support.

See Also

tibemsMsg_GetMessageID

tibemsMsg_SetCorrelationID