TipcMtGetDeliveryTimeout

Name

TipcMtGetDeliveryTimeout — get the delivery timeout of a message type

Synopsis

T_BOOL TipcMtGetDeliveryTimeout(mt, delivery_timeout_return) 
T_IPC_MT mt; 
T_REAL8 *delivery_timeout_return;

Arguments

mt— message type to get delivery timeout from

delivery_timeout_return — storage for message type delivery timeout

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — mt was null or delivery_timeout_return was null

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

Description

TipcMtGetDeliveryTimeout gets the delivery timeout of a message type. 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. The delivery timeout of a message type is used as the default delivery timeout for messages of this type. When a message is created, its delivery timeout is initialized to the message type delivery timeout. See TipcMsgGetDeliveryTimeout for more information on message delivery timeouts.

The delivery timeout of an outgoing message can always be set on a per-message basis, but using message type delivery timeouts makes it easier to change the default delivery timeout for all outgoing messages of a specific type. The standard SmartSockets message types by default all have a delivery timeout of unknown, but these can be changed. User-defined message types can also use whatever delivery timeout is appropriate.

Caution

If TipcMtGetDeliveryTimeout returns FALSE, it does not store a value in delivery_timeout_return.

Examples

This example gets the delivery timeout of a message type:

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