tibemsMsg_SetPriority

Function

Purpose

Set the priority header of a message.

C Declaration

tibems_status tibemsMsg_SetPriority(
    tibemsMsg message,
    tibems_int value );

COBOL Call

CALL "tibemsMsg_SetPriority"
     USING BY VALUE message,
           BY VALUE value,
           RETURNING tibems-status
END-CALL.

Note: message has usage pointer.

Parameters

Parameter	Description
`message`	Set the priority of this message.
`value`	Set the priority to this value.

Remarks

Sending calls set the priority header automatically. The Jakarta Messaging specification defines this call for symmetry.

Sending calls record the priority of a message in this header, based on either a property of the producer, or on a parameter to the send call.

The Jakarta Messaging specification defines ten levels of priority value, from zero (lowest priority) to 9 (highest priority). The specification suggests that clients consider 0–4 as gradations of normal priority, and priorities 5–9 as gradations of expedited priority.

Priority affects the order in which the server delivers messages to consumers (higher values first). The Jakarta Messaging specification does not require all providers to implement priority ordering of messages. (EMS supports priorities, but other Jakarta Messaging providers might not.)