CkoCgi Objective-C Reference Documentation

CkoCgi

Current Version: 9.5.0.75

Provides the ability to receive HTTP requests and all associated parameters, HTTP header fields, etc. A common use is for receiving HTTP uploads. Provides the ability to receive uploads that stream directly to disk, eliminating memory requirements for large files. Also provides the ability to receive uploaded files directly in memory.

Object Creation

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

Properties

AsyncBytesRead
@property (nonatomic, readonly, copy) NSNumber *AsyncBytesRead;

To be documented soon...

top
AsyncInProgress
@property (nonatomic, readonly) BOOL AsyncInProgress;

To be documented soon...

top
AsyncPostSize
@property (nonatomic, readonly, copy) NSNumber *AsyncPostSize;

To be documented soon...

top
AsyncSuccess
@property (nonatomic, readonly) BOOL AsyncSuccess;

To be documented soon...

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
HeartbeatMs
@property (nonatomic, copy) NSNumber *HeartbeatMs;

To be documented soon...

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

To be documented soon...

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
NumParams
@property (nonatomic, readonly, copy) NSNumber *NumParams;

To be documented soon...

top
NumUploadFiles
@property (nonatomic, readonly, copy) NSNumber *NumUploadFiles;

To be documented soon...

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

To be documented soon...

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

To be documented soon...

top
StreamToUploadDir
@property (nonatomic) BOOL StreamToUploadDir;

To be documented soon...

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

To be documented soon...

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

AbortAsync
- (void)AbortAsync;

To be documented soon...

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

top
GetEnv
- (NSString *)GetEnv:(NSString *)varName;

To be documented soon...

Returns nil on failure

top
GetParam
- (NSString *)GetParam:(NSString *)paramName;

To be documented soon...

Returns nil on failure

top
GetParamName
- (NSString *)GetParamName:(NSNumber *)index;

To be documented soon...

Returns nil on failure

top
GetParamValue
- (NSString *)GetParamValue:(NSNumber *)index;

To be documented soon...

Returns nil on failure

top
GetRawPostData
- (NSData *)GetRawPostData;

To be documented soon...

Returns nil on failure

top
GetUploadData
- (NSData *)GetUploadData:(NSNumber *)index;

To be documented soon...

Returns nil on failure

top
GetUploadFilename
- (NSString *)GetUploadFilename:(NSNumber *)index;

To be documented soon...

Returns nil on failure

top
GetUploadSize
- (NSNumber *)GetUploadSize:(NSNumber *)index;

To be documented soon...

top
IsGet
- (BOOL)IsGet;

To be documented soon...

top
IsHead
- (BOOL)IsHead;

To be documented soon...

top
IsPost
- (BOOL)IsPost;

To be documented soon...

top
IsUpload
- (BOOL)IsUpload;

To be documented soon...

top
ReadRequest
- (BOOL)ReadRequest;

To be documented soon...

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
SaveNthToUploadDir
- (BOOL)SaveNthToUploadDir:(NSNumber *)index;

To be documented soon...

top
SleepMs
- (void)SleepMs:(NSNumber *)millisec;

To be documented soon...

top
TestConsumeAspUpload
- (BOOL)TestConsumeAspUpload:(NSString *)path;

To be documented soon...

top