(Tcl) Wait for Async Method to Complete

Demonstrates using the Wait method to wait for an asynchronous method to complete. This example will do an SFTP upload (over SSH) and will use the Async version of each method. Obviously, waiting for the async method to complete is the same as making a synchronous call, but an application wouldn't typically do this. An application might, for example, do other things as a background task is running, and then later wait for the task to complete.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set sftp [new_CkSFtp]

# Set some timeouts, in milliseconds:
CkSFtp_put_ConnectTimeoutMs $sftp 15000
CkSFtp_put_IdleTimeoutMs $sftp 15000
set waitMaxMs 30000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
set port 22
set domain "sftp.example.com"

# task is a CkTask
set task [CkSFtp_ConnectAsync $sftp $domain $port]
if {[CkSFtp_get_LastMethodSuccess $sftp] == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

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

# Wait for the connect task to finish.
# The 1/0 returned by Wait applies to the Wait method call, not the task.
set success [CkTask_Wait $task $waitMaxMs]
if {expr !$success  ||  [expr [[CkTask_get_StatusInt $task] != 7]  ||  [[CkTask_get_TaskSuccess $task] != 1]]} then {
    if {!$success} then {
        # The task.LastErrorText applies to the Wait method call.
        puts [CkTask_lastErrorText $task]
    }     else {
        # The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        puts [CkTask_status $task]
        puts [CkTask_resultErrorText $task]
    }

    delete_CkTask $task

    delete_CkSFtp $sftp
    exit
}

delete_CkTask $task

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
set task [CkSFtp_AuthenticatePwAsync $sftp "myLogin" "myPassword"]
# To keep the example short, we'll skip handling failures.
# The failures would be handled in the same way as shown above.

set success [CkTask_Run $task]
set success [CkTask_Wait $task $waitMaxMs]
delete_CkTask $task

# After authenticating, the SFTP subsystem must be initialized:
set task [CkSFtp_InitializeSftpAsync $sftp]
set success [CkTask_Run $task]
set success [CkTask_Wait $task $waitMaxMs]
delete_CkTask $task

# Upload from the local file to the SSH server.
# Important -- the remote filepath is the 1st argument,
# the local filepath is the 2nd argument;
set remoteFilePath "hamlet.xml"
set localFilePath "c:/temp/hamlet.xml"

set task [CkSFtp_UploadFileByNameAsync $sftp $remoteFilePath $localFilePath]
if {[CkSFtp_get_LastMethodSuccess $sftp] == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

set success [CkTask_Run $task]
set success [CkTask_Wait $task $waitMaxMs]
if {expr !$success  ||  [expr [[CkTask_get_StatusInt $task] != 7]  ||  [[CkTask_get_TaskSuccess $task] != 1]]} then {
    if {!$success} then {
        # The task.LastErrorText applies to the Wait method call.
        puts [CkTask_lastErrorText $task]
    }     else {
        # The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        puts [CkTask_status $task]
        puts [CkTask_resultErrorText $task]
    }

    delete_CkTask $task

    delete_CkSFtp $sftp
    exit
}

delete_CkTask $task

puts "File uploaded."

delete_CkSFtp $sftp