HttpResponse Tcl Reference Documentation
HttpResponse
Current Version: 9.5.0.98
Represents a complete HTTP response.
Object Creation
set myHttpResponse [new CkHttpResponse]
Properties
Body
The response body returned as a byte array.
topBodyQP
# ckStr is a CkString
CkHttpResponse_get_BodyQP $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_bodyQP $myHttpResponse]
The same as the Body property, but returned as a quoted-printable encoded string.
topBodyStr
# ckStr is a CkString
CkHttpResponse_get_BodyStr $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_bodyStr $myHttpResponse]
The response body returned as a string.
topCharset
# ckStr is a CkString
CkHttpResponse_get_Charset $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_charset $myHttpResponse]
The response charset, such as "iso-8859-1", if applicable. Obviously, responses for GIF and JPG files will not have a charset.
topContentLength
set intVal [CkHttpResponse_get_ContentLength $myHttpResponse]
The content length of the response, in bytes.
topContentLength64
set int64Val [CkHttpResponse_get_ContentLength64 $myHttpResponse]
The content length of the response, in number of bytes, returned as a 64-bit integer.
topDateStr
# ckStr is a CkString
CkHttpResponse_get_DateStr $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_dateStr $myHttpResponse]
Returns the content of the Date response header field in RFC822 date/time string format.
topDebugLogFilePath
# ckStr is a CkString
CkHttpResponse_get_DebugLogFilePath $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_debugLogFilePath $myHttpResponse]
CkHttpResponse_put_DebugLogFilePath $myHttpResponse $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:
- 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.
Domain
# ckStr is a CkString
CkHttpResponse_get_Domain $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_domain $myHttpResponse]
The domain of the HTTP server that created this response.
topFinalRedirectUrl
# ckStr is a CkString
CkHttpResponse_get_FinalRedirectUrl $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_finalRedirectUrl $myHttpResponse]
Returns the redirect URL for 301/302 responses.
topFullMime
# ckStr is a CkString
CkHttpResponse_get_FullMime $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_fullMime $myHttpResponse]
Header
# ckStr is a CkString
CkHttpResponse_get_Header $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_header $myHttpResponse]
The full text of the response header.
topLastErrorHtml
# ckStr is a CkString
CkHttpResponse_get_LastErrorHtml $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_lastErrorHtml $myHttpResponse]
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
# ckStr is a CkString
CkHttpResponse_get_LastErrorText $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_lastErrorText $myHttpResponse]
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
# ckStr is a CkString
CkHttpResponse_get_LastErrorXml $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_lastErrorXml $myHttpResponse]
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
set boolVal [CkHttpResponse_get_LastMethodSuccess $myHttpResponse]
CkHttpResponse_put_LastMethodSuccess $myHttpResponse $boolVal
Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
- 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topNumCookies
set intVal [CkHttpResponse_get_NumCookies $myHttpResponse]
The number of cookies included in the response.
topNumHeaderFields
set intVal [CkHttpResponse_get_NumHeaderFields $myHttpResponse]
The number of response header fields.
topStatusCode
set intVal [CkHttpResponse_get_StatusCode $myHttpResponse]
The status code (as an integer) from the first line of an HTTP response. If the StatusLine = "HTTP/1.0 200 OK", the response status code returned is 200.
topStatusLine
# ckStr is a CkString
CkHttpResponse_get_StatusLine $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_statusLine $myHttpResponse]
The first line of an HTTP response, such as "HTTP/1.0 200 OK".
topStatusText
# ckStr is a CkString
CkHttpResponse_get_StatusText $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_statusText $myHttpResponse]
The text that follows the status code in the 1st line of the HTTP response. For example, i the first line of an HTTP response is "HTTP/1.0 200 OK", then this property contains "OK".
topUncommonOptions
# ckStr is a CkString
CkHttpResponse_get_UncommonOptions $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_uncommonOptions $myHttpResponse]
CkHttpResponse_put_UncommonOptions $myHttpResponse $strVal
This is a catch-all property to be used for uncommon needs. Can be set to a list of the following comma separated keywords:
- "TakeResponseBody" - Introduced in v9.5.0.89. The GetBody* methods will transfer the body to the target object instead of copying the contents. This can be useful if the response body is extremely large because it will reduce the overall memory requirement.
Utf8
set boolVal [CkHttpResponse_get_Utf8 $myHttpResponse]
CkHttpResponse_put_Utf8 $myHttpResponse $boolVal
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
set boolVal [CkHttpResponse_get_VerboseLogging $myHttpResponse]
CkHttpResponse_put_VerboseLogging $myHttpResponse $boolVal
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
# ckStr is a CkString
CkHttpResponse_get_Version $myHttpResponse $ckStr
set strVal [CkHttpResponse_get_version $myHttpResponse]
Methods
GetBodyBd
set status [CkHttpResponse_GetBodyBd $binData]
Copies the response body to a BinData object.
Returns 1 for success, 0 for failure.
GetBodyJarr
set status [CkHttpResponse_GetBodyJarr $jarr]
Loads the JSON array response body into a JsonArray This method should only be called when it is known that the response body contains a JSON array (beginning with a square bracket '[' and ending with a square bracket ']')
Returns 1 for success, 0 for failure.
GetBodyJson
set status [CkHttpResponse_GetBodyJson $json]
Loads the JSON response body into a JsonObject. This method should only be called when it is known that the response body contains JSON (beginning with a curly brace '{' and ending with a curly brace '}')
Returns 1 for success, 0 for failure.
GetBodySb
set status [CkHttpResponse_GetBodySb $sb]
Copies the response body to a Chilkat StringBuilder object.
Returns 1 for success, 0 for failure.
topGetBodyXml
set status [CkHttpResponse_GetBodyXml $xml]
Loads the XML response body into an XML object. This method should only be called when it is known that the response body contains XML.
Returns 1 for success, 0 for failure.
GetCookieDomain
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieDomain $index $outStr]
set retStr [CkHttpResponse_getCookieDomain $myHttpResponse $index]
Returns the domain of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookieExpiresStr
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieExpiresStr $index $outStr]
set retStr [CkHttpResponse_getCookieExpiresStr $myHttpResponse $index]
Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookieName
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieName $index $outStr]
set retStr [CkHttpResponse_getCookieName $myHttpResponse $index]
Returns the name of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookiePath
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookiePath $index $outStr]
set retStr [CkHttpResponse_getCookiePath $myHttpResponse $index]
Returns the path of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookieValue
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieValue $index $outStr]
set retStr [CkHttpResponse_getCookieValue $myHttpResponse $index]
Returns the value of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetHeaderField
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderField $fieldName $outStr]
set retStr [CkHttpResponse_getHeaderField $myHttpResponse $fieldName]
Returns the value of a response header field accessed by field name.
Returns 1 for success, 0 for failure.
topGetHeaderFieldAttr
# attrName is a string
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderFieldAttr $fieldName $attrName $outStr]
set retStr [CkHttpResponse_getHeaderFieldAttr $myHttpResponse $fieldName $attrName]
Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr("content-type","charset")
Returns 1 for success, 0 for failure.
topGetHeaderName
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderName $index $outStr]
set retStr [CkHttpResponse_getHeaderName $myHttpResponse $index]
Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.
Returns 1 for success, 0 for failure.
topGetHeaderValue
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderValue $index $outStr]
set retStr [CkHttpResponse_getHeaderValue $myHttpResponse $index]
Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.
Returns 1 for success, 0 for failure.
topLoadTaskResult
set status [CkHttpResponse_LoadTaskResult $task]
Loads the HTTP response from a completed asynchronous task. A failed return value indicates that no HTTP response was received in the HTTP asynchronous method call (i.e. the asynchronous HTTP request failed in such a way that no response was received).
Returns 1 for success, 0 for failure.
SaveBodyBinary
set status [CkHttpResponse_SaveBodyBinary $path]
Saves the body of the HTTP response to a file.
Returns 1 for success, 0 for failure.
SaveBodyText
# path is a string
set status [CkHttpResponse_SaveBodyText $bCrlf $path]
Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If bCrlf is 1, then line endings are automatically converted to CRLF if necessary. If bCrlf is 0, then line-endings are automatically converted to bare-LF's (Unix style) if necessary.
To save the HTTP response body exactly as-is (with no line-ending manipulation), then call SaveBodyBinary.
Returns 1 for success, 0 for failure.
topUrlEncParamValue
# paramName is a string
# outStr is a CkString (output)
set status [CkHttpResponse_UrlEncParamValue $encodedParamString $paramName $outStr]
set retStr [CkHttpResponse_urlEncParamValue $myHttpResponse $encodedParamString $paramName]
Convenience method for parsing a param's value out of a URL-encoded param string. For example, if a caller passes the following string in encodedParamString:
oauth_token=ABC&oauth_token_secret=123&oauth_callback_confirmed=trueand "oauth_token_secret" in paramName, then the return value would be "123".
Returns 1 for success, 0 for failure.
top