(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

sftp = Chilkat::CkSFtp.new()

# Set some timeouts, in milliseconds:
sftp.put_ConnectTimeoutMs(15000)
sftp.put_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
domain = "sftp.example.com"

# task is a CkTask
task = sftp.ConnectAsync(domain,port)
if (sftp.get_LastMethodSuccess() == false)
    print sftp.lastErrorText() + "\n";
    exit
end

# Start the background task.
success = task.Run()
if (!success)
    print task.lastErrorText() + "\n";
end

# 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 (!success or (task.get_StatusInt() != 7) or (task.get_TaskSuccess() != true))
    if (!success)
        # The task.LastErrorText applies to the Wait method call.
        print task.lastErrorText() + "\n";
    else
        # The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        print task.status() + "\n";
        print task.resultErrorText() + "\n";
    end

    exit
end

# 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.get_LastMethodSuccess() == false)
    print sftp.lastErrorText() + "\n";
    exit
end

success = task.Run()
success = task.Wait(waitMaxMs)
if (!success or (task.get_StatusInt() != 7) or (task.get_TaskSuccess() != true))
    if (!success)
        # The task.LastErrorText applies to the Wait method call.
        print task.lastErrorText() + "\n";
    else
        # The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        print task.status() + "\n";
        print task.resultErrorText() + "\n";
    end

    exit
end

print "File uploaded." + "\n";