IdleTimeout Property
The maximum period of inactivity the class will allow before disconnecting.
Syntax
amqp.getIdleTimeout([callback]) amqp.setIdleTimeout( idleTimeout, [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 getIdleTimeout([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 setIdleTimeout([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
This property controls how long, in seconds, the class will allow the connection to sit idle before it disconnects from the remote host.
This property may be set to 0 to prevent the class from ever closing the connection due to inactivity.
Note: The idle timeout cannot be changed while connected.
This property is not available at design time.
Data Type
Integer