CkoScp Objective-C Reference Documentation

CkoScp

An API for SCP over SSH. (SCP is the Secure Copy Protocol.) It is for transferring files or directory trees to or from remote servers. SCP is a simpler protocol than SFTP, and thus the functionality is more limited. However, SCP does not require that an SSH server support the SFTP subsystem. In cases where a server does not allow for SFTP, then SCP is a good choice for file transfer.

Properties

@property (nonatomic) BOOL AbortCurrent;

Introduced in version 9.5.0.58

When set to YES, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to NO when the next method is called. When the abort occurs, this property is reset to NO. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

@property (nonatomic, copy) NSString *DebugLogFilePath;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

@property (nonatomic, copy) NSNumber *HeartbeatMs;

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any SSH operation prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

@property (nonatomic, readonly, copy) NSString *LastErrorText;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

@property (nonatomic, readonly, copy) NSString *LastErrorXml;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

@property (nonatomic) BOOL LastMethodSuccess;

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

@property (nonatomic, copy) NSNumber *PercentDoneScale;

Introduced in version 9.5.0.51

This property is only valid in programming environment and languages that allow for event callbacks.

Sets the value to be defined as 100% complete for the purpose of PercentDone event callbacks. The defaut value of 100 means that at most 100 event PercentDone callbacks will occur in a method that (1) is event enabled and (2) is such that it is possible to measure progress as a percentage completed. This property may be set to larger numbers to get more fine-grained PercentDone callbacks. For example, setting this property equal to 1000 will provide callbacks with .1 percent granularity. For example, a value of 453 would indicate 45.3% competed. This property is clamped to a minimum value of 10, and a maximum value of 100000.

@property (nonatomic, copy) NSString *SyncedFiles;

Introduced in version 9.5.0.51

The paths of the files uploaded or downloaded in the last call to SyncUploadTree or SyncDownloadTree. The paths are listed one per line. In both cases (for upload and download) each line contains the full local file path (not the remote path).

SCP Sync Tree Download

SCP Sync Tree Upload

@property (nonatomic, copy) NSString *SyncMustMatch;

Introduced in version 9.5.0.51

Can contain a wildcarded list of filename patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will only transfer files having a filename that matches any one of these patterns.

SCP Sync Tree Download

SCP Sync Tree Upload

SCP Download Files Matching a Pattern, such as *.txt

@property (nonatomic, copy) NSString *SyncMustMatchDir;

Introduced in version 9.5.0.58

Can contain a wildcarded list of directory name patterns separated by semicolons. For example, "a*; b*; c*". If set, the SyncTreeUpload and SyncTreeDownload methods will only traverse into a directory that matches any one of these patterns.

@property (nonatomic, copy) NSString *SyncMustNotMatch;

Introduced in version 9.5.0.51

Can contain a wildcarded list of filename patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will not transfer files having a filename that matches any one of these patterns.

SCP Sync Tree Download

SCP Sync Tree Upload

@property (nonatomic, copy) NSString *SyncMustNotMatchDir;

Introduced in version 9.5.0.58

Can contain a wildcarded list of directory name patterns separated by semicolons. For example, "a*; b*; c*". If set, the SyncTreeUpload and SyncTreeDownload methods will not traverse into a directory that matches any one of these patterns.

@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

@property (nonatomic, readonly, copy) NSString *Version;

Version of the component/library, such as "9.4.1.42"

Methods

- (NSData *)DownloadBinary:(NSString *)remotePath;

Introduced in version 9.5.0.51

Downloads a binary file from the SSH server and returns the contents.

Returns nil on failure

- (CkoTask *)DownloadBinaryAsync:(NSString *)remotePath;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (NSString *)DownloadBinaryEncoded:(NSString *)remotePath
    encoding:(NSString *)encoding;

Introduced in version 9.5.0.51

Downloads a file from the SSH server returns the contents in an encoded string (using an encoding such as base64).

Returns nil on failure

List of Supported Encodings (Base64, Hex, etc.)

SCP Download/Upload Binary Files as Encoded Strings

- (CkoTask *)DownloadBinaryEncodedAsync:(NSString *)remotePath
    encoding:(NSString *)encoding;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadBinaryEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)DownloadFile:(NSString *)remotePath
    localPath:(NSString *)localPath;

Introduced in version 9.5.0.51

Downloads a file from the remote SSH server to the local filesystem.

Returns YES for success, NO for failure.

SCP Download File

SCP Download from a Specific Directory

- (CkoTask *)DownloadFileAsync:(NSString *)remotePath
    localPath:(NSString *)localPath;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (NSString *)DownloadString:(NSString *)remotePath
    charset:(NSString *)charset;

Introduced in version 9.5.0.51

Downloads a text file from the SSH server and returns the contents as a string.

Returns nil on failure

SCP Download Text File to String Variable

- (CkoTask *)DownloadStringAsync:(NSString *)remotePath
    charset:(NSString *)charset;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)SaveLastError:(NSString *)path;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns YES for success, NO for failure.

- (BOOL)SyncTreeDownload:(NSString *)remoteRoot
    localRoot:(NSString *)localRoot
    mode:(NSNumber *)mode
    bRecurse:(BOOL)bRecurse;

Introduced in version 9.5.0.51

Downloads files from the SSH server to a local directory tree. Synchronization modes include:

