Http C Library Reference
Http
Class for sending and receiving HTTP requests. Capable of doing GET, POST, and HEAD requests. Capable of persisting cookies to file-based storage. Includes substantial caching capability. Works seamlessly with HTTPS.
Create/Dispose
HCkHttp CkHttp_Create(void);
Creates an instance of the CkHttp object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
void CkHttp_Dispose(HCkHttp handle);
Objects created by calling CkHttp_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.
C "Properties"
void CkHttp_getAccept(HCkHttp cHandle, HCkString retval);
void CkHttp_putAccept(HCkHttp cHandle, const char *newVal);
The Accept header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "*/*".
void CkHttp_getAcceptCharset(HCkHttp cHandle, HCkString retval);
void CkHttp_putAcceptCharset(HCkHttp cHandle, const char *newVal);
The AcceptCharset header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "ISO-8859-1,utf-8;q=0.7,*;q=0.7".
void CkHttp_getAcceptLanguage(HCkHttp cHandle, HCkString retval);
void CkHttp_putAcceptLanguage(HCkHttp cHandle, const char *newVal);
The AcceptLanguage header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "en-us,en;q=0.5".
BOOL CkHttp_getAutoAddHostHeader(HCkHttp cHandle);
void CkHttp_putAutoAddHostHeader(HCkHttp cHandle, BOOL newVal);
If set to true, the "Host" header field will automatically be added to the request header for any QuickGet or QuickGetStr method calls. The value of the Host header field is taken from the hostname part of the URL passed to QuickGet/QuickGetStr.
void CkHttp_getBgLastErrorText(HCkHttp cHandle, HCkString retval);
When a background-enabled method is run asynchronously in a background thread, the last-error information is saved here and not in the LastErrorText property. If the background method fails, this will contain information about what transpired. (This property also contains information when the background method succeeds.) More information on background enabling HTTP communications. Example for background thread HTTP Download.
void CkHttp_getBgResultData(HCkHttp cHandle, HCkByteData retval);
If a backgrounded method returns a byte array, the returned data is found here.
int CkHttp_getBgResultInt(HCkHttp cHandle);
If a backgrounded method returns an integer, the return value is found here.
void CkHttp_getBgResultString(HCkHttp cHandle, HCkString retval);
If a backgrounded method returns a string, the return value is found here.
BOOL CkHttp_getBgTaskFinished(HCkHttp cHandle);
Becomes true when the background method completes. Your application would periodically check for this condition. More information on background enabling HTTP communications. Example for background thread HTTP Download.
BOOL CkHttp_getBgTaskRunning(HCkHttp cHandle);
If true then the object instance already has a backgrounded method running. Another backgrounded method cannot be started until the 1st completes. (Multiple simultaneous background methods may run by using multiple object instances.)
If false, then no method is currently running in a background thread. More information on background enabling HTTP communications. Example for background thread HTTP Download.
BOOL CkHttp_getBgTaskSuccess(HCkHttp cHandle);
This property's value is only meaningful (true or false) after a backgrounded method completes. More information on background enabling HTTP communications. Example for background thread HTTP Download.
void CkHttp_getClientIpAddress(HCkHttp cHandle, HCkString retval);
void CkHttp_putClientIpAddress(HCkHttp cHandle, const char *newVal);
To be documented soon...
long CkHttp_getConnectTimeout(HCkHttp cHandle);
void CkHttp_putConnectTimeout(HCkHttp cHandle, long newVal);
The amount of time in seconds to wait before timing out when connecting to an HTTP server.
void CkHttp_getConnection(HCkHttp cHandle, HCkString retval);
void CkHttp_putConnection(HCkHttp cHandle, const char *newVal);
The Connection header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Keep-Alive". To prevent the Connection header from being added to the HTTP header, set this property to the empty string.
void CkHttp_getCookieDir(HCkHttp cHandle, HCkString retval);
void CkHttp_putCookieDir(HCkHttp cHandle, const char *newVal);
Specifies a directory where cookies are automatically persisted if the Http.SaveCookies property is turned on. Cookies are stored in XML formatted files, one per domain, to main it easy for other programs to understand and parse. May be set to the string "memory" to cache cookies in memory.
long CkHttp_getDefaultFreshPeriod(HCkHttp cHandle);
void CkHttp_putDefaultFreshPeriod(HCkHttp cHandle, long newVal);
The default freshness period (in minutes) for cached documents when the FreshnessAlgorithm property is set to 0. The default value is 10080 (1 week).
BOOL CkHttp_getDigestAuth(HCkHttp cHandle);
void CkHttp_putDigestAuth(HCkHttp cHandle, BOOL newVal);
Setting this property to true causes the HTTP component to use digest authentication. The default value is false.
int CkHttp_getEventLogCount(HCkHttp cHandle);
If the KeepEventLog property is set to true, then this property will contain the number of events that have accumulated in the in-memory event log. The events are indexed from 0 to EventLogCount-1. The ClearEventLog method may be called to clear the event log. The name and value of each event can be retrieved via the EventLogName and EventLogValue methods.
BOOL CkHttp_getFetchFromCache(HCkHttp cHandle);
void CkHttp_putFetchFromCache(HCkHttp cHandle, BOOL newVal);
Set to true if pages should be fetched from cache when possible. Only HTTP GET requests are cached. HTTP responses that include Set-Cookie headers are not cached. A page is fetched from the disk cache if it is present and it is "fresh" according to the FreshnessAlgorithm property. If a page exists in cache but is not fresh, the HTTP component will issue a revalidate request and update the cache appropriately according to the response.
void CkHttp_getFinalRedirectUrl(HCkHttp cHandle, HCkString retval);
If an HTTP GET was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL, assuming the FollowRedirects property is true.
BOOL CkHttp_getFollowRedirects(HCkHttp cHandle);
void CkHttp_putFollowRedirects(HCkHttp cHandle, BOOL newVal);
If true, then 301 and 302 redirects are automatically followed when calling QuickGet and QuickGetStr. FollowRedirects is true by default.
long CkHttp_getFreshnessAlgorithm(HCkHttp cHandle);
void CkHttp_putFreshnessAlgorithm(HCkHttp cHandle, long newVal);
The freshness algorithm to use when determining the freshness of a cached HTTP GET response. A value of 1 causes an LM-factor algorithm to be used. This is the default. The LMFactor property is a value between 1 and 100 indicating the percentage of time based on the last-modified date of the HTML page. For example, if the LMFactor is 50, and an HTML page was modified 10 days ago, then the page will expire (i.e. no longer be fresh) in 5 days (50% of 10 days). This only applies to HTTP responses that do not have page expiration information. If the FreshnessAlgorithm = 0, then a constant expire time period determined by the DefaultFreshPeriod property is used.
long CkHttp_getHeartbeatMs(HCkHttp cHandle);
void CkHttp_putHeartbeatMs(HCkHttp cHandle, long newVal);
When set to a non-zero value, it specifies the time interval in milliseconds between AbortCheck events. Any HTTP operation can be aborted via the AbortCheck event. Event callbacks are supported for ActiveX, .NET, and C++ implementations of this API.
BOOL CkHttp_getIgnoreMustRevalidate(HCkHttp cHandle);
void CkHttp_putIgnoreMustRevalidate(HCkHttp cHandle, BOOL newVal);
Some HTTP responses contain a "Cache-Control: must-revalidate" header. If this is present, the server is requesting that the client always issue a revalidate HTTP request instead of serving the page directly from cache. If IgnoreMustRevalidate is set to true, then Chilkat HTTP will serve the page directly from cache without revalidating until the page is no longer fresh.
The default value of this property is false.
BOOL CkHttp_getIgnoreNoCache(HCkHttp cHandle);
void CkHttp_putIgnoreNoCache(HCkHttp cHandle, BOOL newVal);
Some HTTP responses contain headers of various types that indicate that the page should not be cached. Chilkat HTTP will adhere to this unless this property is set to true.
The default value of this property is false.
BOOL CkHttp_getKeepEventLog(HCkHttp cHandle);
void CkHttp_putKeepEventLog(HCkHttp cHandle, BOOL newVal);
If true, an in-memory event log is kept for any method that communicates with an HTTP server (such as Download, PostUrlEncoded, QuickGetStr, SynchronousRequest, etc.). When HTTP methods are called asynchronously, the event log can be checked while the HTTP operation is in in progress. This is done by examining the EventLogCount property and then fetching each event's name and value via the EventLogName and EventLogValue methods. See this example: Asynchronous HTTP.
The ClearEventLog method may be called to clear the in-memory event log.
Important: If event logging is enabled, make sure to clear the event log after each HTTP method call. Otherwise the log will continue to grow without bounds.
The default value of this property is false.
The following items may be found in the event log:
| Name | Value |
|---|
| SocketConnect | hostname:port, called when initiating a connection. |
| SocketConnected | hostname:port, called after successfully connected. |
| HttpProxyConnect | hostname:port |
| SslHandshake | "Starting"/"Finished" |
| HttpGetBegin | URL |
| HttpCacheHit | "Returning page from cache." |
| HttpInfo | various conditions...
"Begin reading response" -- called when beginning to read the response.
"Finished reading response"
"Existing connection with HTTP server no longer open, restarting GET with new connection."
"Reading chunked response."
"UnGzipping response data"
"Connection:close header is present" |
| GetRequest | the full HTTP GET request to be sent to the server. |
| ResponseHeader | the header of the HTTP response. |
| HttpStatusCode | HTTP response status code (integer) |
| ChunkSize | Size (in bytes) of next chunk in response. |
| ResponseContentLength | Non-chunked response size in bytes. |
| UnGzippedLength | If the response was gzip compressed, this is the uncompressed size. |
| HostnameResolve | hostname, Called when starting to resolve a hostname (to an IP address) |
| ResolvedToIp | dotted IP address, called after hostname is resolved. |
| HttpAuth | one of the following strings:
"Starting Negotiate Authentication"
"Starting NTLM Authentication"
"Adding Basic Authentication Header"
"Adding Proxy Authentication Header"
"Starting Proxy NTLM Authentication"
"Starting Digest Authentication" |
| CookieToSend | Value of a Set-Cookie header field to be added to the outgoing request. |
| SavingCookie | XML of cookie being persisted. |
| HttpRedirect | Redirect URL |
| Socks4Connect | domain:port |
| Socks5Connect | domain:port |
| HttpRequestBegin | Verb (such as POST, GET, PUT), domain:port/path |
| RequestHeader | The full HTTP request header to be sent. |
| StartSendingRequest | Size of entire request, including header, in number of bytes. (Not called for QuickGet)
For uploads, this is the size of the entire upload (headers and all files combined) |
| SubPartHeader | The header for one of the parts within a multipart request. |
| UploadFilename | The file about to be uploaded (streamed from file to socket..) |
long CkHttp_getLMFactor(HCkHttp cHandle);
void CkHttp_putLMFactor(HCkHttp cHandle, long newVal);
An integer between 1 and 100 that indicates the percentage of time from the HTTP page's last-modified date that will be used for the freshness period. The default value is 25. For example, if a page is fetched with a last-modified date of 4 weeks ago, and the LMFactor = 25, then the page will be considered fresh in the cache for 1 week (25% of 4 weeks).
void CkHttp_getLastContentType(HCkHttp cHandle, HCkString retval);
The content-type of the last HTTP response received by the HTTP component.
void CkHttp_getLastErrorHtml(HCkHttp cHandle, HCkString retval);
Error information in HTML format for the last method called.
void CkHttp_getLastErrorText(HCkHttp cHandle, HCkString retval);
Error information in plain-text format for the last method called.
void CkHttp_getLastErrorXml(HCkHttp cHandle, HCkString retval);
Error information in XML format for the last method called.
void CkHttp_getLastHeader(HCkHttp cHandle, HCkString retval);
The text of the last HTTP header sent by any of this class's methods. The purpose of this property is to allow the developer to examine the exact HTTP header for debugging purposes.
void CkHttp_getLastModDate(HCkHttp cHandle, HCkString retval);
The value of the Last-Modified header in the last HTTP response received by the HTTP component.
void CkHttp_getLastResponseHeader(HCkHttp cHandle, HCkString retval);
The entire last response header for the last HTTP response received by the HTTP component.
long CkHttp_getLastStatus(HCkHttp cHandle);
The last HTTP status value received by the HTTP component.
void CkHttp_getLogin(HCkHttp cHandle, HCkString retval);
void CkHttp_putLogin(HCkHttp cHandle, const char *newVal);
The HTTP login for pages requiring a login/password. Chilkat HTTP can do both Basic and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use NTLM, set the NtlmAuth property = true.
void CkHttp_getLoginDomain(HCkHttp cHandle, HCkString retval);
void CkHttp_putLoginDomain(HCkHttp cHandle, const char *newVal);
The optional domain name to be used with NTLM / Kerberos / Negotiate authentication.
long CkHttp_getMaxConnections(HCkHttp cHandle);
void CkHttp_putMaxConnections(HCkHttp cHandle, long newVal);
The maximum number of simultaneous open HTTP connections managed by the HTTP component. The Chilkat HTTP component automatically manages HTTP connections. If the number of open HTTP connections is about to be exceeded, the connection with the least recent activity is automatically closed.
long CkHttp_getMaxFreshPeriod(HCkHttp cHandle);
void CkHttp_putMaxFreshPeriod(HCkHttp cHandle, long newVal);
Limits the amount of time a document can be kept "fresh" in the cache. The MaxFreshPeriod is specified in minutes, and the default value is 525600 which is equal to 1 year.
unsigned long CkHttp_getMaxResponseSize(HCkHttp cHandle);
void CkHttp_putMaxResponseSize(HCkHttp cHandle, unsigned long newVal);
The maximum HTTP response size to be accepted by the calling program. A value of 0 (the default) indicates that there is no maximum value.
long CkHttp_getMaxUrlLen(HCkHttp cHandle);
void CkHttp_putMaxUrlLen(HCkHttp cHandle, long newVal);
The Http class will automatically fail any URL longer than this length. The default MaxUrlLen is 800 characters.
BOOL CkHttp_getMimicFireFox(HCkHttp cHandle);
void CkHttp_putMimicFireFox(HCkHttp cHandle, BOOL newVal);
If set to true, then the appropriate headers to mimic Mozilla/FireFox are automatically added to requests sent via the QuickGet and QuickGetStr methods.
BOOL CkHttp_getMimicIE(HCkHttp cHandle);
void CkHttp_putMimicIE(HCkHttp cHandle, BOOL newVal);
If set to true, then the appropriate headers to mimic Internet Explorer are automatically added to requests sent via the QuickGet and QuickGetStr methods.
long CkHttp_getMinFreshPeriod(HCkHttp cHandle);
void CkHttp_putMinFreshPeriod(HCkHttp cHandle, long newVal);
The freshness period for a document in cache will not be less than this value (in minutes). The default value is 30.
BOOL CkHttp_getNegotiateAuth(HCkHttp cHandle);
void CkHttp_putNegotiateAuth(HCkHttp cHandle, BOOL newVal);
Set this property equal to true for Negotiate authentication. Negotiate authentication will dynamically select Kerberos or NTLM authentication depending on what the server requires.
BOOL CkHttp_getNtlmAuth(HCkHttp cHandle);
void CkHttp_putNtlmAuth(HCkHttp cHandle, BOOL newVal);
Setting this property to true causes the HTTP component to use NTLM authentication (also known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server. The default value is false.
long CkHttp_getNumCacheLevels(HCkHttp cHandle);
void CkHttp_putNumCacheLevels(HCkHttp cHandle, long newVal);
The number of directory levels to be used under each cache root. The default is 0, meaning that each cached HTML page is stored in a cache root directory. A value of 1 causes each cached page to be stored in one of 255 subdirectories named "0","1", "2", ..."255" under a cache root. A value of 2 causes two levels of subdirectories ("0..255/0..255") under each cache root. The HTTP control automatically creates subdirectories as needed. The reason for mutliple levels is to alleviate problems that may arise with unrelated software when huge numbers of files are stored in a single directory. For example, Windows Explorer does not behave well when trying to display the contents of directories with thousands of files.
long CkHttp_getNumCacheRoots(HCkHttp cHandle);
The number of cache roots to be used for the HTTP cache. This allows the disk cache spread out over multiple disk drives. Each cache root is a string indicating the drive letter and directory path. For example, "E:\Cache". An example of a very large low-cost cache might be four USB external drives. To create a cache with four roots, call AddCacheRoot once for each directory root.
void CkHttp_getPassword(HCkHttp cHandle, HCkString retval);
void CkHttp_putPassword(HCkHttp cHandle, const char *newVal);
The HTTP password for pages requiring a login/password. Chilkat HTTP can do both Basic and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use NTLM, set the NtlmAuth property = true.
void CkHttp_getProxyAuthMethod(HCkHttp cHandle, HCkString retval);
void CkHttp_putProxyAuthMethod(HCkHttp cHandle, const char *newVal);
Set this to "basic" if you know in advance that Basic authentication is to be used for the HTTP proxy. Otherwise leave this property unset. Note: It is not necessary to set this property. The HTTP component will automatically handle proxy authentication for any of the supported authentication methods: NTLM, Digest, or Basic. Setting this property equal to "basic" prevents the 407 response which is automatically handled internal to Chilkat and never seen by your application.
void CkHttp_getProxyDomain(HCkHttp cHandle, HCkString retval);
void CkHttp_putProxyDomain(HCkHttp cHandle, const char *newVal);
The domain name of a proxy host if an HTTP proxy is used.
void CkHttp_getProxyLogin(HCkHttp cHandle, HCkString retval);
void CkHttp_putProxyLogin(HCkHttp cHandle, const char *newVal);
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
BOOL CkHttp_getProxyPartialUrl(HCkHttp cHandle);
void CkHttp_putProxyPartialUrl(HCkHttp cHandle, BOOL newVal);
The default value is false. If false, then the full URL is passed on the start line for HTTP requests (GET, POST, PUT, etc.) using a proxy. If true, then only the path is passed on the start line.
void CkHttp_getProxyPassword(HCkHttp cHandle, HCkString retval);
void CkHttp_putProxyPassword(HCkHttp cHandle, const char *newVal);
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
long CkHttp_getProxyPort(HCkHttp cHandle);
void CkHttp_putProxyPort(HCkHttp cHandle, long newVal);
The port number of a proxy server if an HTTP proxy is used.
long CkHttp_getReadTimeout(HCkHttp cHandle);
void CkHttp_putReadTimeout(HCkHttp cHandle, long newVal);
The amount of time in seconds to wait before timing out when reading from an HTTP server. The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long download, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire download.
void CkHttp_getReferer(HCkHttp cHandle, HCkString retval);
void CkHttp_putReferer(HCkHttp cHandle, const char *newVal);
The Referer header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is the empty string which causes the Referer field to be omitted from the request header.
void CkHttp_getRequiredContentType(HCkHttp cHandle, HCkString retval);
void CkHttp_putRequiredContentType(HCkHttp cHandle, const char *newVal);
If set, then any HTTP response to any POST or GET, including downloads, will be rejected if the content-type in the response header does not match this setting. If the content-type does not match, only the header of the HTTP response is read, the connection to the HTTP server is closed, and the remainder of the response is never read.
This property is empty (zero-length string) by default.
Some typical content-types are "text/html", "text/xml", "image/gif", "image/jpeg", "application/zip", "application/msword", "application/pdf", etc.
BOOL CkHttp_getSaveCookies(HCkHttp cHandle);
void CkHttp_putSaveCookies(HCkHttp cHandle, BOOL newVal);
If this property is true, cookies are automatically persisted to XML files in the directory specified by the CookiesDir property (or in memory if CookieDir = "memory"). Both CookiesDir and SaveCookies must be set for cookies to be persisted.
int CkHttp_getSendBufferSize(HCkHttp cHandle);
void CkHttp_putSendBufferSize(HCkHttp cHandle, int newVal);
The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 65535.
BOOL CkHttp_getSendCookies(HCkHttp cHandle);
void CkHttp_putSendCookies(HCkHttp cHandle, BOOL newVal);
If true, then cookies previously persisted to the CookiesDir are automatically added to all HTTP requests. Only cookies matching the domain and path are added.
void CkHttp_getSessionLogFilename(HCkHttp cHandle, HCkString retval);
void CkHttp_putSessionLogFilename(HCkHttp cHandle, const char *newVal);
Enables file-based session logging. If set to a filename (or relative/absolute filepath), then the exact HTTP requests and responses are logged to a file. The file is created if it does not already exist, otherwise it is appended.
void CkHttp_getSocksHostname(HCkHttp cHandle, HCkString retval);
void CkHttp_putSocksHostname(HCkHttp cHandle, const char *newVal);
The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).
void CkHttp_getSocksPassword(HCkHttp cHandle, HCkString retval);
void CkHttp_putSocksPassword(HCkHttp cHandle, const char *newVal);
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
int CkHttp_getSocksPort(HCkHttp cHandle);
void CkHttp_putSocksPort(HCkHttp cHandle, int newVal);
The SOCKS4/SOCKS5 proxy port. The default value is 1080.
This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).
void CkHttp_getSocksUsername(HCkHttp cHandle, HCkString retval);
void CkHttp_putSocksUsername(HCkHttp cHandle, const char *newVal);
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
int CkHttp_getSocksVersion(HCkHttp cHandle);
void CkHttp_putSocksVersion(HCkHttp cHandle, int newVal);
SocksVersion
May be set to one of the following integer values:
0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.
void CkHttp_getSslProtocol(HCkHttp cHandle, HCkString retval);
void CkHttp_putSslProtocol(HCkHttp cHandle, const char *newVal);
Selects the secure protocol to be used for secure (SSL) connections. Possible values are:
default
TLS 1.0
SSL 3.0
SSL 2.0
PCT 1.0
The default value is "default", which allows for the protocol to be selected dynamically at runtime based on the requirements of the server.
BOOL CkHttp_getUpdateCache(HCkHttp cHandle);
void CkHttp_putUpdateCache(HCkHttp cHandle, BOOL newVal);
Controls whether the cache is automatically updated with the responses from HTTP GET requests.
BOOL CkHttp_getUseBgThread(HCkHttp cHandle);
void CkHttp_putUseBgThread(HCkHttp cHandle, BOOL newVal);
If true, then background-enabled methods will run in a background thread. Normally, a method will return after its work is completed. However, when UseBgThread is true, the method will return immediately and a background thread is started to carry out the method’s task.
Background-enabled HTTP methods are:
BOOL CkHttp_getUseIEProxy(HCkHttp cHandle);
void CkHttp_putUseIEProxy(HCkHttp cHandle, BOOL newVal);
If true, the proxy host/port used by Internet Explorer will also be used by Chilkat HTTP.
void CkHttp_getUserAgent(HCkHttp cHandle, HCkString retval);
void CkHttp_putUserAgent(HCkHttp cHandle, const char *newVal);
The UserAgent header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Chilkat/1.0.0 (+http://www.chilkatsoft.com/ChilkatHttpUA.asp)" which indicates that the software used to issue the HTTP request was the Chilkat HTTP component.
BOOL CkHttp_getUtf8(HCkHttp cHandle);
void CkHttp_putUtf8(HCkHttp cHandle, BOOL newVal);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
BOOL CkHttp_getVerboseLogging(HCkHttp cHandle);
void CkHttp_putVerboseLogging(HCkHttp cHandle, BOOL newVal);
If true, increases the amount of information available in LastErrorText (or LastErrorXml / LastErrorHtml). The default is false.
void CkHttp_getVersion(HCkHttp cHandle, HCkString retval);
Returns a string such as "1.0.0" indicating the version of the HTTP component.
BOOL CkHttp_getWasRedirected(HCkHttp cHandle);
Indicates whether the last HTTP GET was redirected.
C "Methods"
void CkHttp_AddCacheRoot(HCkHttp cHandle, const char *dir);
This method must be called at least once if disk caching is to be used. The file path (including drive letter) such as "E:\MyHttpCache\" is passed to AddCacheRoot to specify the root directory. The cache can be spread across multiple disk drives by calling AddCacheRoot multiple times, each with a directory path on a separate disk drive.
BOOL CkHttp_AddQuickHeader(HCkHttp cHandle, const char *name, const char *value);
To be documented soon...
HCkHttpResponse CkHttp_BgResponseObject(HCkHttp cHandle);
If a backgrounded method returns an Http response object, it may be retrieved by calling this method.
void CkHttp_BgTaskAbort(HCkHttp cHandle);
Call this to force the currently running backgrounded method to abort.
void CkHttp_ClearEventLog(HCkHttp cHandle);
Clears the in-memory event log (which is enabled by setting the KeepEventLog property = true).
void CkHttp_ClearInMemoryCookies(HCkHttp cHandle);
Clears all cookies cached in memory. Calling this only makes sense if the CookieDir property is set to the string "memory".
BOOL CkHttp_Download(HCkHttp cHandle, const char *url, const char *filename);
HTTP downloads a file at a URL. The file can be any size and any type. Large files are downloaded in streaming mode such that the memory footprint is small and steady. HTTPS is fully supported, as it is with all the methods of this class. Returns TRUE for success, FALSE for failure.
BOOL CkHttp_DownloadAppend(HCkHttp cHandle, const char *url, const char *filename);
Same as the Download method, but the output file is open for append. Returns TRUE for success, FALSE for failure.
BOOL CkHttp_EventLogName(HCkHttp cHandle, int index, HCkString outStr);
Returns the name of the Nth event in the in-memory event log. Refer to the documentation for the KeepEventLog property for the full list of event names. Indexing is from 0 to EventLogCount-1.
BOOL CkHttp_EventLogValue(HCkHttp cHandle, int index, HCkString outStr);
Returns the value of the Nth event in the in-memory event log. Indexing is from 0 to EventLogCount-1.
void CkHttp_GenTimeStamp(HCkHttp cHandle, HCkString outStr);
Returns the current GMT (also known as UTC) date/time in a string that is compliant with RFC 2616 format.
BOOL CkHttp_GetCacheRoot(HCkHttp cHandle, int index, HCkString str);
Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times.
BOOL CkHttp_GetCookieXml(HCkHttp cHandle, const char *domain, HCkString outStr);
Returns the cookies in XML format for a specific domain. Cookies are only persisted if the SaveCookies property is set to true. If the CookieDir property is set to the keyword "memory", then cookies are saved in-memory.
void CkHttp_GetDomain(HCkHttp cHandle, const char *url, HCkString str);
Utility method for extracting the domain name from a full URL. For example, if "http://www.chilkatsoft.com/default.asp" is the URL passed in, then "www.chilkatsoft.com" is returned.
HCkHttpResponse CkHttp_GetHead(HCkHttp cHandle, const char *url);
Sends an HTTP HEAD request for a URL and returns a response object.
BOOL CkHttp_GetRequestHeader(HCkHttp cHandle, const char *name, HCkString str);
Returns the value of a header field that has been pre-defined to be sent with all HTTP GET requests issued by the QuickGet and QuickGetStr methods. By default, this includes header fields such as Accept, AcceptCharset, AcceptLanguage, Connection, UserAgent, etc.
HCkCert CkHttp_GetServerSslCert(HCkHttp cHandle, const char *domain, int port);
Establishes an SSL/TLS connection with a web server for the purpose of retrieving the server's SSL certificate (public-key only of course...). Nothing is retrieved from the web server. This method simply makes a connection, gets the certificate information, and closes the connection.
void CkHttp_GetUrlPath(HCkHttp cHandle, const char *url, HCkString str);
Returns the path part of a URL. The syntax of a URL is ://:@:/;?#. This method returns the "path" part.
BOOL CkHttp_HasRequestHeader(HCkHttp cHandle, const char *name);
Returns true if the specified header field is defined such that it will be sent with all GET requests issued by the QuickGet and QuickGetStr methods.
BOOL CkHttp_IsUnlocked(HCkHttp cHandle);
Returns true if the Http class has been unlocked. It is necessary to call Http.UnlockComponent before calling any other methods. Passing any string to UnlockComponent will automatically activate a 30-day trial period.
BOOL CkHttp_PostBinary(HCkHttp cHandle, const char *url, HCkByteData byteData, const char *contentType, BOOL md5, BOOL gzip, HCkString outStr);
To be documented soon...
HCkHttpResponse CkHttp_PostMime(HCkHttp cHandle, const char *url, const char *mime);
Allows the calling application to specify the exact content to be sent in a POST. The HTTP POST is sent and the response is returned as an HTTP response object.
HCkHttpResponse CkHttp_PostUrlEncoded(HCkHttp cHandle, const char *url, HCkHttpRequest req);
Sends a simple URL encoded POST. The form parameters are sent in the body of the HTTP request in x-www-form-urlencoded format. The content-type is "application/x-www-form-urlencoded".
HCkHttpResponse CkHttp_PostXml(HCkHttp cHandle, const char *url, const char *xmlDoc, const char *charset);
A simplified way of posting XML content to a web server. This method is good for making SOAP calls using HTTP POST. The xmlCharset should match the character encoding used in the xmlContent, which is typically "utf-8". The HTTP response is returned in an HTTP response object.
BOOL CkHttp_PutBinary(HCkHttp cHandle, const char *url, HCkByteData byteData, const char *contentType, BOOL md5, BOOL gzip, HCkString outStr);
Sends an HTTP PUT request to the url. The body of the HTTP request is byteData. The contentType is a content type such as "image/gif", "application/pdf", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the byteData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the byteData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).
BOOL CkHttp_PutText(HCkHttp cHandle, const char *url, const char *textData, const char *charset, const char *contentType, BOOL md5, BOOL gzip, HCkString outStr);
Sends an HTTP PUT request to the url. The body of the HTTP request is textData. The charset should be set to a charset name such as "iso-8859-1", "windows-1252", "Shift_JIS", "utf-8", etc. The string "ansi" may also be used as a charset name. The contentType is a content type such as "text/plain", "text/xml", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the textData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the textData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).
BOOL CkHttp_QuickDeleteStr(HCkHttp cHandle, const char *url, HCkString outStr);
Same as QuickGetStr, but uses the HTTP DELETE method instead of the GET method.
BOOL CkHttp_QuickGet(HCkHttp cHandle, const char *url, HCkByteData data);
Sends an HTTP GET request for a URL and returns the response body as a byte array. The URL may contain query parameters. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page may be fetched directly from cache. Because the URL can specify any type of resource (HTML page, GIF image, etc.) the return value is a byte array. If the resource is known to be a string, such as with an HTML page, you may call QuickGetStr instead. If the HTTP request fails, a zero-length byte array is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties.
HCkHttpResponse CkHttp_QuickGetObj(HCkHttp cHandle, const char *url);
To be documented soon.
BOOL CkHttp_QuickGetStr(HCkHttp cHandle, const char *url, HCkString str);
Sends an HTTP GET request for a URL and returns the response body as a string. The URL may contain query parameters. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page could be fetched directly from cache. If the HTTP request fails, a NULL value is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties.
BOOL CkHttp_QuickPutStr(HCkHttp cHandle, const char *url, HCkString outStr);
Same as QuickGetStr, but uses the HTTP PUT method instead of the GET method.
BOOL CkHttp_RemoveQuickHeader(HCkHttp cHandle, const char *name);
To be documented soon...
void CkHttp_RemoveRequestHeader(HCkHttp cHandle, const char *name);
Eliminates a header field from being included in HTTP GET requests issued by the QuickGet and QuickGetStr methods.
BOOL CkHttp_RenderGet(HCkHttp cHandle, const char *url, HCkString outStr);
Same as QuickGet, but does not send the HTTP GET. Instead, it builds
the HTTP request that would've been sent and returns it.
BOOL CkHttp_ResumeDownload(HCkHttp cHandle, const char *url, const char *filename);
Same as the Download method, except a failed download may be resumed. The targetFilename is automatically checked and if it exists, the download will resume at the point where it previously failed. ResumeDownload may be called any number of times until the full download is complete. Returns TRUE for success, FALSE for failure.
BOOL CkHttp_SaveLastError(HCkHttp cHandle, const char *filename);
Saves the last error information to an XML formatted file.
BOOL CkHttp_SetCookieXml(HCkHttp cHandle, const char *domain, const char *cookieXml);
Restores cookies for a particular domain. It is assumed that the cookie XML was previously retrieved via the GetCookieXml method, and saved to some sort of persistent storage, such as within a database table. It is then possible for an application to restore the cookies by calling this method. Returns TRUE for success, FALSE for failure.
void CkHttp_SetRequestHeader(HCkHttp cHandle, const char *name, const char *value);
Adds or replaces a custom HTTP request header to be sent with all GET requests issued by the QuickGet and QuickGetStr methods.
BOOL CkHttp_SetSslClientCert(HCkHttp cHandle, HCkCert cert);
Allows for a client-side certificate to be used for an SSL connection.
BOOL CkHttp_SetSslClientCertPfx(HCkHttp cHandle, const char *pfxFilename, const char *pfxPassword, const char *certSubjectCN);
To be documented soon...
void CkHttp_SleepMs(HCkHttp cHandle, int millisec);
To be documented soon...
HCkHttpResponse CkHttp_SynchronousRequest(HCkHttp cHandle, const char *domain, long port, BOOL ssl, HCkHttpRequest req);
Sends an explicit HttpRequest to an HTTP server and returns an HttpResponse object. The HttpResponse object provides full access to the response including all headers and the response body. This method may be used to send POST requests, as well as GET, HEAD, file uploads, and XMLHTTP.
BOOL CkHttp_UnlockComponent(HCkHttp cHandle, const char *unlockCode);
Unlocks the Http class/component. It is necessary to call Http.UnlockComponent before calling any other methods. Passing any string to UnlockComponent will automatically activate a 30-day trial period. Returns TRUE for success, FALSE for failure.
BOOL CkHttp_UrlDecode(HCkHttp cHandle, const char *str, HCkString outStr);
URL decodes a string.
BOOL CkHttp_UrlEncode(HCkHttp cHandle, const char *str, HCkString outStr);
URL encodes a string.
BOOL CkHttp_XmlRpc(HCkHttp cHandle, const char *urlEndpoint, const char *xmlIn, HCkString outStr);
Makes an XML RPC call to a URL endpoint. The XML string is passed in an HTTP POST, and the XML response is returned.
BOOL CkHttp_XmlRpcPut(HCkHttp cHandle, const char *urlEndpoint, const char *xmlIn, HCkString outStr);
Same as XmlRpc, but uses the HTTP PUT method instead of the POST method.
const char *CkHttp_acceptCharset(HCkHttp cHandle);
The AcceptCharset header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "ISO-8859-1,utf-8;q=0.7,*;q=0.7".
const char *CkHttp_acceptLanguage(HCkHttp cHandle);
The AcceptLanguage header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "en-us,en;q=0.5".
const char *CkHttp_bgLastErrorText(HCkHttp cHandle);
When a background-enabled method is run asynchronously in a background thread, the last-error information is saved here and not in the LastErrorText property. If the background method fails, this will contain information about what transpired. (This property also contains information when the background method succeeds.) More information on background enabling HTTP communications. Example for background thread HTTP Download.
const char *CkHttp_bgResultString(HCkHttp cHandle);
If a backgrounded method returns a string, the return value is found here.
const char *CkHttp_ck_accept(HCkHttp cHandle);
To be documented soon...
const char *CkHttp_clientIpAddress(HCkHttp cHandle);
To be documented soon...
const char *CkHttp_connection(HCkHttp cHandle);
The Connection header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Keep-Alive". To prevent the Connection header from being added to the HTTP header, set this property to the empty string.
const char *CkHttp_cookieDir(HCkHttp cHandle);
Specifies a directory where cookies are automatically persisted if the Http.SaveCookies property is turned on. Cookies are stored in XML formatted files, one per domain, to main it easy for other programs to understand and parse. May be set to the string "memory" to cache cookies in memory.
const char *CkHttp_eventLogName(HCkHttp cHandle, int index);
Returns the name of the Nth event in the in-memory event log. Refer to the documentation for the KeepEventLog property for the full list of event names. Indexing is from 0 to EventLogCount-1.
const char *CkHttp_eventLogValue(HCkHttp cHandle, int index);
Returns the value of the Nth event in the in-memory event log. Indexing is from 0 to EventLogCount-1.
const char *CkHttp_finalRedirectUrl(HCkHttp cHandle);
If an HTTP GET was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL, assuming the FollowRedirects property is true.
const char *CkHttp_genTimeStamp(HCkHttp cHandle);
Returns the current GMT (also known as UTC) date/time in a string that is compliant with RFC 2616 format.
const char *CkHttp_getCacheRoot(HCkHttp cHandle, int index);
Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times.
const char *CkHttp_getCookieXml(HCkHttp cHandle, const char *domain);
Returns the cookies in XML format for a specific domain. Cookies are only persisted if the SaveCookies property is set to true. If the CookieDir property is set to the keyword "memory", then cookies are saved in-memory.
const char *CkHttp_getDomain(HCkHttp cHandle, const char *url);
Utility method for extracting the domain name from a full URL. For example, if "http://www.chilkatsoft.com/default.asp" is the URL passed in, then "www.chilkatsoft.com" is returned.
const char *CkHttp_getRequestHeader(HCkHttp cHandle, const char *name);
Returns the value of a header field that has been pre-defined to be sent with all HTTP GET requests issued by the QuickGet and QuickGetStr methods. By default, this includes header fields such as Accept, AcceptCharset, AcceptLanguage, Connection, UserAgent, etc.
const char *CkHttp_getUrlPath(HCkHttp cHandle, const char *url);
Returns the path part of a URL. The syntax of a URL is ://:@:/;?#. This method returns the "path" part.
const char *CkHttp_lastContentType(HCkHttp cHandle);
The content-type of the last HTTP response received by the HTTP component.
const char *CkHttp_lastErrorHtml(HCkHttp cHandle);
Error information in HTML format for the last method called.
const char *CkHttp_lastErrorText(HCkHttp cHandle);
Error information in plain-text format for the last method called.
const char *CkHttp_lastErrorXml(HCkHttp cHandle);
Error information in XML format for the last method called.
const char *CkHttp_lastHeader(HCkHttp cHandle);
The text of the last HTTP header sent by any of this class's methods. The purpose of this property is to allow the developer to examine the exact HTTP header for debugging purposes.
const char *CkHttp_lastModDate(HCkHttp cHandle);
The value of the Last-Modified header in the last HTTP response received by the HTTP component.
const char *CkHttp_lastResponseHeader(HCkHttp cHandle);
The entire last response header for the last HTTP response received by the HTTP component.
const char *CkHttp_login(HCkHttp cHandle);
The HTTP login for pages requiring a login/password. Chilkat HTTP can do both Basic and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use NTLM, set the NtlmAuth property = true.
const char *CkHttp_loginDomain(HCkHttp cHandle);
The optional domain name to be used with NTLM / Kerberos / Negotiate authentication.
const char *CkHttp_password(HCkHttp cHandle);
The HTTP password for pages requiring a login/password. Chilkat HTTP can do both Basic and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use NTLM, set the NtlmAuth property = true.
const char *CkHttp_postBinary(HCkHttp cHandle, const char *url, HCkByteData byteData, const char *contentType, BOOL md5, BOOL gzip);
To be documented soon...
const char *CkHttp_proxyAuthMethod(HCkHttp cHandle);
Set this to "basic" if you know in advance that Basic authentication is to be used for the HTTP proxy. Otherwise leave this property unset. Note: It is not necessary to set this property. The HTTP component will automatically handle proxy authentication for any of the supported authentication methods: NTLM, Digest, or Basic. Setting this property equal to "basic" prevents the 407 response which is automatically handled internal to Chilkat and never seen by your application.
const char *CkHttp_proxyDomain(HCkHttp cHandle);
The domain name of a proxy host if an HTTP proxy is used.
const char *CkHttp_proxyLogin(HCkHttp cHandle);
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
const char *CkHttp_proxyPassword(HCkHttp cHandle);
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
const char *CkHttp_putBinary(HCkHttp cHandle, const char *url, HCkByteData byteData, const char *contentType, BOOL md5, BOOL gzip);
Sends an HTTP PUT request to the url. The body of the HTTP request is byteData. The contentType is a content type such as "image/gif", "application/pdf", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the byteData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the byteData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).
const char *CkHttp_putText(HCkHttp cHandle, const char *url, const char *textData, const char *charset, const char *contentType, BOOL md5, BOOL gzip);
Sends an HTTP PUT request to the url. The body of the HTTP request is textData. The charset should be set to a charset name such as "iso-8859-1", "windows-1252", "Shift_JIS", "utf-8", etc. The string "ansi" may also be used as a charset name. The contentType is a content type such as "text/plain", "text/xml", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the textData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the textData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).
const char *CkHttp_quickDeleteStr(HCkHttp cHandle, const char *url);
Same as QuickGetStr, but uses the HTTP DELETE method instead of the GET method.
const char *CkHttp_quickGetStr(HCkHttp cHandle, const char *url);
Sends an HTTP GET request for a URL and returns the response body as a string. The URL may contain query parameters. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page could be fetched directly from cache. If the HTTP request fails, a NULL value is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties.
const char *CkHttp_quickPutStr(HCkHttp cHandle, const char *url);
Same as QuickGetStr, but uses the HTTP PUT method instead of the GET method.
const char *CkHttp_referer(HCkHttp cHandle);
The Referer header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is the empty string which causes the Referer field to be omitted from the request header.
const char *CkHttp_renderGet(HCkHttp cHandle, const char *url);
Same as QuickGet, but does not send the HTTP GET. Instead, it builds
the HTTP request that would've been sent and returns it.
const char *CkHttp_requiredContentType(HCkHttp cHandle);
If set, then any HTTP response to any POST or GET, including downloads, will be rejected if the content-type in the response header does not match this setting. If the content-type does not match, only the header of the HTTP response is read, the connection to the HTTP server is closed, and the remainder of the response is never read.
This property is empty (zero-length string) by default.
Some typical content-types are "text/html", "text/xml", "image/gif", "image/jpeg", "application/zip", "application/msword", "application/pdf", etc.
const char *CkHttp_sessionLogFilename(HCkHttp cHandle);
Enables file-based session logging. If set to a filename (or relative/absolute filepath), then the exact HTTP requests and responses are logged to a file. The file is created if it does not already exist, otherwise it is appended.
const char *CkHttp_socksHostname(HCkHttp cHandle);
The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).
const char *CkHttp_socksPassword(HCkHttp cHandle);
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
const char *CkHttp_socksUsername(HCkHttp cHandle);
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
const char *CkHttp_sslProtocol(HCkHttp cHandle);
Selects the secure protocol to be used for secure (SSL) connections. Possible values are:
default
TLS 1.0
SSL 3.0
SSL 2.0
PCT 1.0
The default value is "default", which allows for the protocol to be selected dynamically at runtime based on the requirements of the server.
const char *CkHttp_urlDecode(HCkHttp cHandle, const char *str);
URL decodes a string.
const char *CkHttp_urlEncode(HCkHttp cHandle, const char *str);
URL encodes a string.
const char *CkHttp_userAgent(HCkHttp cHandle);
The UserAgent header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Chilkat/1.0.0 (+http://www.chilkatsoft.com/ChilkatHttpUA.asp)" which indicates that the software used to issue the HTTP request was the Chilkat HTTP component.
const char *CkHttp_version(HCkHttp cHandle);
Returns a string such as "1.0.0" indicating the version of the HTTP component.
const char *CkHttp_xmlRpc(HCkHttp cHandle, const char *urlEndpoint, const char *xmlIn);
Makes an XML RPC call to a URL endpoint. The XML string is passed in an HTTP POST, and the XML response is returned.
const char *CkHttp_xmlRpcPut(HCkHttp cHandle, const char *urlEndpoint, const char *xmlIn);
Same as XmlRpc, but uses the HTTP PUT method instead of the POST method.
|