TipcMsgGetExpiration

Name

TipcMsgGetExpiration — get the expiration property of a message

Synopsis

T_BOOL TipcMsgGetExpiration(msg, expiration_return) 
T_IPC_MSG msg; 
T_REAL8 *expiration_return; 

Arguments

msg — message to get the expiration of

expiration_return — storage for message expiration time

Return Values

TRUE if the expiration was successfully retrieved from the message, FALSE otherwise.

Diagnostics

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

Description

TipcMsgGetExpiration gets 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

See Also

TipcMsgSetExpiration

Examples

This example gets the expiration property of a message:

T_REAL8 expiration; 
if (!TipcMsgGetExpiration(msg, &expiration)) { 
  return;  /* error */ 
}