CkoCompression Objective-C Reference Documentation

CkoCompression

Current Version: 9.5.0.75

Data compression component implementing the PPMD, Bzip2, Deflate, and LZW compression algorithms. .NET, ActiveX, and C++ implementations provide progress monitoring and abort capabilities. Provides a unified API for all supported compression algorithms.

Object Creation

CkoCompression *obj = [[CkoCompression alloc] init];

Properties

Algorithm
@property (nonatomic, copy) NSString *Algorithm;

The compression algorithm to be used. Should be set to either "ppmd", "deflate", "zlib", "bzip2", or "lzw".

Note: The PPMD compression algorithm is only available for 32-bit builds. It is not available for 64-bit implementations. Also, this PPMD implementation is the "J" variant.

top
Charset
@property (nonatomic, copy) NSString *Charset;

Only applies to methods that compress or decompress strings. This specifies the character encoding that the string should be converted to before compression. Many programming languages use Unicode (2 bytes per char) for representing characters. This property allows for the string to be converted to a 1-byte per char encoding prior to compression.

top
DebugLogFilePath
@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.

top
DeflateLevel
@property (nonatomic, copy) NSNumber *DeflateLevel;
Introduced in version 9.5.0.73

This property allows for customization of the compression level for the "deflate" and "zlib" compression algoirthms. ("zlib" is just the deflate algorithm with a zlib header.) A value of 0 = no compression, while 9 = maximum compression. The default is 6.

top
EncodingMode
@property (nonatomic, copy) NSString *EncodingMode;

Controls the encoding expected by methods ending in "ENC", such as CompressBytesENC. Valid values are "base64", "hex", "url", and "quoted-printable". Compression methods ending in ENC return the binary compressed data as an encoded string using this encoding. Decompress methods expect the input string to be this encoding.

top
HeartbeatMs
@property (nonatomic, copy) NSNumber *HeartbeatMs;

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

top
LastErrorHtml
@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.

top
LastErrorText
@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.

top
LastErrorXml
@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.

top
LastMethodSuccess
@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.

top
VerboseLogging
@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.

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

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

top

Methods

BeginCompressBytes
- (NSData *)BeginCompressBytes:(NSData *)bData;

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns nil on failure

More Information and Examples
top
BeginCompressBytesAsync (1)
- (CkoTask *)BeginCompressBytesAsync:(NSData *)bData;

Creates an asynchronous task to call the BeginCompressBytes 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

top
BeginCompressBytesENC
- (NSString *)BeginCompressBytesENC:(NSData *)bData;

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytesENC, followed by 0 or more calls to MoreCompressedBytesENC, and ending with a final call to EndCompressBytesENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns nil on failure

top
BeginCompressBytesENCAsync (1)
- (CkoTask *)BeginCompressBytesENCAsync:(NSData *)bData;

Creates an asynchronous task to call the BeginCompressBytesENC 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

top
BeginCompressString
- (NSData *)BeginCompressString:(NSString *)str;

Large amounts of string data may be compressed in chunks by first calling BeginCompressString, followed by 0 or more calls to MoreCompressedString, and ending with a final call to EndCompressString. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns nil on failure

More Information and Examples
top
BeginCompressStringAsync (1)
- (CkoTask *)BeginCompressStringAsync:(NSString *)str;

Creates an asynchronous task to call the BeginCompressString 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

top
BeginCompressStringENC
- (NSString *)BeginCompressStringENC:(NSString *)str;

Large amounts of string data may be compressed in chunks by first calling BeginCompressStringENC, followed by 0 or more calls to MoreCompressedStringENC, and ending with a final call to EndCompressStringENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns nil on failure

More Information and Examples
top
BeginCompressStringENCAsync (1)
- (CkoTask *)BeginCompressStringENCAsync:(NSString *)str;

Creates an asynchronous task to call the BeginCompressStringENC 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

top
BeginDecompressBytes
- (NSData *)BeginDecompressBytes:(NSData *)bData;

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.

Returns nil on failure

More Information and Examples
top
BeginDecompressBytesAsync (1)
- (CkoTask *)BeginDecompressBytesAsync:(NSData *)bData;

Creates an asynchronous task to call the BeginDecompressBytes 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

top
BeginDecompressBytesENC
- (NSData *)BeginDecompressBytesENC:(NSString *)str;

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytesENC, followed by 0 or more calls to MoreDecompressedBytesENC, and ending with a final call to EndDecompressBytesENC. Each call returns 0 or more bytes of decompressed data.

Returns nil on failure

