TipcMsgGetArrivalTimestamp

Name

TipcMsgGetArrivalTimestamp — get the arrival timestamp property of a message

Synopsis

T_BOOL TipcMsgGetArrivalTimestamp(msg, arrival_timestamp_return) 
T_IPC_MSG msg; 
T_REAL8 *arrival_timestamp_return; 

Arguments

msg — message to get arrival timestamp from

arrival_timestamp_return — storage for message arrival timestamp

Return Values

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

Diagnostics

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

Description

TipcMsgGetArrivalTimestamp gets the arrival timestamp property of a message. As messages are read, their arrival timestamp property will automatically be set. A value of 0.0 indicates that the arrival timestamp property was not set.

See Also

TipcMsgSetArrivalTimestamp

Examples

This example gets the arrival timestamp of a message:

T_REAL8 arrival_timestamp; 
if (!TipcMsgGetArrivalTimestamp(msg, &arrival_timestamp)) { 
  return;  /* error */ 
}