TipcConnSetTimeout

Name

TipcConnSetTimeout — set a timeout property of a connection

Synopsis

T_BOOL TipcConnSetTimeout(conn, timeout, value) 
T_IPC_CONN conn; 
T_IPC_TIMEOUT timeout; 
T_REAL8 value;

Arguments

conn — connection to set timeout for

timeout — which timeout property to set

value — timeout value (in seconds)

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — conn was null

T_ERR_VAL_INVALID — timeout was not a valid TIMEOUT value

T_ERR_VAL_TOO_SMALL — value was negative

Description

TipcConnSetTimeout sets a timeout property of a connection. The timeout properties control how often (in seconds) the connection is checked for possible network failures.

If timeout is T_IPC_TIMEOUT_READ, TipcConnSetTimeout sets the read timeout of a connection.

If timeout is T_IPC_TIMEOUT_WRITE, TipcConnSetTimeout sets the write timeout of a connection.

If timeout is T_IPC_TIMEOUT_KEEP_ALIVE, TipcConnSetTimeout sets the keep alive timeout of a connection.

If timeout is T_IPC_TIMEOUT_DELIVERY, TipcConnSetTimeout sets the delivery timeout of a connection.

See TipcConnGetTimeout for information on connection timeouts.

Caution

None

Examples

This sets the read timeout of a connection with TipcConnSetTimeout to 10 seconds:

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