top
BeginDecompressBytesENCAsync (1)
- (CkoTask *)BeginDecompressBytesENCAsync:(NSString *)str;

Creates an asynchronous task to call the BeginDecompressBytesENC 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

top
BeginDecompressString
- (NSString *)BeginDecompressString:(NSData *)bData;

A compressed data stream may be decompressed in chunks by first calling BeginDecompressString, followed by 0 or more calls to MoreDecompressedString, and ending with a final call to EndDecompressString. Each call returns 0 or more characters of decompressed text.

Returns nil on failure

More Information and Examples
top
BeginDecompressStringAsync (1)
- (CkoTask *)BeginDecompressStringAsync:(NSData *)bData;

Creates an asynchronous task to call the BeginDecompressString 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

top
BeginDecompressStringENC
- (NSString *)BeginDecompressStringENC:(NSString *)str;

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressStringENC, followed by 0 or more calls to MoreDecompressedStringENC, and ending with a final call to EndDecompressStringENC. Each call returns 0 or more characters of decompressed text.

Returns nil on failure

top
BeginDecompressStringENCAsync (1)
- (CkoTask *)BeginDecompressStringENCAsync:(NSString *)str;

Creates an asynchronous task to call the BeginDecompressStringENC 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

top
CompressBd
- (BOOL)CompressBd:(CkoBinData *)binData;
Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns YES for success, NO for failure.

top
CompressBdAsync (1)
- (CkoTask *)CompressBdAsync:(CkoBinData *)binData;
Introduced in version 9.5.0.66

Creates an asynchronous task to call the CompressBd 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

top
CompressBytes
- (NSData *)CompressBytes:(NSData *)bData;

Compresses byte data.

Returns nil on failure

More Information and Examples
top
CompressBytesAsync (1)
- (CkoTask *)CompressBytesAsync:(NSData *)bData;

Creates an asynchronous task to call the CompressBytes 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

top
CompressBytesENC
- (NSString *)CompressBytesENC:(NSData *)bData;

Compresses bytes and returns the compressed data encoded to a string. The encoding (hex, base64, etc.) is determined by the EncodingMode property setting.

Returns nil on failure

top
CompressBytesENCAsync (1)
- (CkoTask *)CompressBytesENCAsync:(NSData *)bData;

Creates an asynchronous task to call the CompressBytesENC 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

top
CompressFile
- (BOOL)CompressFile:(NSString *)srcPath
    destPath:(NSString *)destPath;

Performs file-to-file compression. Files of any size may be compressed because the file is compressed internally in streaming mode.

Returns YES for success, NO for failure.

More Information and Examples
top
CompressFileAsync (1)
- (CkoTask *)CompressFileAsync:(NSString *)srcPath
    destPath:(NSString *)destPath;

Creates an asynchronous task to call the CompressFile 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

top
CompressSb
- (BOOL)CompressSb:(CkoStringBuilder *)sb
    binData:(CkoBinData *)binData;
Introduced in version 9.5.0.73

Compresses the contents of sb and appends the compressed bytes to binData.

Returns YES for success, NO for failure.

top
CompressSbAsync (1)
- (CkoTask *)CompressSbAsync:(CkoStringBuilder *)sb
    binData:(CkoBinData *)binData;
Introduced in version 9.5.0.73

Creates an asynchronous task to call the CompressSb 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

top
CompressStream
- (BOOL)CompressStream:(CkoStream *)strm;
Introduced in version 9.5.0.56

Compresses a stream. Internally, the strm's source is read, compressed, and the compressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be compressed with stable ungrowing memory usage.

Returns YES for success, NO for failure.

More Information and Examples
top
CompressStreamAsync (1)
- (CkoTask *)CompressStreamAsync:(CkoStream *)strm;
Introduced in version 9.5.0.56

Creates an asynchronous task to call the CompressStream 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

top
CompressString
- (NSData *)CompressString:(NSString *)str;

Compresses a string.

Returns nil on failure

More Information and Examples
top
CompressStringAsync (1)
- (CkoTask *)CompressStringAsync:(NSString *)str;

Creates an asynchronous task to call the CompressString 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

top
CompressStringENC
- (NSString *)CompressStringENC:(NSString *)str;

Compresses a string and returns the compressed data encoded to a string. The output encoding (hex, base64, etc.) is determined by the EncodingMode property setting.

Returns nil on failure

More Information and Examples
top
CompressStringENCAsync (1)
- (CkoTask *)CompressStringENCAsync:(NSString *)str;

Creates an asynchronous task to call the CompressStringENC 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

top
DecompressBd
- (BOOL)DecompressBd:(CkoBinData *)binData;
Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns YES for success, NO for failure.

