Passive Property

Controls whether to direct the server into passive mode. Recommended if behind a firewall.

Syntax

 ftp.getPassive([callback])
 ftp.setPassive( passive, [callback])

Default Value

TRUE

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 getPassive([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 setPassive([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 whether to direct the server into passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them. If Passive is set to TRUE, the class will use the PASV instead of the PORT command and will thus direct the server into passive mode: connections are initiated only by the client.

Data Type

Boolean