(Tcl) Async Methods Returning an String

Demonstrates how to call an asynchronous method that returns a string. This example sends an HTTPS GET request to a URL and gets the HTML response.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# task is a CkTask
set task [CkHttp_QuickGetStrAsync $http "https://www.chilkatsoft.com/helloWorld.html"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

# Start the background task.
set success [CkTask_Run $task]
if {!$success} then {
    puts [CkTask_lastErrorText $task]
    delete_CkTask $task

    delete_CkHttp $http
    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 HTTPS GET if finished.
while {[CkTask_get_Finished $task] != 1} {
    # Sleep 100 ms.
    CkTask_SleepMs $task 100
}

# 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_CkHttp $http
    exit
}

# The QuickGetStr method returns a string.  Therefore, after the task is finished,
# we can get the string result by calling GetResultString.  This is the return value had
# we called QuickGetStr synchronously.
set html [CkTask_getResultString $task]

puts "$html"

delete_CkTask $task


delete_CkHttp $http