Asynchronous FTP Download

The Chilkat FTP component supports asynchronous uploads and downloads. This examples demonstrates doing a download in a background thread. The download is started by calling AsyncGetFileStart. While the download is in progress, your program may do other tasks. You may periodically check the AsyncFinished property to determine when the transfer is finished. The example below provides the remainder of the details.

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.secureftp-test.com")
ftp.put_Username("test")
ftp.put_Password("test")

#  Connect and login to the FTP server.
success = ftp.Connect()
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

localFilename = "hamlet.xml"
remoteFilename = "hamlet.xml"

#  Begin the download in a background thread.
#  Only 1 background upload or download may be active at any time.
#  (per instance of an FTP object)
success = ftp.AsyncGetFileStart(remoteFilename,localFilename)
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

#  The application is now free to do anything else
#  while the file is downloading.
#  For this example, we'll simply sleep and periodically
#  check to see if the transfer if finished.  While checking
#  however, we'll report on the progress in both number
#  of bytes tranferred and performance in bytes/second.
while ftp.get_AsyncFinished() != true

    print ftp.get_AsyncBytesReceived().to_s().to_s() + 
        " bytes received" + "\n";
    print ftp.get_DownloadRate().to_s().to_s() + 
        " bytes per second" + "\n";

    #  Sleep 1 second.
    ftp.SleepMs(1000)
end

#  Did the download succeed?
if (ftp.get_AsyncSuccess() == true)
    print "File Downloaded!" + "\n"
else
    #  The error information for asynchronous ops
    #  is in AsyncLog as opposed to LastErrorText
    print ftp.asyncLog() + "\n"
end

ftp.Disconnect()