HttpClient Class |
Provides low-level access to HTTP file transfers. ExFTPConnection
provides a superior interface and is recommended for general use.
Inheritance HierarchyNamespace: EnterpriseDT.Net.Ftp.Http
Assembly: edtFTPnetPRO (in edtFTPnetPRO.dll) Version: 12.3.0.0
SyntaxThe HttpClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HttpClient | Initializes a new instance of the HttpClient class |
Properties| Name | Description | |
|---|---|---|
 | CloseStreamsAfterTransfer |
If true then streams are closed after a transfer has completed.
|
| ControlPort |
The port on the server to which to connect to.
|
| Cookies |
Stores any cookies returned by the server
|
| CountBeforeSleep |
Number of transfers before going to sleep
|
| DataEncoding |
The encoding to use for data when transferring in ASCII mode.
|
| DeleteOnFailure |
Controls whether or not a file is deleted when a failure occurs.
|
| DetectTransferMode |
If set to true, the transfer mode in operations involving multiple files is
automatically changed between ASCII and binary as appropriate.
|
| HttpMethod |
HTTP method to use - GET is the default
|
| HttpParameters |
Holds the HTTP parameters to be used for the
next operation. These should be cleared if no
parameters are to be used.
|
| IsConnected |
Indicates whether the client is currently connected with the server.
|
| IsResuming |
Returns true if the next transfer is to be resumed (i.e. Resume has been called).
|
| LastBytesTransferred |
The number of bytes transferred in the last transfer operation.
|
| LastFileTransferred |
The remote name/path of the last file transferred.
|
| LicenseKey |
The license key string.
|
| LicenseOwner |
The license owner string.
|
| MaxTransferRate |
The maximum transfer rate in bytes per sec
|
| Password |
Password to user (if required)
|
| ProxySettings |
Settings for using proxies.
|
| RemoteHost |
The domain-name or IP address of the HTTP server.
|
| ServerValidation |
Controls the way in which server certificates are validated.
|
| ShowHiddenFiles |
Include hidden files in operations that involve listing of directories,
and if supported by the server. Not applicable for HTTP.
|
| SleepEnabled |
Enabling or not of sleeping after a certain number of transfers
|
| SleepTime |
Number of seconds spent asleep
|
| Timeout |
Timeout on the requests in milliseconds.
|
| TransferBufferSize |
The size of the buffers (in bytes) used in writing to and reading from the data-sockets.
|
| TransferNotifyInterval |
The number of bytes transferred between each notification of the
BytesTransferred event.
|
| TransferNotifyListings |
By default the BytesTransferred event is not triggered during directory
listings - this property can be used to enable this behaviour.
|
| TransferType | The current file transfer type (BINARY or ASCII). |
| UserAgent |
User agent for HTTP requests
|
| UserName |
User name to use (if required)
|
| WelcomeMessage |
Returns nothing since HTTP doesn't inherently support welcome messages.
|
Methods| Name | Description | |
|---|---|---|
| CancelResume |
Cancel the resume. Use this method if something goes wrong
and the client is left in an inconsistent state
|
| CancelTransfer | Cancels the current transfer. |
| CdUp | Change the remote working directory to the parent directory. |
| ChDir | Change the remote working directory to that supplied. |
| Connect | Does nothing for this protocol. |
| Delete |
Not supported by all HTTP servers
|
| Dir |
List an HTML page's hrefs as an array of strings.
|
| Dir(String) |
List an HTML page's hrefs as an array of strings.
|
| Dir(String, Boolean) |
List an HTML page's hrefs as an array of strings.
|
| DirDetails |
List the current directory's hrefs as an array of FTPFile objects.
|
| DirDetails(String) |
List an HTML page's hrefs as an array of FTPFile objects.
|
| DirDetails(String, FTPFileCallback) | |
| DirDetails(String, Boolean) |
Returns the given directory's contents and optionally that of its subdirectories
as an array of FTPFile objects.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Exists | |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Get(String) | Get data from the FTP server. |
| Get(Stream, String) |
Get data from the HTTP server.
|
| Get(String, String) |
Get data from the HTTP server.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLocalCRC |
Get the CRC-32 checksum for the named local file
|
| GetRemoteCRC |
Get the CRC-32 checksum for the named remote file. Not supported in HTTP.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MkDir |
Not supported by HTTP
|
| ModTime | Get modification time for a remote file. |
| MultipleDelete(FileFilter) |
Delete multiple files in the current remote directory
|
| MultipleDelete(String) |
Delete multiple files in the current remote directory
|
| MultipleDelete(String, FileFilter, Boolean) |
Delete multiple files in the current remote directory and its subdirectories.
|
| MultipleDelete(String, String, Boolean) |
Delete multiple files in the current remote directory and its subdirectories.
|
| MultipleDeleteDirectories |
Remove a remote directory, and all its files and its subdirectories
|
| MultipleGet(String, FileFilter) |
Get multiple files into the specified local directory from the current remote directory
|
| MultipleGet(String, String) |
Get multiple files into the specified local directory from the current remote directory
|
| MultipleGet(String, String, FileFilter, Boolean) |
Get multiple files from the specified remote directory into the specified local directory
|
| MultipleGet(String, String, String, Boolean) |
Get multiple files from the specified remote directory into the specified local directory
|
| MultiplePut(String, FileFilter) |
Put multiple files from the specified local directory into the current remote directory
|
| MultiplePut(String, String) |
Put multiple files from the specified local directory into the current remote directory
|
| MultiplePut(String, String, FileFilter, Boolean) |
Put multiple files from the specified local directory into the specified remote directory
|
| MultiplePut(String, String, String, Boolean) |
Put multiple files from the specified local directory into the specified remote directory
|
| OnBytesTransferred | |
| OnTransferCompleteEx | |
| OnTransferStartedEx | |
| Put(Byte, String) | |
| Put(Stream, String) | |
| Put(String, String) | |
| Put(Byte, String, Boolean) | |
| Put(Stream, String, Boolean) | |
| Put(String, String, Boolean) | |
| Pwd | Get the current remote working directory. |
| Quit | Quit the HTTP session. |
| QuitImmediately |
Quit the FTP session immediately by closing the control socket
without sending the QUIT command.
|
| Rename |
Not supported by HTTP
|
| Resume | Make the next file transfer resume. |
| ResumeDownload | Make the next download resume at a specific point. |
| RmDir |
Not supported by HTTP
|
| SetModTime |
Not supported by HTTP
|
| Size |
Get the size of a remote file.
|
| TestConnection |
Does nothing for HTTP protocol
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unlock |
Unlock the software for use. This method should be used when
a configuration file isn't available
|
Events| Name | Description | |
|---|---|---|
 | BytesTransferred |
Event triggered every time TransferNotifyInterval bytes transferred.
|
| ParseHtmlLink |
If set this event allows customized parsing of HTML links
|
| TransferCompleteEx |
Notifies of the completion of a transfer
|
| TransferStartedEx |
Notifies of the start of a transfer
|
Fields| Name | Description | |
|---|---|---|
 | connected |
Indicates whether Connect() has been called (or Quit()).
|
| currentDirectory |
Current directory
|
| currentlyListing | A directory listing is being performed |
| key |
License key
|
| lastBytesTransferred |
Holds the number of bytes transferred in that most recent transfer.
|
| lastFileTransferred |
Name of the last file transferred.
|
| monitorInterval | Bytes transferred in between monitor callbacks |
| owner |
License owner
|
| socks |
SOCKS settings
|
| throttler |
Threshold for throttling
|
| transferNotifyListings | Should BytesTransferred event be triggered in directory listings? |
| transferType | Record of the transfer type - make the default BINARY for now |
See Also