(C++) Async Progress Info Log

Demonstrates checking for progress info updates when running a task asynchronously.

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 <CkGlobal.h>
#include <CkMailMan.h>
#include <CkEmail.h>
#include <CkTask.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.
    CkGlobal chilkatGlob;
    bool success = chilkatGlob.UnlockBundle("Anything for 30-day trial.");
    if (success != true) {
        std::cout << chilkatGlob.lastErrorText() << "\r\n";
        return;
    }

    // The mailman object is used for sending and receiving email.
    CkMailMan mailman;

    // Set the SMTP server and any required settings.
    mailman.put_SmtpHost("smtp.mymailserver.com");
    mailman.put_SmtpUsername("myLogin");
    mailman.put_SmtpPassword("myPassword");
    mailman.put_StartTLS(true);

    // Create a new email object
    CkEmail email;

    email.put_Subject("This is a test");
    email.put_Body("This is a test");
    email.put_From("Chilkat Support <support@chilkatsoft.com>");
    success = email.AddTo("Chilkat Admin","admin@chilkatsoft.com");

    // Call the async version of the SendEmail 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.
    CkTask *task = mailman.SendEmailAsync(email);
    if (mailman.get_LastMethodSuccess() == false) {
        std::cout << mailman.lastErrorText() << "\r\n";
        return;
    }

    // Before starting the task, tell it to keep an in-memory log of what would've been
    // ProgressInfo event 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) {
        std::cout << task->lastErrorText() << "\r\n";
        delete task;
        return;
    }

    // The application is now free to do anything else
    // while the email is being sent.

    // For this example, we'll simply sleep and periodically
    // check to see if the SendEmail if finished.  While checking
    // however, we'll report on the progress.
    int curPctDone = 0;
    const char *name = 0;
    const char *value = 0;

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

        if (task->get_PercentDone() != curPctDone) {
            curPctDone = task->get_PercentDone();
            std::cout << curPctDone << " percent done" << "\r\n";
        }

        // 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);
            std::cout << name << ": " << value << "\r\n";
            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);
        std::cout << name << ": " << value << "\r\n";
        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) {
        std::cout << "Task did not complete." << "\r\n";
        std::cout << "task status: " << task->status() << "\r\n";
        delete task;
        return;
    }

    // The SendEmail 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 SendEmail synchronously.
    success = task->GetResultBool();
    if (success != true) {
        // The task's ResultErrorText contains what would have been in the LastErrorText property had
        // the SendEmail method been called synchronously.
        std::cout << task->resultErrorText() << "\r\n";
    }
    else {
        std::cout << "Email sent asynchronously." << "\r\n";
    }

    delete task;

    success = mailman.CloseSmtpConnection();
    if (success != true) {
        std::cout << "Connection to SMTP server not closed cleanly." << "\r\n";

    }
    }