PowerBuilder

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. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Sftp
string ls_LocalFilePath
string ls_RemoteFilePath
oleobject loo_Task
integer li_CurPctDone
string ls_Name
string ls_Value

li_Success = 0

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

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Set some timeouts, in milliseconds:
loo_Sftp.ConnectTimeoutMs = 15000
loo_Sftp.IdleTimeoutMs = 15000

// Connect to the SFTP server.  
li_Success = loo_Sftp.Connect("sftp.example.com",22)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
li_Success = loo_Sftp.AuthenticatePw("myLogin","myPassword")
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// After authenticating, the SFTP subsystem must be initialized:
li_Success = loo_Sftp.InitializeSftp()
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// --------------------
// Download a file
// --------------------
ls_LocalFilePath = "c:/temp/hamlet.xml"
ls_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.
loo_Task = loo_Sftp.DownloadFileByNameAsync(ls_RemoteFilePath,ls_LocalFilePath)
if loo_Sftp.LastMethodSuccess = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// Before starting the task, tell it to keep an in-memory log of what would've been
// ProgressInfo callbacks.
loo_Task.KeepProgressLog = 1

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.
li_Success = loo_Task.Run()
if li_Success <> 1 then
    Write-Debug loo_Task.LastErrorText
    destroy loo_Task
    destroy loo_Sftp
    return
end if

// 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.
li_CurPctDone = 0

do while loo_Task.Finished <> 1

    if loo_Task.PercentDone <> li_CurPctDone then
        li_CurPctDone = loo_Task.PercentDone
        Write-Debug string(li_CurPctDone) + " percent done"
    end if

    // Check the progress info log.
    // Emit any log entries..
    do while (loo_Task.ProgressLogSize > 0)
        // Get the 1st entry, emit it, and then remove it..
        ls_Name = loo_Task.ProgressInfoName(0)
        ls_Value = loo_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"

        Write-Debug ls_Name + ": " + ls_Value
        loo_Task.RemoveProgressInfo(0)
    loop

    // Sleep 100 ms.
    loo_Task.SleepMs(100)

loop

// Just in case there are any remaining entries...
do while (loo_Task.ProgressLogSize > 0)
    // Get the 1st entry, emit it, and then remove it..
    ls_Name = loo_Task.ProgressInfoName(0)
    ls_Value = loo_Task.ProgressInfoValue(0)
    Write-Debug ls_Name + ": " + ls_Value
    loo_Task.RemoveProgressInfo(0)
loop

// 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 loo_Task.StatusInt <> 7 then
    Write-Debug "Task did not complete."
    Write-Debug "task status: " + loo_Task.Status
    destroy loo_Task
    destroy loo_Sftp
    return
end if

// 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.
li_Success = loo_Task.GetResultBool()
if li_Success <> 1 then
    // The task's ResultErrorText contains what would have been in the LastErrorText property had
    // the DownloadFileByName method been called synchronously.
    Write-Debug loo_Task.ResultErrorText
else
    Write-Debug "File downloaded asynchronously."
end if

destroy loo_Task


destroy loo_Sftp