TipcSrvGetTimeout

Name

TipcSrvGetTimeout — get a timeout property from the connection to RTserver

Synopsis

T_BOOL TipcSrvGetTimeout(timeout, value_return) 
T_IPC_TIMEOUT timeout; 
T_REAL8 *value_return; 

Arguments

timeout — which timeout property to get

value_return — storage for timeout value

Return Values

TRUE if the timeout property was successfully retrieved from the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvGetTimeout gets a timeout property from the connection to RTserver by calling TipcConnGetTimeout. The timeout properties control how often (in seconds) the connection to RTserver is checked for possible network failures. See TipcConnGetTimeout for more information on connection timeouts.

The timeout properties of the connection to RTserver are also available in the options Server_Read_Timeout, Server_Write_Timeout, Server_Keep_Alive_Timeout, and Server_Delivery_Timeout. For the connection to RTserver, the default read timeout is 30.0 seconds, the default write timeout is 30.0 seconds, the default keep alive timeout is 5.0 seconds, and the default delivery timeout is 30.0 seconds.

TipcSrvGetTimeout may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvGetTimeout gets a timeout property from the warm connection. See TipcSrvCreate on automatic creation of connections and warm connections to RTserver.

Caution

If TipcSrvGetTimeout returns FALSE, it does not store a value in value_return.

See Also

TipcConnGetTimeout, TipcSrvSetTimeout

Examples

This example gets the read timeout from the connection to RTserver with TipcSrvGetTimeout and prints it:

T_REAL8 timeout; 
 
if (!TipcSrvGetTimeout(T_IPC_TIMEOUT_READ, &timeout)) { 
  return;  /* error */ 
} 
 
TutOut("The connection to RTserver’s read timeout is %s 
seconds.\n",  
       TutRealToStr(timeout));