CkoCgi Swift Reference Documentation

CkoCgi

Current Version: 9.5.0.72

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...

top
AsyncInProgress
AsyncInProgress: Bool (read-only)

To be documented soon...

top
AsyncPostSize
AsyncPostSize: Int (read-only)

To be documented soon...

top
AsyncSuccess
AsyncSuccess: Bool (read-only)

To be documented soon...

top
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:

  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
HeartbeatMs: Int

To be documented soon...

top
IdleTimeoutMs
IdleTimeoutMs: Int

To be documented soon...

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

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

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

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

top
NumParams
NumParams: Int (read-only)

To be documented soon...

top
NumUploadFiles
NumUploadFiles: Int (read-only)

To be documented soon...

top
ReadChunkSize
ReadChunkSize: Int

To be documented soon...

top
SizeLimitKB
SizeLimitKB: Int

To be documented soon...

top
StreamToUploadDir
StreamToUploadDir: Bool

To be documented soon...

top
UploadDir
UploadDir: String

To be documented soon...

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

top
Version
Version: String (read-only)

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

top

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.

top
AsyncReadRequest
AsyncReadRequest() -> Bool

To be documented soon...

top
GetEnv
GetEnv(varName: String) -> String

To be documented soon...

Returns nil on failure

top
GetParam
GetParam(paramName: String) -> String

To be documented soon...

Returns nil on failure

top
GetParamName
GetParamName(index: Int) -> String

To be documented soon...

Returns nil on failure

top
GetParamValue
GetParamValue(index: Int) -> String

To be documented soon...

Returns nil on failure

top
GetRawPostData
GetRawPostData() -> NSData

To be documented soon...

Returns nil on failure

top
GetUploadData
GetUploadData(index: Int) -> NSData

To be documented soon...

Returns nil on failure

top
GetUploadFilename
GetUploadFilename(index: Int) -> String

To be documented soon...

Returns nil on failure

top
GetUploadSize
GetUploadSize(index: Int) -> Int

To be documented soon...

top
IsGet
IsGet() -> Bool

To be documented soon...

top
IsHead
IsHead() -> Bool

To be documented soon...

top
IsPost
IsPost() -> Bool

To be documented soon...

top
IsUpload
IsUpload() -> Bool

To be documented soon...

top
ReadRequest
ReadRequest() -> Bool

To be documented soon...

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

top
SaveNthToUploadDir
SaveNthToUploadDir(index: Int) -> Bool

To be documented soon...

top
SleepMs
SleepMs(millisec: Int)

To be documented soon...

top
TestConsumeAspUpload
TestConsumeAspUpload(path: String) -> Bool

To be documented soon...

top