(JavaScript) FTP Bandwidth Throttle for Downloads

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var ftp = new CkFtp2();

ftp.Hostname = "ftp.example.com";
ftp.Username = "login";
ftp.Password = "password";

// To use FTP bandwidth throttling, set the BandwidthThrottleDown
// property to a maximum desired bytes/second:
// This example limits the download to 50K per second.
ftp.BandwidthThrottleDown = 50000;

// The default data transfer mode is "Active" as opposed to "Passive".

// Connect and login to the FTP server.
success = ftp.Connect();
if (success !== true) {
    console.log(ftp.LastErrorText);
    return;
}

// Change to the remote directory where the file is located.
// This step is only necessary if the file is not in the root directory
// for the FTP account.
success = ftp.ChangeRemoteDir("junk");
if (success !== true) {
    console.log(ftp.LastErrorText);
    return;
}

// Download a file.
var localFilename = "hamlet.xml";
var remoteFilename = "hamlet.xml";

success = ftp.GetFile(remoteFilename,localFilename);
if (success !== true) {
    console.log(ftp.LastErrorText);
    return;
}

success = ftp.Disconnect();

console.log("File Downloaded!");