CkUpload Perl Programming
Reference Documentation
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
# Returns an integer value
get_ChunkSize( )
# numBytes is an integer (input)
put_ChunkSize( 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.
# hostname is a CkString object (output)
get_Hostname( hostname )
# hostname is a string (input)
put_Hostname( 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".
# Returns an integer value
get_IdleTimeoutMs( )
# millisec is an integer (input)
put_IdleTimeoutMs( 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.)
# str is a CkString object (output)
LastErrorHtml( str )
Error information in HTML format for the last method called.
# str is a CkString object (output)
LastErrorText( str )
Error information in plain-text format for the last method called.
# str is a CkString object (output)
LastErrorXml( str )
Error information in XML format for the last method called.
# str is a CkString object (output)
get_Login( str )
# newVal is a string (input)
put_Login( newVal )
The HTTP login for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
# Returns an integer value
get_NumBytesSent( )
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.
# str is a CkString object (output)
get_Password( str )
# newVal is a string (input)
put_Password( newVal )
The HTTP password for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
# path is a CkString object (output)
get_Path( path )
# path is a string (input)
put_Path( 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"
# Returns an integer value
get_PercentUploaded( )
Contains the current percentage completion (0 to 100) while an asynchronous upload is in progress.
# Returns an integer value
get_Port( )
# port is an integer (input)
put_Port( 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).
# str is a CkString object (output)
get_ProxyDomain( str )
# v is a string (input)
put_ProxyDomain( 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
# str is a CkString object (output)
get_ProxyLogin( str )
# newVal is a string (input)
put_ProxyLogin( newVal )
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
# str is a CkString object (output)
get_ProxyPassword( str )
# newVal is a string (input)
put_ProxyPassword( newVal )
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
# Returns an integer value
get_ProxyPort( )
# n is an integer (input)
put_ProxyPort( n )
The port number of a proxy server if an HTTP proxy is used.
# body is a CkByteData object (output)
get_ResponseBody( body )
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.
# header is a CkString object (output)
get_ResponseHeader( header )
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.
# Returns an integer value
get_ResponseStatus( )
The HTTP response status code of the HTTP response. A list of HTTP status codes can be found here: HTTP Response Status Codes.
# Returns an integer value
get_TotalUploadSize( )
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.
# Returns a boolean value
get_UploadInProgress( )
Set to 1 when an asynchronous upload is started. When the asynchronous upload is complete, this property becomes equal to 0. 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.
# Returns a boolean value
get_UploadSuccess( )
Set to 1 (success) or 0 (failed) after an asynchronous upload completes or aborts due to failure. When a program does an asynchronous upload, it will wait until UploadInProgress becomes 0. It will then check the value of this property to determine if the upload was successful or not.
# Returns a boolean value
get_Utf8( )
# b is a boolean (input)
put_Utf8( b )
To be documented soon...
# str is a CkString object (output)
get_Version( str )
The version of the Chilkat Upload component, such as "2.0.0".
Methods
AbortUpload( )
May be called during an asynchronous upload to abort.
# name is a string (input)
# value is a string (input)
AddCustomHeader( name, value )
Adds a custom HTTP header to the HTTP upload.
# name is a string (input)
# filename is a string (input)
AddFileReference( name, 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.
# name is a string (input)
# value is a string (input)
AddParam( name, value )
Adds a custom HTTP request parameter to the upload.
# Returns a boolean value
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 0. At that point, the UploadSuccess property may be checked to determine success (1) or failure (0). Returns 1 for success, 0 for failure. Asynchronous HTTP Upload Example Asynchronous HTTPS Upload Example
# Returns a boolean value
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 1 for success, 0 for failure. BlockingUpload Example
# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )
Saves the last error information to an XML formatted file.
# millisec is an integer (input)
SleepMs( 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.
# dataBuf is a CkByteData object (output)
# Returns a boolean value
UploadToMemory( 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.
# Returns a string
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".
# Returns a string
lastErrorHtml( )
Error information in HTML format for the last method called.
# Returns a string
lastErrorText( )
Error information in plain-text format for the last method called.
# Returns a string
lastErrorXml( )
Error information in XML format for the last method called.
# Returns a string
login( )
The HTTP login for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
# Returns a string
password( )
The HTTP password for sites requiring authentication. Chilkat Upload supports Basic HTTP authentication.
# Returns a string
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"
# Returns a string
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
# Returns a string
proxyLogin( )
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
# Returns a string
proxyPassword( )
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
# Returns a string
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.
# Returns a string
version( )
The version of the Chilkat Upload component, such as "2.0.0".
|