Objective-C

SFTP Upload with Bandwidth Throttling

Demonstrates how to upload a file to an SSH server in the simplest way with bandwidth throttling. Bandwidth throttling for all SFTP communications can be achieved by simply setting the BandwidthThrottleUp or BandwidthThrottleDown properties. (One limits the transfer rate for uploads, the other for downloads.) Objective-C

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

BOOL success = NO;

//  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];

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
NSString *hostname = @"sftp.example.com";
int port = 22;
success = [sftp Connect: hostname port: [NSNumber numberWithInt: port]];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
success = [sftp AuthenticatePw: @"myLogin" password: @"myPassword"];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  After authenticating, the SFTP subsystem must be initialized:
success = [sftp InitializeSftp];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Limit the transfer rate (bandwidth throttle) to 64K per second.
sftp.BandwidthThrottleUp = [NSNumber numberWithInt:65536];

//  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";

success = [sftp UploadFileByName: remoteFilePath localFilePath: localFilePath];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

NSLog(@"%@",@"Success.");