Xbase++

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. Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL cLocalFilePath
LOCAL cRemoteFilePath
LOCAL oTask
LOCAL nCurPctDone
LOCAL cName
LOCAL cValue

nSuccess := 0

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

oSftp := CreateObject("Chilkat.SFtp")

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

//  Connect to the SFTP server.  
nSuccess := oSftp:Connect("sftp.example.com", 22)
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
nSuccess := oSftp:AuthenticatePw("myLogin", "myPassword")
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  After authenticating, the SFTP subsystem must be initialized:
nSuccess := oSftp:InitializeSftp()
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  --------------------
//  Download a file
//  --------------------
cLocalFilePath := "c:/temp/hamlet.xml"
cRemoteFilePath := "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.
oTask := oSftp:DownloadFileByNameAsync(cRemoteFilePath, cLocalFilePath)
IF (oSftp:LastMethodSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

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

//  Schedule the task for running on the thread pool.  This changes the task's state
//  from Inert to Live.
nSuccess := oTask:Run()
IF (nSuccess != 1)
    ? oTask:LastErrorText
    oTask:destroy()
    oSftp:destroy()
    RETURN
ENDIF

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

DO WHILE oTask:Finished != 1

    IF (oTask:PercentDone != nCurPctDone)
        nCurPctDone := oTask:PercentDone
        ? Str(nCurPctDone) + " percent done"
    ENDIF

    //  Check the progress info log.
    //  Emit any log entries..
    DO WHILE (oTask:ProgressLogSize > 0)
        //  Get the 1st entry, emit it, and then remove it..
        cName := oTask:ProgressInfoName(0)
        cValue := oTask: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"

        ? cName + ": " + cValue
        oTask:RemoveProgressInfo(0)
    ENDDO

    //  Sleep 100 ms.
    oTask:SleepMs(100)

ENDDO

//  Just in case there are any remaining entries...
DO WHILE (oTask:ProgressLogSize > 0)
    //  Get the 1st entry, emit it, and then remove it..
    cName := oTask:ProgressInfoName(0)
    cValue := oTask:ProgressInfoValue(0)
    ? cName + ": " + cValue
    oTask:RemoveProgressInfo(0)
ENDDO

//  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 (oTask:StatusInt != 7)
    ? "Task did not complete."
    ? "task status: " + oTask:Status
    oTask:destroy()
    oSftp:destroy()
    RETURN
ENDIF

//  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.
nSuccess := oTask:GetResultBool()
IF (nSuccess != 1)
    //  The task's ResultErrorText contains what would have been in the LastErrorText property had
    //  the DownloadFileByName method been called synchronously.
    ? oTask:ResultErrorText
ELSE
    ? "File downloaded asynchronously."
ENDIF

oTask:destroy()

oSftp:destroy()