Node.js

Set FTP Connection and Read Timeouts

Demonstrates the timeout properties ConnectTimeout, ReadTimeout, and IdleTimeoutMs.

Background: The three timeouts guard different phases: ConnectTimeout (in seconds) bounds how long a connection attempt blocks so an unreachable server fails promptly; ReadTimeout (seconds) limits how long a data connection may stall without new data; and IdleTimeoutMs (milliseconds) caps a lack of forward progress overall. Tuning them prevents a hung server or flaky link from freezing an automated job indefinitely.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    var ftp = new chilkat.Ftp2();

    ftp.Hostname = "ftp.example.com";
    ftp.Username = "myFtpLogin";

    //  Maximum seconds to wait for the TCP connection to be accepted.
    ftp.ConnectTimeout = 15;

    //  Maximum seconds a data connection may go without receiving more data before timing out.
    ftp.ReadTimeout = 30;

    //  Maximum milliseconds without a control-channel response or forward progress before failing.
    ftp.IdleTimeoutMs = 20000;

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    ftp.Password = "myPassword";

    success = ftp.Connect();
    if (success == false) {
        console.log(ftp.LastErrorText);
        return;
    }

    console.log("Connected with custom timeouts.");

    success = ftp.Disconnect();
    if (success == false) {
        console.log(ftp.LastErrorText);
        return;
    }


}

chilkatExample();