top
DecompressBdAsync (1)
- (CkoTask *)DecompressBdAsync:(CkoBinData *)binData;
Introduced in version 9.5.0.66

Creates an asynchronous task to call the DecompressBd 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

top
DecompressBytes
- (NSData *)DecompressBytes:(NSData *)bData;

The opposite of CompressBytes.

Returns nil on failure

More Information and Examples
top
DecompressBytesAsync (1)
- (CkoTask *)DecompressBytesAsync:(NSData *)bData;

Creates an asynchronous task to call the DecompressBytes 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

top
DecompressBytesENC
- (NSData *)DecompressBytesENC:(NSString *)str;

The opposite of CompressBytesENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting.

Returns nil on failure

top
DecompressBytesENCAsync (1)
- (CkoTask *)DecompressBytesENCAsync:(NSString *)str;

Creates an asynchronous task to call the DecompressBytesENC 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

top
DecompressFile
- (BOOL)DecompressFile:(NSString *)srcPath
    destPath:(NSString *)destPath;

Performs file-to-file decompression (the opposite of CompressFile). Internally the file is decompressed in streaming mode which allows files of any size to be decompressed.

Returns YES for success, NO for failure.

More Information and Examples
top
DecompressFileAsync (1)
- (CkoTask *)DecompressFileAsync:(NSString *)srcPath
    destPath:(NSString *)destPath;

Creates an asynchronous task to call the DecompressFile 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

top
DecompressSb
- (BOOL)DecompressSb:(CkoBinData *)binData
    sb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.73

Decompresses the contents of binData and appends the decompressed string to sb.

Returns YES for success, NO for failure.

top
DecompressSbAsync (1)
- (CkoTask *)DecompressSbAsync:(CkoBinData *)binData
    sb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.73

Creates an asynchronous task to call the DecompressSb 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

top
DecompressStream
- (BOOL)DecompressStream:(CkoStream *)strm;
Introduced in version 9.5.0.56

Decompresses a stream. Internally, the strm's source is read, decompressed, and the decompressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be decompressed with stable ungrowing memory usage.

Returns YES for success, NO for failure.

More Information and Examples
top
DecompressStreamAsync (1)
- (CkoTask *)DecompressStreamAsync:(CkoStream *)strm;
Introduced in version 9.5.0.56

Creates an asynchronous task to call the DecompressStream 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

top
DecompressString
- (NSString *)DecompressString:(NSData *)bData;

Takes compressed bytes, decompresses, and returns the resulting string.

Returns nil on failure

More Information and Examples
top
DecompressStringAsync (1)
- (CkoTask *)DecompressStringAsync:(NSData *)bData;

Creates an asynchronous task to call the DecompressString 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

top
DecompressStringENC
- (NSString *)DecompressStringENC:(NSString *)str;

The opposite of CompressStringENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting.

Returns nil on failure

More Information and Examples
top
DecompressStringENCAsync (1)
- (CkoTask *)DecompressStringENCAsync:(NSString *)str;

Creates an asynchronous task to call the DecompressStringENC 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

top
EndCompressBytes
- (NSData *)EndCompressBytes;

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytes)

Returns nil on failure

More Information and Examples
top
EndCompressBytesAsync (1)
- (CkoTask *)EndCompressBytesAsync;

Creates an asynchronous task to call the EndCompressBytes 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

top
EndCompressBytesENC
- (NSString *)EndCompressBytesENC;

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytesENC)

Returns nil on failure

top
EndCompressBytesENCAsync (1)
- (CkoTask *)EndCompressBytesENCAsync;

Creates an asynchronous task to call the EndCompressBytesENC 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

top
EndCompressString
- (NSData *)EndCompressString;

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressString)

Returns nil on failure

More Information and Examples
top
EndCompressStringAsync (1)
- (CkoTask *)EndCompressStringAsync;

Creates an asynchronous task to call the EndCompressString 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

top
EndCompressStringENC
- (NSString *)EndCompressStringENC;

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressStringENC)

Returns nil on failure

More Information and Examples
top
EndCompressStringENCAsync (1)
- (CkoTask *)EndCompressStringENCAsync;

Creates an asynchronous task to call the EndCompressStringENC 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

top
EndDecompressBytes
- (NSData *)EndDecompressBytes;

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressBytes)

Returns nil on failure

More Information and Examples
top
EndDecompressBytesAsync (1)
- (CkoTask *)EndDecompressBytesAsync;

Creates an asynchronous task to call the EndDecompressBytes 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

