(C) 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.

Downloads:

MS Windows Visual C/C++ Libraries

Linux/CentOS C/C++ Libraries

MAC OS X C/C++ Libraries

Solaris C/C++ Libraries

C++ Builder Libraries

FreeBSD C++ Libraries

HP-UX C++ Libraries

BlackBerry QNX C++ Libraries

#include <C_CkFtp2.h>

void ChilkatSample(void)
    {
    HCkFtp2 ftp;
    BOOL success;
    const char * localFilename;
    const char * remoteFilename;

    ftp = CkFtp2_Create();

    //  Any string unlocks the component for the 1st 30-days.
    success = CkFtp2_UnlockComponent(ftp,"Anything for 30-day trial");
    if (success != TRUE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        return;
    }

    CkFtp2_putHostname(ftp,"www.secureftp-test.com");
    CkFtp2_putUsername(ftp,"test");
    CkFtp2_putPassword(ftp,"test");

    //  Connect and login to the FTP server.
    success = CkFtp2_Connect(ftp);
    if (success != TRUE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        return;
    }

    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 = CkFtp2_AsyncGetFileStart(ftp,remoteFilename,localFilename);
    if (success != TRUE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        return;
    }

    //  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 (CkFtp2_getAsyncFinished(ftp) != TRUE) {

        printf("%d bytes received\n",CkFtp2_getAsyncBytesReceived(ftp));
        printf("%d bytes per second\n",CkFtp2_getDownloadRate(ftp));

        //  Sleep 1 second.
        CkFtp2_SleepMs(ftp,1000);

    }

    printf("%d total bytes received\n",CkFtp2_getAsyncBytesReceived(ftp));
    printf("%d final bytes per second\n",CkFtp2_getDownloadRate(ftp));

    //  Did the download succeed?
    if (CkFtp2_getAsyncSuccess(ftp) == TRUE) {
        printf("File Downloaded!\n");
    }
    else {
        //  The error information for asynchronous ops
        //  is in AsyncLog as opposed to LastErrorText
        printf("%s\n",CkFtp2_asyncLog(ftp));
    }

    CkFtp2_Disconnect(ftp);

    CkFtp2_Dispose(ftp);

    }