TipcSrvSetTimeout

Name

TipcSrvSetTimeout — set a timeout property of the connection to RTserver

Synopsis

T_BOOL TipcSrvSetTimeout(timeout, value) 
T_IPC_TIMEOUT timeout; 
T_REAL8 value; 

Arguments

timeout — which timeout property to set

value — timeout value (in seconds)

Return Values

TRUE if timeout was successfully set for the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvSetTimeout sets a timeout property of the connection to RTserver by setting one of the options: Server_Read_Timeout, Server_Write_Timeout, Server_Keep_Alive_Timeout, and Server_Delivery_Timeout. The timeout properties control how often the connection to RTserver is checked for possible network failures. See TipcSrvGetTimeout for more information on connection timeouts.

TipcSrvSetTimeout may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvSetTimeout sets a timeout property of the warm connection. See TipcSrvCreate for information on automatic creation of connections and warm connections to RTserver.

Caution

None

See Also

TipcConnSetTimeout, TipcSrvGetTimeout

Examples

This sets the read timeout of the connection to RTserver with TipcSrvSetTimeout to 10 seconds:

if (!TipcSrvSetTimeout(T_IPC_TIMEOUT_READ, 10.0)) { 
  return;  /* error */ 
}  

An alternate way to set the read timeout of the connection to RTserver is to set the option Server_Read_Timeout.

TutCommandParseStr("setopt server_read_timeout 10.0");