PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Sftp
integer li_WaitMaxMs
integer li_Port
string ls_Domain
oleobject loo_Task
string ls_RemoteFilePath
string ls_LocalFilePath

li_Success = 0

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

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Set some timeouts, in milliseconds:
loo_Sftp.ConnectTimeoutMs = 15000
loo_Sftp.IdleTimeoutMs = 15000
li_WaitMaxMs = 30000

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

loo_Task = loo_Sftp.ConnectAsync(ls_Domain,li_Port)
if loo_Sftp.LastMethodSuccess = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// Start the background task.
li_Success = loo_Task.Run()
if not li_Success then
    Write-Debug loo_Task.LastErrorText
end if

// Wait for the connect task to finish.
// The 1/0 returned by Wait applies to the Wait method call, not the task.
li_Success = loo_Task.Wait(li_WaitMaxMs)
if not li_Success OR (loo_Task.StatusInt <> 7) OR (loo_Task.TaskSuccess <> 1) then
    if not li_Success then
        // The task.LastErrorText applies to the Wait method call.
        Write-Debug loo_Task.LastErrorText
    else
        // The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        Write-Debug loo_Task.Status
        Write-Debug loo_Task.ResultErrorText
    end if

    destroy loo_Task
    destroy loo_Sftp
    return
end if

destroy loo_Task

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

li_Success = loo_Task.Run()
li_Success = loo_Task.Wait(li_WaitMaxMs)
destroy loo_Task

// After authenticating, the SFTP subsystem must be initialized:
loo_Task = loo_Sftp.InitializeSftpAsync()
li_Success = loo_Task.Run()
li_Success = loo_Task.Wait(li_WaitMaxMs)
destroy loo_Task

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

loo_Task = loo_Sftp.UploadFileByNameAsync(ls_RemoteFilePath,ls_LocalFilePath)
if loo_Sftp.LastMethodSuccess = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

li_Success = loo_Task.Run()
li_Success = loo_Task.Wait(li_WaitMaxMs)
if not li_Success OR (loo_Task.StatusInt <> 7) OR (loo_Task.TaskSuccess <> 1) then
    if not li_Success then
        // The task.LastErrorText applies to the Wait method call.
        Write-Debug loo_Task.LastErrorText
    else
        // The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        Write-Debug loo_Task.Status
        Write-Debug loo_Task.ResultErrorText
    end if

    destroy loo_Task
    destroy loo_Sftp
    return
end if

destroy loo_Task
Write-Debug "File uploaded."


destroy loo_Sftp