An NDoc Documented Class Library

HttpClient Members

HttpClient overview

Public Instance Constructors

HttpClient Constructor Initializes a new instance of the HttpClient class.

Public Instance Properties

CloseStreamsAfterTransfer If true then streams are closed after a transfer has completed.
ControlPort The port on the server to which to connect to.
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.
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.
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
SocksContextObsolete. Not applicable for HTTP. SOCKS proxies are not supported.
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.
TransferTypeThe 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.

Public Instance Methods

CancelResume Cancel the resume. Use this method if something goes wrong and the client is left in an inconsistent state
CancelTransferCancels the current transfer.
CdUpChange the remote working directory to the parent directory.
ChDirChange the remote working directory to that supplied.
ConnectConnect to the HTTP server and verify it is available.
Delete Not supported by HTTP
DirOverloaded. List an HTML page's hrefs as an array of strings.
DirDetailsOverloaded. List the current directory's hrefs as an array of FTPFile objects.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Exists 
GetOverloaded. Get data from the FTP server.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
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 (inherited from Object) Gets the Type of the current instance.
MkDir Not supported by HTTP
ModTimeGet modification time for a remote file.
MultipleDeleteOverloaded. Delete multiple files in the current remote directory and its subdirectories.
MultipleDeleteDirectories Remove a remote directory, and all its files and its subdirectories
MultipleGetOverloaded. Get multiple files from the specified remote directory into the specified local directory
MultiplePutOverloaded. Put multiple files from the specified local directory into the specified remote directory
PutOverloaded.  
PwdGet the current remote working directory.
QuitQuit the HTTP session.
QuitImmediately Quit the FTP session immediately by closing the control socket without sending the QUIT command.
Rename Not supported by HTTP
ResumeMake the next file transfer resume.
RmDir Not supported by HTTP
SetModTime Not supported by HTTP
Size Get the size of a remote file.
ToString (inherited from Object) Returns a String that represents the current Object.
Unlock Unlock the software for use. This method should be used when a configuration file isn't available

Public Instance Events

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

Protected Instance Fields

connected Indicates whether Connect() has been called (or Quit()).
currentDirectory Current directory
key License key
owner License owner
throttler Threshold for throttling

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

Protected Internal Instance Fields

socks SOCKS settings

See Also

HttpClient Class | EnterpriseDT.Net.Ftp.Http Namespace