(Tcl) Async Progress Info Log

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# All Chilkat classes can be unlocked at once at the beginning of a program
# by calling UnlockBundle.  It requires a Bundle unlock code.
set chilkatGlob [new_CkGlobal]

set success [CkGlobal_UnlockBundle $chilkatGlob "Anything for 30-day trial."]
if {$success != 1} then {
    puts [CkGlobal_lastErrorText $chilkatGlob]
    delete_CkGlobal $chilkatGlob
    exit
}

# The mailman object is used for sending and receiving email.
set mailman [new_CkMailMan]

# Set the SMTP server and any required settings.
CkMailMan_put_SmtpHost $mailman "smtp.mymailserver.com"
CkMailMan_put_SmtpUsername $mailman "myLogin"
CkMailMan_put_SmtpPassword $mailman "myPassword"
CkMailMan_put_StartTLS $mailman 1

# Create a new email object
set email [new_CkEmail]

CkEmail_put_Subject $email "This is a test"
CkEmail_put_Body $email "This is a test"
CkEmail_put_From $email "Chilkat Support <support@chilkatsoft.com>"
set success [CkEmail_AddTo $email "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
set task [CkMailMan_SendEmailAsync $mailman $email]
if {[CkMailMan_get_LastMethodSuccess $mailman] == 0} then {
    puts [CkMailMan_lastErrorText $mailman]
    delete_CkGlobal $chilkatGlob
    delete_CkMailMan $mailman
    delete_CkEmail $email
    exit
}

# Before starting the task, tell it to keep an in-memory log of what would've been
# ProgressInfo event callbacks.
CkTask_put_KeepProgressLog $task 1

# Schedule the task for running on the thread pool.  This changes the task's state
# from Inert to Live.
set success [CkTask_Run $task]
if {$success != 1} then {
    puts [CkTask_lastErrorText $task]
    delete_CkTask $task

    delete_CkGlobal $chilkatGlob
    delete_CkMailMan $mailman
    delete_CkEmail $email
    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.
set curPctDone 0

while {[CkTask_get_Finished $task] != 1} {

    if {[CkTask_get_PercentDone $task] != $curPctDone} then {
        set curPctDone [CkTask_get_PercentDone $task]
        puts "$curPctDone percent done"
    }

    # Check the progress info log.
    # Emit any log entries..
    while {[CkTask_get_ProgressLogSize $task] > 0} {
        # Get the 1st entry, emit it, and then remove it..
        set name [CkTask_progressInfoName $task 0]
        set value [CkTask_progressInfoValue $task 0]
        puts "$name: $value"
        CkTask_RemoveProgressInfo $task 0
    }

    # Sleep 100 ms.
    CkTask_SleepMs $task 100

}

# Just in case there are any remaining entries...
while {[CkTask_get_ProgressLogSize $task] > 0} {
    # Get the 1st entry, emit it, and then remove it..
    set name [CkTask_progressInfoName $task 0]
    set value [CkTask_progressInfoValue $task 0]
    puts "$name: $value"
    CkTask_RemoveProgressInfo $task 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 {[CkTask_get_StatusInt $task] != 7} then {
    puts "Task did not complete."
    puts "task status: [CkTask_status $task]"
    delete_CkTask $task

    delete_CkGlobal $chilkatGlob
    delete_CkMailMan $mailman
    delete_CkEmail $email
    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.
set success [CkTask_GetResultBool $task]
if {$success != 1} then {
    # The task's ResultErrorText contains what would have been in the LastErrorText property had
    # the SendEmail method been called synchronously.
    puts [CkTask_resultErrorText $task]
} else {
    puts "Email sent asynchronously."
}

delete_CkTask $task

set success [CkMailMan_CloseSmtpConnection $mailman]
if {$success != 1} then {
    puts "Connection to SMTP server not closed cleanly."

}


delete_CkGlobal $chilkatGlob
delete_CkMailMan $mailman
delete_CkEmail $email