(Lianja) Async Progress Info Log

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

// All Chilkat classes can be unlocked at once at the beginning of a program
// by calling UnlockBundle.  It requires a Bundle unlock code.
loChilkatGlob = createobject("CkGlobal")
llSuccess = loChilkatGlob.UnlockBundle("Anything for 30-day trial.")
if (llSuccess <> .T.) then
    ? loChilkatGlob.LastErrorText
    release loChilkatGlob
    return
endif

// The mailman object is used for sending and receiving email.
loMailman = createobject("CkMailMan")

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

// Create a new email object
loEmail = createobject("CkEmail")

loEmail.Subject = "This is a test"
loEmail.Body = "This is a test"
loEmail.From = "Chilkat Support <support@chilkatsoft.com>"
llSuccess = loEmail.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.
loTask = loMailman.SendEmailAsync(loEmail)
if (loMailman.LastMethodSuccess = .F.) then
    ? loMailman.LastErrorText
    release loChilkatGlob
    release loMailman
    release loEmail
    return
endif

// Before starting the task, tell it to keep an in-memory log of what would've been
// ProgressInfo event callbacks.
loTask.KeepProgressLog = .T.

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.
llSuccess = loTask.Run()
if (llSuccess <> .T.) then
    ? loTask.LastErrorText
    release loTask
    release loChilkatGlob
    release loMailman
    release loEmail
    return
endif

// 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.
lnCurPctDone = 0

do while loTask.Finished <> .T.

    if (loTask.PercentDone <> lnCurPctDone) then
        lnCurPctDone = loTask.PercentDone
        ? str(lnCurPctDone) + " percent done"
    endif

    // Check the progress info log.
    // Emit any log entries..
    do while (loTask.ProgressLogSize > 0)
        // Get the 1st entry, emit it, and then remove it..
        lcName = loTask.ProgressInfoName(0)
        lcValue = loTask.ProgressInfoValue(0)
        ? lcName + ": " + lcValue
        loTask.RemoveProgressInfo(0)
    enddo

    // Sleep 100 ms.
    loTask.SleepMs(100)

enddo

// Just in case there are any remaining entries...
do while (loTask.ProgressLogSize > 0)
    // Get the 1st entry, emit it, and then remove it..
    lcName = loTask.ProgressInfoName(0)
    lcValue = loTask.ProgressInfoValue(0)
    ? lcName + ": " + lcValue
    loTask.RemoveProgressInfo(0)
enddo

// 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 (loTask.StatusInt <> 7) then
    ? "Task did not complete."
    ? "task status: " + loTask.Status
    release loTask
    release loChilkatGlob
    release loMailman
    release loEmail
    return
endif

// 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.
llSuccess = loTask.GetResultBool()
if (llSuccess <> .T.) then
    // The task's ResultErrorText contains what would have been in the LastErrorText property had
    // the SendEmail method been called synchronously.
    ? loTask.ResultErrorText
else
    ? "Email sent asynchronously."
endif

release loTask

llSuccess = loMailman.CloseSmtpConnection()
if (llSuccess <> .T.) then
    ? "Connection to SMTP server not closed cleanly."

endif



release loChilkatGlob
release loMailman
release loEmail