Perl

Async SFTP Progress Info

See more SFTP Examples

Demonstrates checking for progress info updates when running a task asynchronously. This example demonstrates an SFTP download. Perl

use chilkat();

$success = 0;

# 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);

# Connect to the SFTP server.  
$success = $sftp->Connect("sftp.example.com",22);
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
$success = $sftp->AuthenticatePw("myLogin","myPassword");
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# After authenticating, the SFTP subsystem must be initialized:
$success = $sftp->InitializeSftp();
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# --------------------
# Download a file
# --------------------
$localFilePath = "c:/temp/hamlet.xml";
$remoteFilePath = "subdir1/subdir2/hamlet.xml";

# Call the async version of the DownloadFileByName method to return a task object.
# The task object is loaded, but is in the Inert state -- meaning it is
# not yet scheduled to run on Chilkat's background thread pool.
# task is a Task
$task = $sftp->DownloadFileByNameAsync($remoteFilePath,$localFilePath);
if ($sftp->get_LastMethodSuccess() == 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Before starting the task, tell it to keep an in-memory log of what would've been
# ProgressInfo callbacks.
$task->put_KeepProgressLog(1);

# Schedule the task for running on the thread pool.  This changes the task's state
# from Inert to Live.
$success = $task->Run();
if ($success != 1) {
    print $task->lastErrorText() . "\r\n";

    exit;
}

# The application is now free to do anything else
# while the file is being downloaded.

# For this example, we'll simply sleep and periodically
# check to see if the download is finished, and report the progress
# along the way.
$curPctDone = 0;

while ($task->get_Finished() != 1) {

    if ($task->get_PercentDone() != $curPctDone) {
        $curPctDone = $task->get_PercentDone();
        print $curPctDone . " percent done" . "\r\n";
    }

    # Check the progress info log.
    # Emit any log entries..
    while (($task->get_ProgressLogSize() > 0)) {
        # Get the 1st entry, emit it, and then remove it..
        $name = $task->progressInfoName(0);
        $value = $task->progressInfoValue(0);

        # Entries reporting the received byte count will have the name "RcvByteCount"
        # Entries reporting the current bytes-per-second will have the name "RcvBytesPerSec"

        print $name . ": " . $value . "\r\n";
        $task->RemoveProgressInfo(0);
    }

    # Sleep 100 ms.
    $task->SleepMs(100);

}

# Just in case there are any remaining entries...
while (($task->get_ProgressLogSize() > 0)) {
    # Get the 1st entry, emit it, and then remove it..
    $name = $task->progressInfoName(0);
    $value = $task->progressInfoValue(0);
    print $name . ": " . $value . "\r\n";
    $task->RemoveProgressInfo(0);
}

# 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 ($task->get_StatusInt() != 7) {
    print "Task did not complete." . "\r\n";
    print "task status: " . $task->status() . "\r\n";

    exit;
}

# The DownloadFileByName method returns a boolean.  Therefore, after the task is finished,
# we can get the boolean result by calling GetResultBool.  This is the return value had
# we called DownloadFileByName synchronously.
$success = $task->GetResultBool();
if ($success != 1) {
    # The task's ResultErrorText contains what would have been in the LastErrorText property had
    # the DownloadFileByName method been called synchronously.
    print $task->resultErrorText() . "\r\n";
}
else {
    print "File downloaded asynchronously." . "\r\n";
}