Lua

FTP Bandwidth Throttle for Downloads

See more FTP Examples

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown. Lua

local chilkat = require("chilkat")

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

local ftp = chilkat.Ftp2.new()

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.bandwidth_throttle_down = 50000

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

-- Connect and login to the FTP server.
local success = ftp:connect()
if not success then
    print(ftp.last_error_text)
    return
end

-- 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:change_remote_dir("junk")
if not success then
    print(ftp.last_error_text)
    return
end

-- Download a file.
local localFilename = "hamlet.xml"
local remoteFilename = "hamlet.xml"

success = ftp:get_file(remoteFilename, localFilename)
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:disconnect()

print("File Downloaded!")