Node.js

Async Progress Info Log

See more Async Examples

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

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  This example assumes the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    success = false;

    //  The mailman object is used for sending and receiving email.
    var mailman = new chilkat.MailMan();

    //  Set the SMTP server and any required settings.
    mailman.SmtpHost = "smtp.mymailserver.com";
    mailman.SmtpUsername = "myLogin";
    mailman.SmtpPassword = "myPassword";
    mailman.StartTLS = true;

    //  Create a new email object
    var email = new chilkat.Email();

    email.Subject = "This is a test";
    email.Body = "This is a test";
    email.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.
    // task: Task
    var task = mailman.SendEmailAsync(email);
    if (mailman.LastMethodSuccess == false) {
        console.log(mailman.LastErrorText);
        return;
    }

    //  Before starting the task, tell it to keep an in-memory log of what would've been
    //  ProgressInfo event callbacks.
    task.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) {
        console.log(task.LastErrorText);

        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.
    var curPctDone = 0;
    var name;
    var value;

    while (task.Finished !== true) {

        if (task.PercentDone !== curPctDone) {
            curPctDone = task.PercentDone;
            console.log(curPctDone + " percent done");
        }

        //  Check the progress info log.
        //  Emit any log entries..
        while ((task.ProgressLogSize > 0)) {
            //  Get the 1st entry, emit it, and then remove it..
            name = task.ProgressInfoName(0);
            value = task.ProgressInfoValue(0);
            console.log(name + ": " + value);
            task.RemoveProgressInfo(0);
        }

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

    }

    //  Just in case there are any remaining entries...
    while ((task.ProgressLogSize > 0)) {
        //  Get the 1st entry, emit it, and then remove it..
        name = task.ProgressInfoName(0);
        value = task.ProgressInfoValue(0);
        console.log(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.StatusInt !== 7) {
        console.log("Task did not complete.");
        console.log("task status: " + task.Status);

        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.
        console.log(task.ResultErrorText);
    }
    else {
        console.log("Email sent asynchronously.");
    }

    success = mailman.CloseSmtpConnection();
    if (success !== true) {
        console.log("Connection to SMTP server not closed cleanly.");

    }


}

chilkatExample();