CkUpload C++ Class Reference (Visual C++)
CkUpload
Chilkat Upload is a freeware component that can be used to upload files over HTTP and HTTPS to a web server.
- Supports both HTTP and HTTPS protocols.
- Progress monitoring with percentage completion and "heartbeat" monitoring.
- Abort capability.
- Asynchronous uploads with real-time monitoring of percentage completion and number of bytes transferred.
- Add arbitrary HTTP POST form parameters to your upload.
- Upload multiple files in a single transaction.
- Add arbitrary (custom) HTTP header fields to the HTTP upload.
- Retrieve the HTTP response status, header, and body returned by the web server.
Properties
int get_ChunkSize(void) const;
void put_ChunkSize(int numBytes);
The chunk size (in bytes) used by the underlying TCP/IP sockets for uploading files. The default value is 2048. This property is not typically modified.
void get_Hostname(CkString &hostname) const;
void put_Hostname(const char *hostname);
The hostname of the HTTP server that is the target of the upload. Do not include "http://" in the hostname. It can be a hostname, such as "www.chilkatsoft.com", or an IP address, such as "168.144.70.227".
int get_IdleTimeoutMs(void) const;
void put_IdleTimeoutMs(int millisec);
A timeout in milliseconds. The default value is 30000. If the upload hangs (i.e. progress halts) for more than this time, the component will abort the upload. (It will timeout.)
void LastErrorHtml(CkString &str);
Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
Error information in XML format for the last method called.
void get_Login(CkString &str);
void put_Login(const char *newVal);
The HTTP login for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
unsigned long get_NumBytesSent(void) const;
After an upload has completed, this property contains the number of bytes sent. During asynchronous uploads, this property contains the current number of bytes sent while the upload is in progress.
void get_Password(CkString &str);
void put_Password(const char *newVal);
The HTTP password for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
void get_Path(CkString &path) const;
void put_Path(const char *path);
The path part of the upload URL. Some examples:
If the upload target (i.e. consumer) URL is: http://www.freeaspupload.net/freeaspupload/testUpload.asp, then
Hostname = "www.freeaspupload.net"
Path = "/freeaspupload/testUpload.asp"
If the upload target URL is http://www.chilkatsoft.com/cgi-bin/ConsumeUpload.exe, then
Hostname = "www.chilkatsoft.com"
Path = "/cgi-bin/ConsumeUpload.exe"
unsigned long get_PercentUploaded(void) const;
Contains the current percentage completion (0 to 100) while an asynchronous upload is in progress.
int get_Port(void) const;
void put_Port(int port);
The port number of the upload target (i.e. consumer) URL. The default value is 80. If SSL is used, this should be set to 443 (typically).
void get_ProxyDomain(CkString &str);
void put_ProxyDomain(const char *v);
The domain name of a proxy host if an HTTP proxy is used. Do not include the "http://". The domain name may be a hostname, such as "www.chilkatsoft.com", or an IP address, such as "168.144.70.227". HTTP Upload using a Proxy Server Example
void get_ProxyLogin(CkString &str);
void put_ProxyLogin(const char *newVal);
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
void get_ProxyPassword(CkString &str);
void put_ProxyPassword(const char *newVal);
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
long get_ProxyPort(void);
void put_ProxyPort(long n);
The port number of a proxy server if an HTTP proxy is used.
void get_ResponseBody(CkByteData &body) const;
An HTTP upload is nothing more than an HTTP POST that contains the content of the files being uploaded. Just as with any HTTP POST or GET, the server should send an HTTP response that consists of header and body. This property contains the body part of the HTTP response.
void get_ResponseHeader(CkString &header) const;
An HTTP upload is nothing more than an HTTP POST that contains the content of the files being uploaded. Just as with any HTTP POST or GET, the server should send an HTTP response that consists of header and body. This property contains the header part of the HTTP response.
int get_ResponseStatus(void) const;
The HTTP response status code of the HTTP response. A list of HTTP status codes can be found here: HTTP Response Status Codes.
bool get_Ssl(void) const;
void put_Ssl(bool newVal);
Set this to true if the upload is to HTTPS. For example, if the target of the upload is:
https://www.myuploadtarget.com/consumeUpload.asp
then set:
Ssl = true
Hostname = "www.myuploadtarget.com"
Path = "/consumeupload.asp"
Port = 443
unsigned long get_TotalUploadSize(void) const;
The total size of the upload (in bytes). This property will become set at the beginning of an asynchronous upload. A program may monitor asynchronous uploads by tracking both NumBytesSent and PercentUploaded.
This property is also set during synchronous uploads.
bool get_UploadInProgress(void) const;
Set to true when an asynchronous upload is started. When the asynchronous upload is complete, this property becomes equal to false. A program will typically begin an asynchronous upload by calling BeginUpload, and then periodically checking the value of this property to determine when the upload is complete.
bool get_UploadSuccess(void) const;
Set to true (success) or false (failed) after an asynchronous upload completes or aborts due to failure. When a program does an asynchronous upload, it will wait until UploadInProgress becomes false. It will then check the value of this property to determine if the upload was successful or not.
bool get_Utf8(void) const;
void put_Utf8(bool b);
To be documented soon...
void get_Version(CkString &str) const;
The version of the Chilkat Upload component, such as "2.0.0".
Methods
void AbortUpload();
May be called during an asynchronous upload to abort.
void AddCustomHeader(const char * name, const char * value);
Adds a custom HTTP header to the HTTP upload.
void AddFileReference(const char * name, const char * filename);
Adds a file to the list of files to be uploaded in the next call to BlockingUpload, BeginUpload, or UploadToMemory. To upload more than one file, call this method once for each file to be uploaded.
void AddParam(const char * name, const char * value);
Adds a custom HTTP request parameter to the upload.
bool BeginUpload();
Starts an asynchronous upload. Only one asynchronous upload may be in progress at a time. To achieve multiple asynchronous uploads, use multiple instances of the Chilkat Upload object. Each object instance is capable of managing a single asynchronous upload.
When this method is called, a background thread is started and the asynchronous upload runs in the background. The upload may be aborted at any time by calling AbortUpload. The upload is completed (or failed) when UploadInProgress becomes false. At that point, the UploadSuccess property may be checked to determine success (true) or failure (false). Returns true for success, false for failure. Asynchronous HTTP Upload Example Asynchronous HTTPS Upload Example
bool BlockingUpload();
Uploads files in a synchronous manner. This method does not return until all files have been uploaded, or the upload fails. The files to be uploaded are indicated by calling AddFileReference once for each file (prior to calling this method). Returns true for success, false for failure. BlockingUpload Example
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
void SleepMs(int millisec);
A convenience method for putting the calling process to sleep for N milliseconds. It is provided here because some programming languages do not provide this capability, and sleeping for short increments of time is helpful when doing asynchronous uploads.
bool UploadToMemory(CkByteData & dataBuf);
Writes the complete HTTP POST to memory. The POST contains the HTTP header, any custom params added by calling AddParam, and each file to be uploaded. This is helpful in debugging. It allows you to see the exact HTTP POST sent to the server if BlockingUpload or BeginUpload is called.
const char * hostname();
The hostname of the HTTP server that is the target of the upload. Do not include "http://" in the hostname. It can be a hostname, such as "www.chilkatsoft.com", or an IP address, such as "168.144.70.227".
const char * lastErrorHtml();
Error information in HTML format for the last method called.
const char * lastErrorText();
Error information in plain-text format for the last method called.
const char * lastErrorXml();
Error information in XML format for the last method called.
const char * login();
The HTTP login for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
const char * password();
The HTTP password for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
const char * path();
The path part of the upload URL. Some examples:
If the upload target (i.e. consumer) URL is: http://www.freeaspupload.net/freeaspupload/testUpload.asp, then
Hostname = "www.freeaspupload.net"
Path = "/freeaspupload/testUpload.asp"
If the upload target URL is http://www.chilkatsoft.com/cgi-bin/ConsumeUpload.exe, then
Hostname = "www.chilkatsoft.com"
Path = "/cgi-bin/ConsumeUpload.exe"
const char * proxyDomain();
The domain name of a proxy host if an HTTP proxy is used. Do not include the "http://". The domain name may be a hostname, such as "www.chilkatsoft.com", or an IP address, such as "168.144.70.227". HTTP Upload using a Proxy Server Example
const char * proxyLogin();
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
const char * proxyPassword();
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
const char * responseHeader();
An HTTP upload is nothing more than an HTTP POST that contains the content of the files being uploaded. Just as with any HTTP POST or GET, the server should send an HTTP response that consists of header and body. This property contains the header part of the HTTP response.
const char * version();
The version of the Chilkat Upload component, such as "2.0.0".
|