Click or drag to resize

HttpClientRequest Class

The HttpClientRequest class represents an HTTP request sent from the client to the server.
Inheritance Hierarchy

Namespace: Crestron.SimplSharp.Net.Http
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public class HttpClientRequest : HttpOutgoingRequestResponse

The HttpClientRequest type exposes the following members.

Constructors
 NameDescription
Public methodHttpClientRequest Creates an instance of the HttpClientRequest Class.
Top
Properties
 NameDescription
Protected propertyClient Gets a flag indicating whether this class is used in a client application. The value of this class is always true.
(Overrides HttpRequestResponseClient)
Public propertyCloseStream When ContentSource is set to ContentStream (and a ContentStream is assigned), this property determines if the stream should be closed automatically after sending it to the connection (true) or not (false).
(Inherited from HttpOutgoingRequestResponse)
Public propertyContentBytes Assigns a byte array to send back as the HTTP body to this property.
(Inherited from HttpOutgoingRequestResponse)
Public propertyContentSource Defines which property (ContentBytes, ContentStream or ContentString) will be used to send the body of the response. Assigning any of these three properties will automatically set the ContentSource property so that the content will always be sent from the appropriate source.
(Inherited from HttpOutgoingRequestResponse)
Public propertyContentStream Assigns a stream to send back as HTTP body to this property. When assigned (and ContentSource is set to ContentStream), you can use the CloseStream property to determine if the stream should be closed automatically after sending it to the connection (true) or not (false).
(Inherited from HttpOutgoingRequestResponse)
Public propertyContentString Assigns a string to send back as HTTP body to this property.
(Inherited from HttpOutgoingRequestResponse)
Public propertyEncoding Determines the Encoding for the HTTP Request Response
(Inherited from HttpRequestResponse)
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 Determines the keep alive status of the HTTP Outgoing Request Response.
(Inherited from HttpOutgoingRequestResponse)
Public propertyRequestType Gets or sets the type of the HTTP request. Possible values are: RequestType.Get RequestType.Post RequestType.Put RequestType.Delete RequestType.Head RequestType.Patch The default value of this class is RequestType.Get.
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)
Public propertyUrl Gets or sets the target URL for the HTTP request.
Top
Methods
 NameDescription
Public methodCloneEvents Clones the events of the HTTP Request Response.
(Inherited from HttpRequestResponse)
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 methodFinalizeHeader Sets the HTTP headers of the request.
(Overrides HttpOutgoingRequestResponseFinalizeHeader)
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)
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