TipcMsgGetDeliveryTimeout

Name

TipcMsgGetDeliveryTimeout — get the delivery timeout of a message in seconds

Synopsis

T_BOOL TipcMsgGetDeliveryTimeout(msg, delivery_timeout_return) 
T_IPC_MSG msg; 
T_REAL8 *delivery_timeout_return;

Arguments

msg — message to get delivery timeout from

delivery_timeout_return — storage for message delivery timeout

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — msg was null or delivery_timeout_return was null

T_ERR_DOESNT_EXIST — the timeout has not yet been set for this message. This is a benign error. The timeout defaults to the connection’s delivery timeout when the message is sent.

Description

TipcMsgGetDeliveryTimeout gets the delivery timeout of a message in seconds. 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. When a message is created, its delivery timeout is initialized to the message type delivery timeout, which defaults to UNKNOWN. This allows a default value to be easily set for all messages of a certain type. See TipcMtGetDeliveryTimeout for more information on message type delivery timeouts.

When a message is sent using GMD on a connection, the connection delivery timeout is used if the message delivery timeout is not set. The delivery timeout of a message is never sent through the connection, as it is only needed by the sending process.

Caution

None

Examples

This example gets the delivery timeout of a message:

T_REAL8 delivery_timeout; 
if (!TipcMsgGetDeliveryTimeout(msg, &delivery_timeout)) { 
  return;  /* error */ 
}