TipcMsgSetExpiration

Name

TipcMsgSetExpiration — set the expiration property of a message

Synopsis

T_BOOL TipcMsgSetExpiration(msg, expiration) 
T_IPC_MSG msg; 
T_REAL8 expiration;

Arguments

msg — message to set the expiration of

expiration — message expiration time

Return Values

TRUE if the expiration was successfully set for the message, FALSE otherwise.

Diagnostics

If TipcMsgSetExpiration fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — msg was null or expiration was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_READ_ONLY — the message was marked read-only. This happens if the message is a field in another message.

T_ERR_VAL_TOO_SMALL — expiration was negative

Description

TipcMsgSetExpiration sets the expiration, also known as time to live, property of a message. The expiration property controls how long, in seconds, the message should be in existence. Applications of messages are free to use the expiration for any purpose. A value of 0.0 indicates that the message does not expire.

Caution

None

Examples

This example sets the expiration property of a message to 30 seconds:

if (!TipcMsgSetExpiration(msg, 30.0)) { 
  return;  /* error */ 
}