Timeout Property
The timeout value, in seconds, for the connection.
Syntax
int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout);
Default Value
0
Remarks
The timeout value, in seconds, for the connection.
This property specifies the timeout, in seconds, to use for the connection.
If set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data can't be sent immediately.
If set to a positive value, the class will automatically retry each operation that would otherwise result in a WOULDBLOCK error for a maximum of Timeout seconds.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
Optionally, the behavior of the class may be changed to absolute timeouts, i.e. the class will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout configuration setting.
The default value is 0 (asynchronous operation).
The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
Integer