CkCgi Ruby Reference Documentation

CkCgi

Current Version: 9.5.0.73

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

obj = Chilkat::CkCgi.new()

Properties

AsyncBytesRead
# intVal is an integer
intVal = cgi.get_AsyncBytesRead();

To be documented soon...

top
AsyncInProgress
# boolVal is a boolean
boolVal = cgi.get_AsyncInProgress();

To be documented soon...

top
AsyncPostSize
# intVal is an integer
intVal = cgi.get_AsyncPostSize();

To be documented soon...

top
AsyncSuccess
# boolVal is a boolean
boolVal = cgi.get_AsyncSuccess();

To be documented soon...

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
cgi.get_DebugLogFilePath(ckStr);
strVal = cgi.debugLogFilePath();
cgi.put_DebugLogFilePath(strVal);

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
IdleTimeoutMs
# intVal is an integer
intVal = cgi.get_IdleTimeoutMs();
cgi.put_IdleTimeoutMs(intVal);

To be documented soon...

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
cgi.get_LastErrorHtml(ckStr);
strVal = cgi.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
# strVal is a string
# ckStr is a CkString
cgi.get_LastErrorText(ckStr);
strVal = cgi.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
# strVal is a string
# ckStr is a CkString
cgi.get_LastErrorXml(ckStr);
strVal = cgi.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
# boolVal is a boolean
boolVal = cgi.get_LastMethodSuccess();
cgi.put_LastMethodSuccess(boolVal);
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
# intVal is an integer
intVal = cgi.get_NumParams();

To be documented soon...

top
NumUploadFiles
# intVal is an integer
intVal = cgi.get_NumUploadFiles();

To be documented soon...

top
ReadChunkSize
# intVal is an integer
intVal = cgi.get_ReadChunkSize();
cgi.put_ReadChunkSize(intVal);

To be documented soon...

top
SizeLimitKB
# intVal is an integer
intVal = cgi.get_SizeLimitKB();
cgi.put_SizeLimitKB(intVal);

To be documented soon...

top
StreamToUploadDir
# boolVal is a boolean
boolVal = cgi.get_StreamToUploadDir();
cgi.put_StreamToUploadDir(boolVal);

To be documented soon...

top
UploadDir
# strVal is a string
# ckStr is a CkString
cgi.get_UploadDir(ckStr);
strVal = cgi.uploadDir();
cgi.put_UploadDir(strVal);

To be documented soon...

top
Utf8
# boolVal is a boolean
boolVal = cgi.get_Utf8();
cgi.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

top
VerboseLogging
# boolVal is a boolean
boolVal = cgi.get_VerboseLogging();
cgi.put_VerboseLogging(boolVal);

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
# strVal is a string
# ckStr is a CkString
cgi.get_Version(ckStr);
strVal = cgi.version();

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

top

Methods

AbortAsync
cgi.AbortAsync();

To be documented soon...

top
AsyncReadRequest
retBool = cgi.AsyncReadRequest();

To be documented soon...

top
GetEnv
# varName is a string
# outStr is a CkString (output)
status = cgi.GetEnv(varName, outStr);
retStr = cgi.getEnv(varName);

To be documented soon...

Returns true for success, false for failure.

top
GetParam
# paramName is a string
# outStr is a CkString (output)
status = cgi.GetParam(paramName, outStr);
retStr = cgi.getParam(paramName);

To be documented soon...

Returns true for success, false for failure.

top
GetParamName
# index is an integer
# outStr is a CkString (output)
status = cgi.GetParamName(index, outStr);
retStr = cgi.getParamName(index);

To be documented soon...

Returns true for success, false for failure.

top
GetParamValue
# index is an integer
# outStr is a CkString (output)
status = cgi.GetParamValue(index, outStr);
retStr = cgi.getParamValue(index);

To be documented soon...

Returns true for success, false for failure.

top
GetRawPostData
# outData is a CkByteData (output)
status = cgi.GetRawPostData(outData);

To be documented soon...

Returns true for success, false for failure.

top
GetUploadData
# index is an integer
# outData is a CkByteData (output)
status = cgi.GetUploadData(index, outData);

To be documented soon...

Returns true for success, false for failure.

top
GetUploadFilename
# index is an integer
# outStr is a CkString (output)
status = cgi.GetUploadFilename(index, outStr);
retStr = cgi.getUploadFilename(index);

To be documented soon...

Returns true for success, false for failure.

top
GetUploadSize
# index is an integer
retInt = cgi.GetUploadSize(index);

To be documented soon...

top
IsGet
retBool = cgi.IsGet();

To be documented soon...

top
IsHead
retBool = cgi.IsHead();

To be documented soon...

top
IsPost
retBool = cgi.IsPost();

To be documented soon...

top
IsUpload
retBool = cgi.IsUpload();

To be documented soon...

top
ReadRequest
retBool = cgi.ReadRequest();

To be documented soon...

top
SaveLastError
# path is a string
status = cgi.SaveLastError(path);

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

Returns true for success, false for failure.

top
SaveNthToUploadDir
# index is an integer
retBool = cgi.SaveNthToUploadDir(index);

To be documented soon...

top
SleepMs
# millisec is an integer
cgi.SleepMs(millisec);

To be documented soon...

top
TestConsumeAspUpload
# path is a string
retBool = cgi.TestConsumeAspUpload(path);

To be documented soon...

top