Timeout Property
The timeout value, in seconds, for the connection.
Syntax
mllpserver.getTimeout(index, [callback]) mllpserver.setTimeout(index, timeout, [callback])
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getTimeout([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setTimeout([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
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.
The default value is 0 (asynchronous operation).
The index parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
Integer