(Chilkat2-Python) 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.

Chilkat2 Python Downloads install with pip pip3 install chilkat2 or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

# All Chilkat classes can be unlocked at once at the beginning of a program
# by calling UnlockBundle.  It requires a Bundle unlock code.
chilkatGlob = chilkat2.Global()
success = chilkatGlob.UnlockBundle("Anything for 30-day trial.")
if (success != True):
    print(chilkatGlob.LastErrorText)
    sys.exit()

sftp = chilkat2.SFtp()

# Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 15000
sftp.IdleTimeoutMs = 15000
waitMaxMs = 30000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
port = 22
hostname = "www.my-ssh-server.com"

# task is a CkTask
task = sftp.ConnectAsync(hostname,port)
if (sftp.LastMethodSuccess == False):
    print(sftp.LastErrorText)
    sys.exit()

# Start the background task.
success = task.Run()
if (not success):
    print(task.LastErrorText)

# Wait for the connect task to finish.
# The True/False returned by Wait applies to the Wait method call, not the task.
success = task.Wait(waitMaxMs)
if (not success or (task.StatusInt != 7) or (task.TaskSuccess != True)):
    if (not success):
        # The task.LastErrorText applies to the Wait method call.
        print(task.LastErrorText)
    else:
        # The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        print(task.Status)
        print(task.ResultErrorText)

    sys.exit()

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
# task is a CkTask
task = sftp.AuthenticatePwAsync("myLogin","myPassword")
# To keep the example short, we'll skip handling failures.
# The failures would be handled in the same way as shown above.

success = task.Run()
success = task.Wait(waitMaxMs)

# After authenticating, the SFTP subsystem must be initialized:
# task is a CkTask
task = sftp.InitializeSftpAsync()
success = task.Run()
success = task.Wait(waitMaxMs)

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

# task is a CkTask
task = sftp.UploadFileByNameAsync(remoteFilePath,localFilePath)
if (sftp.LastMethodSuccess == False):
    print(sftp.LastErrorText)
    sys.exit()

success = task.Run()
success = task.Wait(waitMaxMs)
if (not success or (task.StatusInt != 7) or (task.TaskSuccess != True)):
    if (not success):
        # The task.LastErrorText applies to the Wait method call.
        print(task.LastErrorText)
    else:
        # The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        print(task.Status)
        print(task.ResultErrorText)

    sys.exit()

print("File uploaded.")