tibemsMsg_GetExpiration

Function

Purpose

Get the expiration header from a message.

C Declaration

tibems_status tibemsMsg_GetExpiration(
    tibemsMsg message,
    tibems_long* value );

COBOL Call

CALL "tibemsMsg_GetExpiration"
     USING BY VALUE message,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.
Note: message has usage pointer.

Parameters

Parameter Description
message Get the expiration from this message.
value Store the expiration.

Remarks

Sending calls record the expiration time (in milliseconds) of the message in this field:

  • If the time-to-live is non-zero, the expiration is the sum of that time-to-live and the sending client’s current time (GMT).
  • If the time-to-live is zero, then expiration is also zero—indicating that the message never expires.

The server discards a message when its expiration time has passed. However, the Jakarta Messaging specification does not guarantee that clients do not receive expired messages.

See Also

tibemsMsg_SetExpiration

tibemsMsgProducer_GetTimeToLive