AutoIt

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

Local $bSuccess = False

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

$oSftp = ObjCreate("Chilkat.SFtp")

;  Set some timeouts, in milliseconds:
$oSftp.ConnectTimeoutMs = 15000
$oSftp.IdleTimeoutMs = 15000

;  Connect to the SFTP server.  
$bSuccess = $oSftp.Connect("sftp.example.com",22)
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

;  Authenticate with the SSH server.  Chilkat SFTP supports
;  both password-based authenication as well as public-key
;  authentication.  This example uses password authenication.
$bSuccess = $oSftp.AuthenticatePw("myLogin","myPassword")
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

;  After authenticating, the SFTP subsystem must be initialized:
$bSuccess = $oSftp.InitializeSftp()
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

;  --------------------
;  Download a file
;  --------------------
Local $sLocalFilePath = "c:/temp/hamlet.xml"
Local $sRemoteFilePath = "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.
Local $oTask = $oSftp.DownloadFileByNameAsync($sRemoteFilePath,$sLocalFilePath)
If ($oSftp.LastMethodSuccess = False) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

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

;  Schedule the task for running on the thread pool.  This changes the task's state
;  from Inert to Live.
$bSuccess = $oTask.Run()
If ($bSuccess <> True) Then
    ConsoleWrite($oTask.LastErrorText & @CRLF)

    Exit
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.
Local $iCurPctDone = 0
Local $sName
Local $sValue

While $oTask.Finished <> True

    If ($oTask.PercentDone <> $iCurPctDone) Then
        $iCurPctDone = $oTask.PercentDone
        ConsoleWrite($iCurPctDone & " percent done" & @CRLF)
    EndIf

    ;  Check the progress info log.
    ;  Emit any log entries..
    While ($oTask.ProgressLogSize > 0)
        ;  Get the 1st entry, emit it, and then remove it..
        $sName = $oTask.ProgressInfoName(0)
        $sValue = $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"

        ConsoleWrite($sName & ": " & $sValue & @CRLF)
        $oTask.RemoveProgressInfo 0
    Wend

    ;  Sleep 100 ms.
    $oTask.SleepMs 100

Wend

;  Just in case there are any remaining entries...
While ($oTask.ProgressLogSize > 0)
    ;  Get the 1st entry, emit it, and then remove it..
    $sName = $oTask.ProgressInfoName(0)
    $sValue = $oTask.ProgressInfoValue(0)
    ConsoleWrite($sName & ": " & $sValue & @CRLF)
    $oTask.RemoveProgressInfo 0
Wend

;  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) Then
    ConsoleWrite("Task did not complete." & @CRLF)
    ConsoleWrite("task status: " & $oTask.Status & @CRLF)

    Exit
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.
$bSuccess = $oTask.GetResultBool()
If ($bSuccess <> True) Then
    ;  The task's ResultErrorText contains what would have been in the LastErrorText property had
    ;  the DownloadFileByName method been called synchronously.
    ConsoleWrite($oTask.ResultErrorText & @CRLF)
Else
    ConsoleWrite("File downloaded asynchronously." & @CRLF)
EndIf