(Objective-C) Wait for Async Method to Complete

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.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoSFtp.h>
#import <NSString.h>
#import <CkoTask.h>

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

CkoSFtp *sftp = [[CkoSFtp alloc] init];

// Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = [NSNumber numberWithInt:15000];
sftp.IdleTimeoutMs = [NSNumber numberWithInt:15000];
int waitMaxMs = 30000;

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
int port = 22;
NSString *domain = @"sftp.example.com";

CkoTask *task = [sftp ConnectAsync: domain port: [NSNumber numberWithInt: port]];
if (sftp.LastMethodSuccess == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// Start the background task.
BOOL success = [task Run];
if (!success) {
    NSLog(@"%@",task.LastErrorText);
}

// Wait for the connect task to finish.
// The YES/NO returned by Wait applies to the Wait method call, not the task.
success = [task Wait: [NSNumber numberWithInt: waitMaxMs]];
if (!success || ([task.StatusInt intValue] != 7) || (task.TaskSuccess != YES)) {
    if (!success) {
        // The task.LastErrorText applies to the Wait method call.
        NSLog(@"%@",task.LastErrorText);
    }
    else {
        // The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        NSLog(@"%@",task.Status);
        NSLog(@"%@",task.ResultErrorText);
    }

    return;
}

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
task = [sftp AuthenticatePwAsync: @"myLogin" password: @"myPassword"];
// To keep the example short, we'll skip handling failures.
// The failures would be handled in the same way as shown above.

success = [task Run];
success = [task Wait: [NSNumber numberWithInt: waitMaxMs]];

// After authenticating, the SFTP subsystem must be initialized:
task = [sftp InitializeSftpAsync];
success = [task Run];
success = [task Wait: [NSNumber numberWithInt: waitMaxMs]];

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

task = [sftp UploadFileByNameAsync: remoteFilePath localFilePath: localFilePath];
if (sftp.LastMethodSuccess == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

success = [task Run];
success = [task Wait: [NSNumber numberWithInt: waitMaxMs]];
if (!success || ([task.StatusInt intValue] != 7) || (task.TaskSuccess != YES)) {
    if (!success) {
        // The task.LastErrorText applies to the Wait method call.
        NSLog(@"%@",task.LastErrorText);
    }
    else {
        // The ResultErrorText applies to the underlying task method call (i.e. the Connect)
        NSLog(@"%@",task.Status);
        NSLog(@"%@",task.ResultErrorText);
    }

    return;
}

NSLog(@"%@",@"File uploaded.");