Visual FoxPro

Wait for Async Method to Complete

See more Async Examples

Demonstrates using the Wait method to wait for an asynchronous method to complete. This example will do an SFTP upload (over SSH) and will use the Async version of each method. Obviously, waiting for the async method to complete is the same as making a synchronous call, but an application wouldn't typically do this. An application might, for example, do other things as a background task is running, and then later wait for the task to complete. Visual FoxPro

LOCAL lnSuccess
LOCAL loSftp
LOCAL lnWaitMaxMs
LOCAL lnPort
LOCAL lcDomain
LOCAL loTask
LOCAL lcRemoteFilePath
LOCAL lcLocalFilePath

lnSuccess = 0

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

loSftp = CreateObject('Chilkat.SFtp')

* Set some timeouts, in milliseconds:
loSftp.ConnectTimeoutMs = 15000
loSftp.IdleTimeoutMs = 15000
lnWaitMaxMs = 30000

* Connect to the SSH server.  
* The standard SSH port = 22
* The hostname may be a hostname or IP address.
lnPort = 22
lcDomain = "sftp.example.com"

loTask = loSftp.ConnectAsync(lcDomain,lnPort)
IF (loSftp.LastMethodSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

* Start the background task.
lnSuccess = loTask.Run()
IF (NOT lnSuccess) THEN
    ? loTask.LastErrorText
ENDIF

* Wait for the connect task to finish.
* The 1/0 returned by Wait applies to the Wait method call, not the task.
lnSuccess = loTask.Wait(lnWaitMaxMs)
IF (NOT lnSuccess OR (loTask.StatusInt <> 7) OR (loTask.TaskSuccess <> 1)) THEN
    IF (NOT lnSuccess) THEN
        * The task.LastErrorText applies to the Wait method call.
        ? loTask.LastErrorText
    ELSE
        * The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        ? loTask.Status
        ? loTask.ResultErrorText
    ENDIF

    RELEASE loTask
    RELEASE loSftp
    CANCEL
ENDIF

RELEASE loTask

* Authenticate with the SSH server.  Chilkat SFTP supports
* both password-based authenication as well as public-key
* authentication.  This example uses password authenication.
loTask = loSftp.AuthenticatePwAsync("myLogin","myPassword")
* To keep the example short, we'll skip handling failures.
* The failures would be handled in the same way as shown above.

lnSuccess = loTask.Run()
lnSuccess = loTask.Wait(lnWaitMaxMs)
RELEASE loTask

* After authenticating, the SFTP subsystem must be initialized:
loTask = loSftp.InitializeSftpAsync()
lnSuccess = loTask.Run()
lnSuccess = loTask.Wait(lnWaitMaxMs)
RELEASE loTask

* Upload from the local file to the SSH server.
* Important -- the remote filepath is the 1st argument,
* the local filepath is the 2nd argument;
lcRemoteFilePath = "hamlet.xml"
lcLocalFilePath = "c:/temp/hamlet.xml"

loTask = loSftp.UploadFileByNameAsync(lcRemoteFilePath,lcLocalFilePath)
IF (loSftp.LastMethodSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

lnSuccess = loTask.Run()
lnSuccess = loTask.Wait(lnWaitMaxMs)
IF (NOT lnSuccess OR (loTask.StatusInt <> 7) OR (loTask.TaskSuccess <> 1)) THEN
    IF (NOT lnSuccess) THEN
        * The task.LastErrorText applies to the Wait method call.
        ? loTask.LastErrorText
    ELSE
        * The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        ? loTask.Status
        ? loTask.ResultErrorText
    ENDIF

    RELEASE loTask
    RELEASE loSftp
    CANCEL
ENDIF

RELEASE loTask
? "File uploaded."

RELEASE loSftp