VBScript

Async Task Chain

See more Async Examples

Demonstrates how to combine a sequence of asynchronous tasks into a single task chain to be run in a background thread. VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

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

success = 0

set mailman = CreateObject("Chilkat.MailMan")

' Set the POP3 server's hostname
mailman.MailHost = "pop.example.com"

' Set the POP3 login/password and any other requirements..
mailman.PopUsername = "myLogin"
mailman.PopPassword = "myPassword"
mailman.PopSsl = 1
mailman.MailPort = 995

' Connect to the POP3 server:
success = mailman.Pop3BeginSession()
If (Not success) Then
    outFile.WriteLine(mailman.LastErrorText)
    WScript.Quit
End If

' Get the number of messages in the mailbox.
numMessages = mailman.GetMailboxCount()
If (numMessages = 0) Then
    outFile.WriteLine("No email messages in the POP3 mailbox.")
    WScript.Quit
End If

set taskChain = CreateObject("Chilkat.TaskChain")

' Create async task objects to fetch each email message
' by its sequence number

For i = 1 To numMessages

    ' task is a Chilkat.Task
    Set task = mailman.FetchByMsgnumAsync(i)
    If (mailman.LastMethodSuccess = 0) Then
        outFile.WriteLine(mailman.LastErrorText)
        WScript.Quit
    End If

    ' Append each task to the task chain.
    success = taskChain.Append(task)
    If (Not success) Then
        outFile.WriteLine(taskChain.LastErrorText)
        WScript.Quit
    End If

Next

' At this point, no tasks have actually started running.
' All we've done so far is to create tasks for the work that will be done
' when the task chain is run.

' Start the task chain running in a background thread.
' Each task is run one after the other (on the same background thread) until all tasks have completed.
' The task chain will stop at the first task that fails.
taskChain.StopOnFailedTask = 1
success = taskChain.Run()
If (Not success) Then
    outFile.WriteLine(taskChain.LastErrorText)
    WScript.Quit
End If

' The application is now free to do anything else
' while the emails are being downloaded

' For this example, we'll simply sleep and periodically
' check to see if the taskchain if finished. 
Do While taskChain.Finished <> 1

    ' Sleep 100 ms.
    taskChain.SleepMs 100

Loop

' A finished task chain could be one that was canceled, aborted, or truly finished.  

' If the task chain "completed", then it ran to completion.  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 (taskChain.StatusInt <> 7) Then
    outFile.WriteLine("Task did not complete.")
    outFile.WriteLine("task chain status: " & taskChain.Status)
    WScript.Quit
End If

set email = CreateObject("Chilkat.Email")

numTasks = taskChain.NumTasks
taskIdx = 0

Do While (taskIdx < numTasks)

    ' task is a Chilkat.Task
    Set task = taskChain.GetTask(taskIdx)

    ' Load the email object with email downloaded by this task.
    success = email.LoadTaskResult(task)
    If (Not success) Then
        outFile.WriteLine("Failed to load email object for task.")
    Else
        outFile.WriteLine(email.From & "; " & email.Subject)
    End If

    taskIdx = taskIdx + 1
Loop

outFile.Close