FirewallAutoDetect Property

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

 sshclient.getFirewallAutoDetect([callback])
 sshclient.setFirewallAutoDetect( firewallAutoDetect, [callback])

Default Value

FALSE

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 getFirewallAutoDetect([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 setFirewallAutoDetect([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 tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean