(Unicode C++) Async SFTP Progress Info

Demonstrates checking for progress info updates when running a task asynchronously. This example demonstrates an SFTP download.

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <CkGlobalW.h>
#include <CkSFtpW.h>
#include <CkTaskW.h>

void ChilkatSample(void)
    {
    // All Chilkat classes can be unlocked at once at the beginning of a program
    // by calling UnlockBundle.  It requires a Bundle unlock code.
    CkGlobalW chilkatGlob;
    bool success = chilkatGlob.UnlockBundle(L"Anything for 30-day trial.");
    if (success != true) {
        wprintf(L"%s\n",chilkatGlob.lastErrorText());
        return;
    }

    CkSFtpW sftp;

    // Set some timeouts, in milliseconds:
    sftp.put_ConnectTimeoutMs(15000);
    sftp.put_IdleTimeoutMs(15000);

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    const wchar_t *hostname = L"www.my-ssh-server.com";
    int port = 22;
    success = sftp.Connect(hostname,port);
    if (success != true) {
        wprintf(L"%s\n",sftp.lastErrorText());
        return;
    }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw(L"myLogin",L"myPassword");
    if (success != true) {
        wprintf(L"%s\n",sftp.lastErrorText());
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success != true) {
        wprintf(L"%s\n",sftp.lastErrorText());
        return;
    }

    // --------------------
    // Download a file
    // --------------------
    const wchar_t *localFilePath = L"c:/temp/hamlet.xml";
    const wchar_t *remoteFilePath = L"subdir1/subdir2/hamlet.xml";

    // Call the async version of the DownloadFileByName method to return a task object.
    // The task object is loaded, but is in the Inert state -- meaning it is
    // not yet scheduled to run on Chilkat's background thread pool.
    CkTaskW *task = sftp.DownloadFileByNameAsync(remoteFilePath,localFilePath);
    if (sftp.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",sftp.lastErrorText());
        return;
    }

    // Before starting the task, tell it to keep an in-memory log of what would've been
    // ProgressInfo callbacks.
    task->put_KeepProgressLog(true);

    // Schedule the task for running on the thread pool.  This changes the task's state
    // from Inert to Live.
    success = task->Run();
    if (success != true) {
        wprintf(L"%s\n",task->lastErrorText());
        delete task;
        return;
    }

    // The application is now free to do anything else
    // while the file is being downloaded.

    // For this example, we'll simply sleep and periodically
    // check to see if the download is finished, and report the progress
    // along the way.
    int curPctDone = 0;
    const wchar_t *name = 0;
    const wchar_t *value = 0;

    while (task->get_Finished() != true) {

        if (task->get_PercentDone() != curPctDone) {
            curPctDone = task->get_PercentDone();
            wprintf(L"%d percent done\n",curPctDone);
        }

        // Check the progress info log.
        // Emit any log entries..
        while ((task->get_ProgressLogSize() > 0)) {
            // Get the 1st entry, emit it, and then remove it..
            name = task->progressInfoName(0);
            value = task->progressInfoValue(0);

            // Entries reporting the received byte count will have the name "RcvByteCount"
            // Entries reporting the current bytes-per-second will have the name "RcvBytesPerSec"

            wprintf(L"%s: %s\n",name,value);
            task->RemoveProgressInfo(0);
        }

        // Sleep 100 ms.
        task->SleepMs(100);

    }

    // Just in case there are any remaining entries...
    while ((task->get_ProgressLogSize() > 0)) {
        // Get the 1st entry, emit it, and then remove it..
        name = task->progressInfoName(0);
        value = task->progressInfoValue(0);
        wprintf(L"%s: %s\n",name,value);
        task->RemoveProgressInfo(0);
    }

    // A finished task could be one that was canceled, aborted, or truly finished.  

    // If the task was "canceled", it was canceled prior to actually starting.  This could
    // happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
    // background thread pool scheduler.  

    // If the task was "aborted", it indicates that it was canceled while running in a background thread.  
    // The ResultErrorText will likely indicate that the task was aborted.

    // If the task "completed", then it ran to completion, but the actual success/failure of the method
    // is determined by the result obtained via a GetResult* method.  (A "completed" task will
    // have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
    // been aborted or canceled:
    if (task->get_StatusInt() != 7) {
        wprintf(L"Task did not complete.\n");
        wprintf(L"task status: %s\n",task->status());
        delete task;
        return;
    }

    // The DownloadFileByName method returns a boolean.  Therefore, after the task is finished,
    // we can get the boolean result by calling GetResultBool.  This is the return value had
    // we called DownloadFileByName synchronously.
    success = task->GetResultBool();
    if (success != true) {
        // The task's ResultErrorText contains what would have been in the LastErrorText property had
        // the DownloadFileByName method been called synchronously.
        wprintf(L"%s\n",task->resultErrorText());
    }
    else {
        wprintf(L"File downloaded asynchronously.\n");
    }

    delete task;
    }