mode=0: Download all files
mode=1: Download all files that do not exist on the local filesystem.
mode=2: Download newer or non-existant files.
mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
mode=5: Download only missing files or files with size differences.
mode=6: Same as mode 5, but also download newer files.

Returns YES for success, NO for failure.

SCP Sync Tree Download

- (CkoTask *)SyncTreeDownloadAsync:(NSString *)remoteRoot
    localRoot:(NSString *)localRoot
    mode:(NSNumber *)mode
    bRecurse:(BOOL)bRecurse;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the SyncTreeDownload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)SyncTreeUpload:(NSString *)localBaseDir
    remoteBaseDir:(NSString *)remoteBaseDir
    mode:(NSNumber *)mode
    bRecurse:(BOOL)bRecurse;

Introduced in version 9.5.0.51

Uploads a directory tree from the local filesystem to the SSH server. Synchronization modes include:

mode=0: Upload all files
mode=1: Upload all files that do not exist on the FTP server.
mode=2: Upload newer or non-existant files.
mode=3: Upload only newer files. If a file does not already exist on the FTP server, it is not uploaded.
mode=4: transfer missing files or files with size differences.
mode=5: same as mode 4, but also newer files.

Returns YES for success, NO for failure.

- (CkoTask *)SyncTreeUploadAsync:(NSString *)localBaseDir
    remoteBaseDir:(NSString *)remoteBaseDir
    mode:(NSNumber *)mode
    bRecurse:(BOOL)bRecurse;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the SyncTreeUpload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)UploadBinary:(NSString *)remotePath
    binData:(NSData *)binData;

Introduced in version 9.5.0.51

Uploads binary data to a file on the SSH server.

Returns YES for success, NO for failure.

- (CkoTask *)UploadBinaryAsync:(NSString *)remotePath
    binData:(NSData *)binData;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)UploadBinaryEncoded:(NSString *)remotePath
    encodedData:(NSString *)encodedData
    encoding:(NSString *)encoding;

Introduced in version 9.5.0.51

Uploads the binary data to a file on the remote SSH server. The binary data is passed in encoded string representation (such as base64, or hex).

Returns YES for success, NO for failure.

List of Supported Encodings (Base64, Hex, etc.)

SCP Download/Upload Binary Files as Encoded Strings

- (CkoTask *)UploadBinaryEncodedAsync:(NSString *)remotePath
    encodedData:(NSString *)encodedData
    encoding:(NSString *)encoding;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadBinaryEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)UploadFile:(NSString *)localPath
    remotePath:(NSString *)remotePath;

Introduced in version 9.5.0.51

Uploads a file from the local filesystem to the remote SSH server.

Returns YES for success, NO for failure.

SCP Upload File

SCP Upload to a Specific Remote Directory

- (CkoTask *)UploadFileAsync:(NSString *)localPath
    remotePath:(NSString *)remotePath;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)UploadString:(NSString *)remotePath
    textData:(NSString *)textData
    charset:(NSString *)charset;

Introduced in version 9.5.0.51

Uploads the contents of a string to a file on the remote SSH server.

Returns YES for success, NO for failure.

SCP Upload Contents of String to Remote File

- (CkoTask *)UploadStringAsync:(NSString *)remotePath
    textData:(NSString *)textData
    charset:(NSString *)charset;

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

How to Run an Asynchronous Task

- (BOOL)UseSsh:(CkoSsh *)sshConnection;

Introduced in version 9.5.0.51

Uses the SSH connection of sshConnection for the SCP transfers. All of the connection and socket related properties, proxy properites, timeout properties, session log, etc. set on the SSH object apply to the SCP methods (because internally it is the SSH object that is used to do the work of the file transfers).

Note: There is no UnlockComponent method in the SCP class because it is the SSH object that must be unlocked. When the SSH object is not unlocked, this method will return NO to indicate failure.

Returns YES for success, NO for failure.

Events

To implement an event callback, your application would define and implement a class that inherits from CkoBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoBaseProgress base class.

For example:

  CkoScp *scp = [[CkoScp alloc] init];

  MyScpProgress *callbackObj = [[MyScpProgress alloc] init];

  [scp setEventCallbackObject:callbackObj];

MyScpProgress interface example:

#import "CkoScpProgress.h"

@interface MyScpProgress : CkoBaseProgress {

}

    - (id)init;
    - (void)dealloc;
    - (void)dispose;

    - (void)AbortCheck:(BOOL *)abort;

    - (void)BinaryData:(NSData *)data 
        length:(NSNumber *)length;

    - (void)PercentDone:(NSNumber *)pctDone 
        abort:(BOOL *)abort;

    - (void)ProgressInfo:(NSString *)name 
        value:(NSString *)value;

    - (void)TaskCompleted:(CkoTask *)task;

    - (void)TextData:(NSString *)data;

@end

- (void)AbortCheck:(BOOL *)abort;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

- (void)BinaryData:(NSData *)data
    length:(NSNumber *)length;

Binary data provided by certain methods.

- (void)PercentDone:(NSNumber *)pctDone
    abort:(BOOL *)abort;

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to YES will cause the method to abort and return a failed status (or whatever return value indicates failure).

- (void)ProgressInfo:(NSString *)name
    value:(NSString *)value;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

- (void)TaskCompleted:(CkoTask *)task;

Called in the background thread when an asynchronous task completes.

- (void)TextData:(NSString *)data;

Text data provided by certain methods.