Xbase++

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

LOCAL nSuccess
LOCAL oSftp
LOCAL nWaitMaxMs
LOCAL nPort
LOCAL cDomain
LOCAL oTask
LOCAL cRemoteFilePath
LOCAL cLocalFilePath

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
nWaitMaxMs := 30000

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
nPort := 22
cDomain := "sftp.example.com"

oTask := oSftp:ConnectAsync(cDomain, nPort)
IF (oSftp:LastMethodSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Start the background task.
nSuccess := oTask:Run()
IF (.NOT. nSuccess)
    ? oTask:LastErrorText
ENDIF

//  Wait for the connect task to finish.
//  The 1/0 returned by Wait applies to the Wait method call, not the task.
nSuccess := oTask:Wait(nWaitMaxMs)
IF (.NOT. nSuccess .OR. (oTask:StatusInt != 7) .OR. (oTask:TaskSuccess != 1))
    IF (.NOT. nSuccess)
        //  The task.LastErrorText applies to the Wait method call.
        ? oTask:LastErrorText
    ELSE
        //  The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        ? oTask:Status
        ? oTask:ResultErrorText
    ENDIF

    oTask:destroy()
    oSftp:destroy()
    RETURN
ENDIF

oTask:destroy()

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
oTask := oSftp: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.

nSuccess := oTask:Run()
nSuccess := oTask:Wait(nWaitMaxMs)
oTask:destroy()

//  After authenticating, the SFTP subsystem must be initialized:
oTask := oSftp:InitializeSftpAsync()
nSuccess := oTask:Run()
nSuccess := oTask:Wait(nWaitMaxMs)
oTask:destroy()

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

oTask := oSftp:UploadFileByNameAsync(cRemoteFilePath, cLocalFilePath)
IF (oSftp:LastMethodSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

nSuccess := oTask:Run()
nSuccess := oTask:Wait(nWaitMaxMs)
IF (.NOT. nSuccess .OR. (oTask:StatusInt != 7) .OR. (oTask:TaskSuccess != 1))
    IF (.NOT. nSuccess)
        //  The task.LastErrorText applies to the Wait method call.
        ? oTask:LastErrorText
    ELSE
        //  The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        ? oTask:Status
        ? oTask:ResultErrorText
    ENDIF

    oTask:destroy()
    oSftp:destroy()
    RETURN
ENDIF

oTask:destroy()
? "File uploaded."

oSftp:destroy()