TipcMsgSetDeliveryTimeout

Name

TipcMsgSetDeliveryTimeout — set the delivery timeout of a message

Synopsis

T_BOOL TipcMsgSetDeliveryTimeout(msg, delivery_timeout) 
T_IPC_MSG msg; 
T_REAL8 delivery_timeout;

Arguments

msg — message to set the delivery timeout for

delivery_timeout — message delivery timeout

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — msg 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 — delivery_timeout was negative

Description

This function sets the delivery timeout of a message. The delivery timeout of a message controls how long to wait for guaranteed message delivery to complete when a message is sent through a connection with TipcConnMsgSend. TipcMsgSetDeliveryTimeout overwrites the default value of the delivery timeout property set by TipcMtSetDeliveryTimeout. See TipcMsgGetDeliveryTimeout for more information on message delivery timeouts.

Caution

None

Examples

This example sets the delivery timeout of a message to 5 seconds:

if (!TipcMsgSetDeliveryTimeout(msg, 5.0)) { 
  return;  /* error */ 
}