FTP Bandwidth Throttle for Downloads

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown.

Download Chilkat Ruby Library

require 'chilkat'

ftp = Chilkat::CkFtp2.new()

#  Any string unlocks the component for the 1st 30-days.
success = ftp.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

ftp.put_Hostname("www.example-code.com")
ftp.put_Username("****")
ftp.put_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.put_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)
    print ftp.lastErrorText() + "\n"
    exit
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.ChangeRemoteDir("junk")
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

#  Download a file.
localFilename = "hamlet.xml"
remoteFilename = "hamlet.xml"

success = ftp.GetFile(remoteFilename,localFilename)
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

ftp.Disconnect()

print "File Downloaded!" + "\n"