(DataFlex) Async SFTP Progress Info

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoSftp
    Boolean iSuccess
    String sLocalFilePath
    String sRemoteFilePath
    Variant vTask
    Handle hoTask
    Integer iCurPctDone
    String sName
    String sValue
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    // Set some timeouts, in milliseconds:
    Set ComConnectTimeoutMs Of hoSftp To 15000
    Set ComIdleTimeoutMs Of hoSftp To 15000

    // Connect to the SFTP server.  
    Get ComConnect Of hoSftp "sftp.example.com" 22 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    Get ComAuthenticatePw Of hoSftp "myLogin" "myPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // After authenticating, the SFTP subsystem must be initialized:
    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // --------------------
    // Download a file
    // --------------------
    Move "c:/temp/hamlet.xml" To sLocalFilePath
    Move "subdir1/subdir2/hamlet.xml" To sRemoteFilePath

    // 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.
    Get ComDownloadFileByNameAsync Of hoSftp sRemoteFilePath sLocalFilePath To vTask
    If (IsComObject(vTask)) Begin
        Get Create (RefClass(cComChilkatTask)) To hoTask
        Set pvComObject Of hoTask To vTask
    End
    Get ComLastMethodSuccess Of hoSftp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Before starting the task, tell it to keep an in-memory log of what would've been
    // ProgressInfo callbacks.
    Set ComKeepProgressLog Of hoTask To True

    // Schedule the task for running on the thread pool.  This changes the task's state
    // from Inert to Live.
    Get ComRun Of hoTask To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoTask To sTemp1
        Showln sTemp1
        Send Destroy of hoTask
        Procedure_Return
    End

    // 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.
    Move 0 To iCurPctDone

    While ((ComFinished(hoTask)) <> True)

        Get ComPercentDone Of hoTask To iTemp1
        If (iTemp1 <> iCurPctDone) Begin
            Get ComPercentDone Of hoTask To iCurPctDone
            Showln iCurPctDone " percent done"
        End

        // Check the progress info log.
        // Emit any log entries..
        While ((ComProgressLogSize(hoTask)) > 0)
            // Get the 1st entry, emit it, and then remove it..
            Get ComProgressInfoName Of hoTask 0 To sName
            Get ComProgressInfoValue Of hoTask 0 To sValue

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

            Showln sName ": " sValue
            Send ComRemoveProgressInfo To hoTask 0
        Loop

        // Sleep 100 ms.
        Send ComSleepMs To hoTask 100

    Loop

    // Just in case there are any remaining entries...
    While ((ComProgressLogSize(hoTask)) > 0)
        // Get the 1st entry, emit it, and then remove it..
        Get ComProgressInfoName Of hoTask 0 To sName
        Get ComProgressInfoValue Of hoTask 0 To sValue
        Showln sName ": " sValue
        Send ComRemoveProgressInfo To hoTask 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:
    Get ComStatusInt Of hoTask To iTemp1
    If (iTemp1 <> 7) Begin
        Showln "Task did not complete."
        Get ComStatus Of hoTask To sTemp1
        Showln "task status: " sTemp1
        Send Destroy of hoTask
        Procedure_Return
    End

    // 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.
    Get ComGetResultBool Of hoTask To iSuccess
    If (iSuccess <> True) Begin
        // The task's ResultErrorText contains what would have been in the LastErrorText property had
        // the DownloadFileByName method been called synchronously.
        Get ComResultErrorText Of hoTask To sTemp1
        Showln sTemp1
    End
    Else Begin
        Showln "File downloaded asynchronously."
    End

    Send Destroy of hoTask


End_Procedure