TipcMsgSetArrivalTimestamp

Name

TipcMsgSetArrivalTimestamp — set the arrival timestamp property of a message

Synopsis

T_BOOL TipcMsgSetArrivalTimestamp(msg, arrival_timestamp) 
T_IPC_MSG msg; 
T_REAL8 arrival_timestamp;

Arguments

msg — message to set arrival timestamp for

arrival_timestamp — message arrival timestamp

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — msg was null or arrival_timestamp 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 — arrival_timestamp was negative

Description

TipcMsgSetArrivalTimestamp sets 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.

Caution

None

Examples

This example sets the arrival timestamp property of a message to the current time:

if (!TipcMsgSetArrivalTimestamp(msg, TutGetWallTime())) { 
  return;  /* error */ 
}