CkoCgi Swift 3/4 Reference Documentation

CkoCgi

Current Version: 9.5.0.76

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

let obj = CkoCgi()!

Properties

AsyncBytesRead

asyncBytesRead: Int (read-only)

To be documented soon...

AsyncInProgress

asyncInProgress: Bool (read-only)

To be documented soon...

AsyncPostSize

asyncPostSize: Int (read-only)

To be documented soon...

AsyncSuccess

asyncSuccess: Bool (read-only)

To be documented soon...

DebugLogFilePath

debugLogFilePath: String!

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.

HeartbeatMs

heartbeatMs: Int

To be documented soon...

IdleTimeoutMs

idleTimeoutMs: Int

To be documented soon...

LastErrorHtml

lastErrorHtml: String! (read-only)

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.

LastErrorText

lastErrorText: String! (read-only)

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

lastErrorXml: String! (read-only)

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.

LastMethodSuccess

lastMethodSuccess: Bool

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

NumParams

numParams: Int (read-only)

To be documented soon...

NumUploadFiles

numUploadFiles: Int (read-only)

To be documented soon...

ReadChunkSize

readChunkSize: Int

To be documented soon...

SizeLimitKB

sizeLimitKB: Int

To be documented soon...

StreamToUploadDir

streamToUploadDir: Bool

To be documented soon...

UploadDir

uploadDir: String!

To be documented soon...

VerboseLogging

verboseLogging: Bool

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

Version

version: String! (read-only)

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

Methods

AbortAsync

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.

GetEnv

getEnv(varName: String) -> String

To be documented soon...

Returns nil on failure

GetParam

getParam(paramName: String) -> String

To be documented soon...

Returns nil on failure

GetParamName

getParamName(index: Int) -> String

To be documented soon...

Returns nil on failure

GetParamValue

getParamValue(index: Int) -> String

To be documented soon...

Returns nil on failure

GetRawPostData

getRawPostData() -> NSData

To be documented soon...

Returns nil on failure

GetUploadData

getUploadData(index: Int) -> NSData

To be documented soon...

Returns nil on failure

GetUploadFilename

getUploadFilename(index: Int) -> String

To be documented soon...

Returns nil on failure

GetUploadSize

getUploadSize(index: Int) -> Int

To be documented soon...

IsGet

isGet() -> Bool

To be documented soon...

IsHead

isHead() -> Bool

To be documented soon...

IsPost

isPost() -> Bool

To be documented soon...

IsUpload

isUpload() -> Bool

To be documented soon...

ReadRequest

readRequest() -> Bool

To be documented soon...

SaveLastError

saveLastError(path: String) -> Bool

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

Returns true for success, false for failure.

SaveNthToUploadDir

saveNth(toUploadDir: Int) -> Bool

To be documented soon...

SleepMs

sleepMs(millisec: Int)

To be documented soon...

TestConsumeAspUpload

testConsumeAspUpload(path: String) -> Bool

To be documented soon...