Click or drag to resize

HttpClientResponse Class

The HttpClientResponse class represents an HTTP response received by the client from the server.
Inheritance Hierarchy

Namespace: Crestron.SimplSharp.Net.Http
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public class HttpClientResponse : HttpIncomingRequestResponse, 
	IDisposable

The HttpClientResponse type exposes the following members.

Constructors
 NameDescription
Protected methodHttpClientResponse Creates a new instance of the HttpClientResponse class.
Top
Properties
 NameDescription
Public propertyChunked Determines whether data being transferred will be chunked or not.
(Inherited from HttpIncomingRequestResponse)
Protected propertyClient Gets a flag indicating whether this class is used in a client application. The value of this property is always true.
(Overrides HttpRequestResponseClient)
Public propertyCode Gets the HTTP Result code received from the server. HTTP codes of 300 and above usually indicate a redirect or error on the server side (such as 404 "File not Found")
Public propertyContentBytes Returns the HTTP body in the form of a byte array. The stream unexpected ended.Error reading HTTP chunk data.
(Inherited from HttpIncomingRequestResponse)
Public propertyContentLength Contains the ContentLength header value received from the remote side. If the remote did not provide a length (for example in HTTP 1.0 scenarios, or if Keep-Alive is not supported), accessing the property will raise an exception. Use the HasContentLength property to determine if a valid ContentLength has been received.
(Inherited from HttpIncomingRequestResponse)
Public propertyContentStream Returns a Stream object with the HTTP body of the received request (server) or response (client). Because ContentStream provides you with direct access to the underlying Connection Stream, it is the fastest and most efficient way to access the response (as opposed to ContentString and ContentBytes, both of which involve copying the entire data from the stream into a memory buffer).
(Inherited from HttpIncomingRequestResponse)
Public propertyContentString Returns the HTTP body in form of a String object. The stream unexpected ended.Error reading HTTP chunk data.
(Inherited from HttpIncomingRequestResponse)
Public propertyDataConnection Gets the Data Connection for the HttpIncomingRequestResponse instance.
(Inherited from HttpIncomingRequestResponse)
Public propertyEncoding Determines the Encoding for the HTTP Request Response
(Inherited from HttpRequestResponse)
Public propertyHasContentLength Specifies whether the HTTP header provides a ContentLength field.
(Inherited from HttpIncomingRequestResponse)
Protected propertyHasOnTransferProgress Determines whether the current HTTPRequest Response has an OnTransferProgress event handler.
(Inherited from HttpRequestResponse)
Public propertyHeader Get or set the HTTP Response Header
(Inherited from HttpRequestResponse)
Public propertyIsCompleted Gets a value that indicates whether the asynchronous operation completed.
(Inherited from HttpRequestResponse)
Public propertyKeepAlive Keeps the HTTP Request Response connection alive. 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.
(Inherited from HttpIncomingRequestResponse)
Public propertyResponseUrl Gets the URL of the Internet resource that responded to the request.
Protected propertyServer Gets a flag indicating whether this class is used in a server application. The value of this class is always false.
(Overrides HttpRequestResponseServer)
Public propertyThisClient Gets the Client that is host to this Async request
(Inherited from HttpRequestResponse)
Top
Methods
 NameDescription
Public methodCloneEvents Clones the events of the HTTP Request Response.
(Inherited from HttpRequestResponse)
Public methodDispose Releases resources used by the current instance, in particular the disposed HTTP connection instance that was provided as a constructor parameter earlier.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFlushContent Flush the content of the HTTP Incoming Stream.
(Inherited from HttpIncomingRequestResponse)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Protected methodTriggerOnTransferEnd Trigger the OnTransferEnd Event Handler
(Inherited from HttpRequestResponse)
Protected methodTriggerOnTransferProgress Trigger the OnTransferProgress Event Handler
(Inherited from HttpRequestResponse)
Protected methodTriggerOnTransferStart Trigger the OnTransferStart Event Handler
(Inherited from HttpRequestResponse)
Public methodValidate Validate the HTTP Client Response.
(Overrides HttpIncomingRequestResponseValidate)
Top
Events
 NameDescription
Public eventOnTransferEnd OnTransferEnd Event Handler
(Inherited from HttpRequestResponse)
Public eventOnTransferProgress OnTransferProgress Event Handler
(Inherited from HttpRequestResponse)
Public eventOnTransferStart OnTransferStart Event handler
(Inherited from HttpRequestResponse)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also