CkPython

Async Progress Info Log

See more Async Examples

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

import sys
import chilkat

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.
mailman = chilkat.CkMailMan()

# 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
email = chilkat.CkEmail()

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.
# task is a CkTask
task = mailman.SendEmailAsync(email)
if (mailman.get_LastMethodSuccess() == False):
    print(mailman.lastErrorText())
    sys.exit()

# 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):
    print(task.lastErrorText())

    sys.exit()

# 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.
curPctDone = 0

while task.get_Finished() != True :

    if (task.get_PercentDone() != curPctDone):
        curPctDone = task.get_PercentDone()
        print(str(curPctDone) + " percent done")

    # 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)
        print(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)
    print(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):
    print("Task did not complete.")
    print("task status: " + task.status())

    sys.exit()

# 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.
    print(task.resultErrorText())
else:
    print("Email sent asynchronously.")

success = mailman.CloseSmtpConnection()
if (success != True):
    print("Connection to SMTP server not closed cleanly.")