Compression Objective-C Reference Documentation
CkoCompression
Current Version: 10.1.0
Implements the Bzip2, Deflate, and LZW compression algorithms.
Object Creation
CkoCompression *obj = [[CkoCompression alloc] init];
Properties
Algorithm
Specifies the compression algorithm: "deflate", "zlib", "bzip2", or "lzw". Note that "ppmd" is deprecated and should not be used. It was only available for 32-bit systems and specifically used the "J" variant. Please transition to one of the recommended algorithms.
topCharset
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.
topDebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
DeflateLevel
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.
topEncodingMode
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.
topHeartbeatMs
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.
topLastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: YES means success, NO means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topVerboseLogging
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.
topVersion
Methods
BeginCompressBytes
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
BeginCompressBytesAsync (1)
Creates an asynchronous task to call the BeginCompressBytes method with the arguments provided.
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
topBeginCompressBytes2
szByteData:(NSNumber *)szByteData;
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
topBeginCompressBytesENC
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
topBeginCompressBytesENCAsync (1)
Creates an asynchronous task to call the BeginCompressBytesENC method with the arguments provided.
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
topBeginCompressString
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
BeginCompressStringAsync (1)
Creates an asynchronous task to call the BeginCompressString method with the arguments provided.
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
topBeginCompressStringENC
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
BeginCompressStringENCAsync (1)
Creates an asynchronous task to call the BeginCompressStringENC method with the arguments provided.
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
topBeginDecompressBytes
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
BeginDecompressBytesAsync (1)
Creates an asynchronous task to call the BeginDecompressBytes method with the arguments provided.
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
topBeginDecompressBytes2
szByteData:(NSNumber *)szByteData;
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
topBeginDecompressBytesENC
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
topBeginDecompressBytesENCAsync (1)
Creates an asynchronous task to call the BeginDecompressBytesENC method with the arguments provided.
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
topBeginDecompressString
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
BeginDecompressStringAsync (1)
Creates an asynchronous task to call the BeginDecompressString method with the arguments provided.
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
topBeginDecompressStringENC
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
topBeginDecompressStringENCAsync (1)
Creates an asynchronous task to call the BeginDecompressStringENC method with the arguments provided.
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
topCompressBd
Compresses the data contained in a BinData object.
Returns YES for success, NO for failure.
CompressBdAsync (1)
Creates an asynchronous task to call the CompressBd method with the arguments provided.
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
topCompressBytes
CompressBytesAsync (1)
Creates an asynchronous task to call the CompressBytes method with the arguments provided.
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
topCompressBytes2
szByteData:(NSNumber *)szByteData;
CompressBytesENC
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
CompressBytesENCAsync (1)
Creates an asynchronous task to call the CompressBytesENC method with the arguments provided.
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
topCompressEncryptFile
srcPath:(NSString *)srcPath
destPath:(NSString *)destPath;
Performs file-to-file compression and encryption. Files of any size may be compressed because the file is compressed and encrypted internally in streaming mode.
Returns YES for success, NO for failure.
CompressEncryptFileAsync (1)
srcPath:(NSString *)srcPath
destPath:(NSString *)destPath;
Creates an asynchronous task to call the CompressEncryptFile method with the arguments provided.
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
topCompressFile
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.
CompressFileAsync (1)
Creates an asynchronous task to call the CompressFile method with the arguments provided.
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
topCompressSb
Compresses the contents of sb and appends the compressed bytes to binData.
Returns YES for success, NO for failure.
topCompressSbAsync (1)
Creates an asynchronous task to call the CompressSb method with the arguments provided.
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
topCompressStream
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.
CompressStreamAsync (1)
Creates an asynchronous task to call the CompressStream method with the arguments provided.
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
topCompressString
CompressStringAsync (1)
Creates an asynchronous task to call the CompressString method with the arguments provided.
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
topCompressStringENC
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
CompressStringENCAsync (1)
Creates an asynchronous task to call the CompressStringENC method with the arguments provided.
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
topDecompressBd
Decompresses the data contained in a BinData object.
Returns YES for success, NO for failure.
DecompressBdAsync (1)
Creates an asynchronous task to call the DecompressBd method with the arguments provided.
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
topDecompressBytes
DecompressBytesAsync (1)
Creates an asynchronous task to call the DecompressBytes method with the arguments provided.
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
topDecompressBytes2
szByteData:(NSNumber *)szByteData;
DecompressBytesENC
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
DecompressBytesENCAsync (1)
Creates an asynchronous task to call the DecompressBytesENC method with the arguments provided.
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
topDecompressFile
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.
DecompressFileAsync (1)
Creates an asynchronous task to call the DecompressFile method with the arguments provided.
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
topDecompressSb
Decompresses the contents of binData and appends the decompressed string to sb.
Returns YES for success, NO for failure.
topDecompressSbAsync (1)
Creates an asynchronous task to call the DecompressSb method with the arguments provided.
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
topDecompressStream
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.
DecompressStreamAsync (1)
Creates an asynchronous task to call the DecompressStream method with the arguments provided.
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
topDecompressString
Takes compressed bytes, decompresses, and returns the resulting string.
Returns nil on failure
DecompressStringAsync (1)
Creates an asynchronous task to call the DecompressString method with the arguments provided.
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
topDecompressStringENC
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
DecompressStringENCAsync (1)
Creates an asynchronous task to call the DecompressStringENC method with the arguments provided.
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
topDecryptDecompressFile
srcPath:(NSString *)srcPath
destPath:(NSString *)destPath;
Performs file-to-file decryption and decompression.
Returns YES for success, NO for failure.
DecryptDecompressFileAsync (1)
srcPath:(NSString *)srcPath
destPath:(NSString *)destPath;
Creates an asynchronous task to call the DecryptDecompressFile method with the arguments provided.
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
topEndCompressBytes
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytes)
Returns nil on failure
EndCompressBytesAsync (1)
Creates an asynchronous task to call the EndCompressBytes method with the arguments provided.
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
topEndCompressBytesENC
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytesENC)
Returns nil on failure
topEndCompressBytesENCAsync (1)
Creates an asynchronous task to call the EndCompressBytesENC method with the arguments provided.
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
topEndCompressString
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressString)
Returns nil on failure
EndCompressStringAsync (1)
Creates an asynchronous task to call the EndCompressString method with the arguments provided.
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
topEndCompressStringENC
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressStringENC)
Returns nil on failure
EndCompressStringENCAsync (1)
Creates an asynchronous task to call the EndCompressStringENC method with the arguments provided.
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
topEndDecompressBytes
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressBytes)
Returns nil on failure
EndDecompressBytesAsync (1)
Creates an asynchronous task to call the EndDecompressBytes method with the arguments provided.
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
topEndDecompressBytesENC
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
topEndDecompressBytesENCAsync (1)
Creates an asynchronous task to call the EndDecompressBytesENC method with the arguments provided.
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
topEndDecompressString
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressString)
Returns nil on failure
EndDecompressStringAsync (1)
Creates an asynchronous task to call the EndDecompressString method with the arguments provided.
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
topEndDecompressStringENC
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
topEndDecompressStringENCAsync (1)
Creates an asynchronous task to call the EndDecompressStringENC method with the arguments provided.
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
topLoadTaskCaller
MoreCompressBytes
MoreCompressBytesAsync (1)
Creates an asynchronous task to call the MoreCompressBytes method with the arguments provided.
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
topMoreCompressBytes2
szByteData:(NSNumber *)szByteData;
MoreCompressBytesENC
MoreCompressBytesENCAsync (1)
Creates an asynchronous task to call the MoreCompressBytesENC method with the arguments provided.
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
topMoreCompressString
MoreCompressStringAsync (1)
Creates an asynchronous task to call the MoreCompressString method with the arguments provided.
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
topMoreCompressStringENC
MoreCompressStringENCAsync (1)
Creates an asynchronous task to call the MoreCompressStringENC method with the arguments provided.
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
topMoreDecompressBytes
MoreDecompressBytesAsync (1)
Creates an asynchronous task to call the MoreDecompressBytes method with the arguments provided.
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
topMoreDecompressBytes2
szByteData:(NSNumber *)szByteData;
MoreDecompressBytesENC
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
topMoreDecompressBytesENCAsync (1)
Creates an asynchronous task to call the MoreDecompressBytesENC method with the arguments provided.
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
topMoreDecompressString
MoreDecompressStringAsync (1)
Creates an asynchronous task to call the MoreDecompressString method with the arguments provided.
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
topMoreDecompressStringENC
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
topMoreDecompressStringENCAsync (1)
Creates an asynchronous task to call the MoreDecompressStringENC method with the arguments provided.
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
topEvents
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)PercentDone:(NSNumber *)pctDone
abort:(BOOL *)abort;
- (void)ProgressInfo:(NSString *)name
value:(NSString *)value;
- (void)TaskCompleted:(CkoTask *)task;
@endAbortCheck
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.
PercentDone
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).
ProgressInfo
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.
TaskCompleted
Called in the background thread when an asynchronous task completes.