top
EndDecompressBytesENC
- (NSData *)EndDecompressBytesENC;

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns nil on failure

top
EndDecompressBytesENCAsync (1)
- (CkoTask *)EndDecompressBytesENCAsync;

Creates an asynchronous task to call the EndDecompressBytesENC 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

top
EndDecompressString
- (NSString *)EndDecompressString;

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressString)

Returns nil on failure

More Information and Examples
top
EndDecompressStringAsync (1)
- (CkoTask *)EndDecompressStringAsync;

Creates an asynchronous task to call the EndDecompressString 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

top
EndDecompressStringENC
- (NSString *)EndDecompressStringENC;

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns nil on failure

top
EndDecompressStringENCAsync (1)
- (CkoTask *)EndDecompressStringENCAsync;

Creates an asynchronous task to call the EndDecompressStringENC 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

top
MoreCompressBytes
- (NSData *)MoreCompressBytes:(NSData *)bData;

(See BeginCompressBytes)

Returns nil on failure

More Information and Examples
top
MoreCompressBytesAsync (1)
- (CkoTask *)MoreCompressBytesAsync:(NSData *)bData;

Creates an asynchronous task to call the MoreCompressBytes 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

top
MoreCompressBytesENC
- (NSString *)MoreCompressBytesENC:(NSData *)bData;

(See BeginCompressBytesENC)

Returns nil on failure

top
MoreCompressBytesENCAsync (1)
- (CkoTask *)MoreCompressBytesENCAsync:(NSData *)bData;

Creates an asynchronous task to call the MoreCompressBytesENC 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

top
MoreCompressString
- (NSData *)MoreCompressString:(NSString *)str;

(See BeginCompressString)

Returns nil on failure

More Information and Examples
top
MoreCompressStringAsync (1)
- (CkoTask *)MoreCompressStringAsync:(NSString *)str;

Creates an asynchronous task to call the MoreCompressString 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

top
MoreCompressStringENC
- (NSString *)MoreCompressStringENC:(NSString *)str;

(See BeginCompressStringENC)

Returns nil on failure

More Information and Examples
top
MoreCompressStringENCAsync (1)
- (CkoTask *)MoreCompressStringENCAsync:(NSString *)str;

Creates an asynchronous task to call the MoreCompressStringENC 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

top
MoreDecompressBytes
- (NSData *)MoreDecompressBytes:(NSData *)bData;

(See BeginDecompressBytes)

Returns nil on failure

More Information and Examples
top
MoreDecompressBytesAsync (1)
- (CkoTask *)MoreDecompressBytesAsync:(NSData *)bData;

Creates an asynchronous task to call the MoreDecompressBytes 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

top
MoreDecompressBytesENC
- (NSData *)MoreDecompressBytesENC:(NSString *)str;

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns nil on failure

top
MoreDecompressBytesENCAsync (1)
- (CkoTask *)MoreDecompressBytesENCAsync:(NSString *)str;

Creates an asynchronous task to call the MoreDecompressBytesENC 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

top
MoreDecompressString
- (NSString *)MoreDecompressString:(NSData *)bData;

(See BeginDecompressString)

Returns nil on failure

More Information and Examples
top
MoreDecompressStringAsync (1)
- (CkoTask *)MoreDecompressStringAsync:(NSData *)bData;

Creates an asynchronous task to call the MoreDecompressString 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

top
MoreDecompressStringENC
- (NSString *)MoreDecompressStringENC:(NSString *)str;

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns nil on failure

top
MoreDecompressStringENCAsync (1)
- (CkoTask *)MoreDecompressStringENCAsync:(NSString *)str;

Creates an asynchronous task to call the MoreDecompressStringENC 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

top
SaveLastError
- (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.

top
UnlockComponent
- (BOOL)UnlockComponent:(NSString *)unlockCode;

Unlocks the component allowing for the full functionality to be used. The component may be used fully-functional for the 1st 30-days after download by passing an arbitrary string to this method. If for some reason you do not receive the full 30-day trial, send email to support@chilkatsoft.com for a temporary unlock code w/ an explicit expiration date. Upon purchase, a purchased unlock code is provided which should replace the temporary/arbitrary string passed to this method.

Returns YES for success, NO for failure.

top

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:

  CkoCompression *compression = [[CkoCompression alloc] init];

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

  [compression setEventCallbackObject:callbackObj];

MyCompressionProgress interface example:

#import "CkoCompressionProgress.h"

@interface MyCompressionProgress : 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
AbortCheck
- (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.

top
PercentDone
- (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).

top
ProgressInfo
- (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.

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

Called in the background thread when an asynchronous task completes.

top