Click or drag to resize

HttpClient Properties

The HttpClient type exposes the following members.

Properties
 NameDescription
Public propertyAccept Gets or sets content types that are acceptable for the response. The default value is "text/html, image/gif, image/jpeg, image/png, */*".
Public propertyAllowAutoRedirect Gets or sets a value that indicates whether the request should follow redirection responses (HTTP codes from 300 to 399). Default Value: true
Public propertyBindingObsolete.
Obsolete - Please use BindingV4 and BindingV6 instead.
(Inherited from Client)
Public propertyBindingV4 Gets the binding which provides properties and methods such as address family, IPv4 address, port number etc for client to connect to the host network.
(Inherited from Client)
Public propertyBindingV6 Gets the binding which provides properties and methods such as address family, IPv6 address, port number etc for client to connect to the host network.
(Inherited from Client)
Public propertyConnectionClass Use the ConnectionClass property to specify an alternative Connection class to be used for out coming data connections. Existing connections are not affected by changing the property.
(Inherited from Client)
Protected propertyConnectionPool Get or set the Connection Pool for this Client Instance.
(Inherited from Client)
Public propertyCustomConnectionPool Gets or sets the custom connection pool. This property is inherited from the Client class.
Public propertyDnsResolveType Determines if the specified HostName should be looked up only: Once per application run (if you establish multiple connections to the server, the subsequent connections will use the cached IPAddress) or Always, for each connect (the Hostname will be resolved again for each subsequent connect). You'll usually only change this setting off the default (Once) if you anticipate the IPAddress of the target host to change frequently.
(Inherited from Client)
Public propertyEnableNagle Set the property value to true to enable the Nagle algorithm for send coalescing.
(Inherited from Client)
Public propertyHostAddress Gets or sets a Client Host IP Address as a string.
(Inherited from Client)
Public propertyHostName The server host name or IP address that you intend the client to connect to.
(Inherited from Client)
Public propertyKeepAlive Controls whether to use HTTP Keep-Alive to keep the connection alive between requests. If enabled (true) , once a request is made and a connection is established, this connection is kept open and used for future requests. If disabled, the connection is closed, and a new connection is created for future requests.
Public propertyMaximumAutomaticRedirections Gets or sets the maximum number of redirects that the request follows. Default Value: 20
Public propertyPassword Password that will be inserted into the Authorization HTTP header in the request to the server.
Public propertyPort The server Port that you intend the client to connect to.
Remarks
If you do not assign a port number on this property, the port number in the parsed URL will be used.
Remarks
If a port number is assigned in the parsed URL, it will take precedence over this property.

(Inherited from Client)
Public propertyProcessBusy If using commands with callbacks, check this busy flag before using another command (Dispatch, Get, Post, etc.)
Public propertyTimeout Gets or sets the maximum amount of time (in seconds) that a client will wait for a server response within a single request. The default value is 60 seconds (1 minute). The timeout handling can be activated via the TimeoutEnabled property.
Public propertyTimeoutEnabled This property controls whether the request operation will do an automatic timeout checking. If timeout handling is turned on (i.e. this property is set to true) and a request takes longer than Timeout, it will be terminated.
Public propertyUrl Gets or sets the URL of the remote server.
Public propertyUseConnectionPooling Enables or disables connection pooling.
Public propertyUserAgent Gets or sets the identifier of the software being used to retrieve data via the URL. Some custom HTTP servers check this HTTP header to provide content optimized for particular HTTP browsers.
Public propertyUserName Name that will be inserted into the Authorization HTTP header in the request to the server.
Public propertyUserObject Gets the last user specified Object for the Async operations on this HTTP Client instance. The return value will evaluate to null if Async operations with the object parameter are not utilized.
Public propertyVerbose Set Logging to Verbose on/off
Public propertyVersion Gets or sets the version identifier of the UserAgent. Can be used to mimic particular browsers like Internet Explorer 6.0
Top
See Also