CkoLog Objective-C Reference Documentation
CkoLog
Current Version: 10.1.0
Handy logging class exposing much of the functionality used internally by Chilkat for LastErrorText, LastErrorXml, and LastErrorHtml.
Object Creation
CkoLog *obj = [[CkoLog alloc] init];
Properties
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
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.
topLastErrorText
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.
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.
topLastMethodSuccess
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.
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
Clear
Clears the log. The initialTag is the initial top-level context tag for the new log.
topEnterContext
Enters a new context labelled with the given tag. Must be paired with a matching call to LeaveContext.
LeaveContext
Leaves the current context. A context that is entered and exited without any logging within the context is automatically removed from the log. (To say it another way: Empty contexts are automaticallly removed from the log upon leaving the context.)
topLogData
message:(NSString *)message;
Adds a tagged message to the log (i.e. a name/value pair).
topLogDataBase64
data:(NSData *)data;
Logs binary data in base64 format.
topLogDataBase64_2
pByteData:(NSData *)pByteData
szByteData:(NSNumber *)szByteData;
Logs binary data in base64 format.
topLogDataHex
data:(NSData *)data;
Logs binary data in hex format.
topLogDataHex2
pByteData:(NSData *)pByteData
szByteData:(NSNumber *)szByteData;
Logs binary data in hex format.
topLogDataMax
message:(NSString *)message
maxNumChars:(NSNumber *)maxNumChars;
Logs a string, but only up to the 1st maxNumChars characters of the string.
topLogDateTime
gmt:(BOOL)gmt;
Logs the current date/time in RFC822 format. If gmt is YES, then the GMT/UTC time is logged. Otherwise it is the local time.
topLogError
Logs an error within the current context.
topLogHash2
hashAlg:(NSString *)hashAlg
pByteData:(NSData *)pByteData
szByteData:(NSNumber *)szByteData;
Logs the hash of binary data in hex format. The tag can be SHA1, SHA256, SHA384, SHA512, or MD5.
topLogInfo
Logs an informational message within the current context.
topLogInt
value:(NSNumber *)value;
Logs an integer.
topLogInt64
value:(NSNumber *)value;
Logs a 64-bit integer.
topLogTimestamp
Logs the current time in HH:MM:SS:mmm format.
top