Asynchronous FTP Upload

The Chilkat FTP component supports asynchronous uploads and downloads. This examples demonstrates doing an upload in a background thread. The upload is started by calling AsyncPutFileStart. While the upload 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("ftp.yourftpserver.com")
ftp.put_Username("*myLogin6*")
ftp.put_Password("*myPassword6*")

# 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 will be uploaded.
success = ftp.ChangeRemoteDir("junk")
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

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

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

# The application is now free to do anything else
# while the file is uploading.
# 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_AsyncBytesSent().to_s() + " bytes sent" + "\n";
    print ftp.get_UploadRate().to_s() + " bytes per second" + "\n";

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

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

ftp.Disconnect()