HttpListenerRequest Class

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.HttpListener.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: HttpListenerRequest.cs

Source:: HttpListenerRequest.cs

Source:: HttpListenerRequest.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Describes an incoming HTTP request to an HttpListener object. This class cannot be inherited.

public ref class HttpListenerRequest sealed

public sealed class HttpListenerRequest

type HttpListenerRequest = class

Public NotInheritable Class HttpListenerRequest

Inheritance: Object
HttpListenerRequest

Examples

The following code example demonstrates how to receive and respond to a HttpListenerRequest.

// This example requires the System and System.Net namespaces.
public static void SimpleListenerExample(string[] prefixes)
{
    if (!HttpListener.IsSupported)
    {
        Console.WriteLine ("Windows XP SP2 or Server 2003 is required to use the HttpListener class.");
        return;
    }
    // URI prefixes are required,
    // for example "http://contoso.com:8080/index/".
    if (prefixes == null || prefixes.Length == 0)
      throw new ArgumentException("prefixes");

    // Create a listener.
    HttpListener listener = new HttpListener();
    // Add the prefixes.
    foreach (string s in prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.Start();
    Console.WriteLine("Listening...");
    // Note: The GetContext method blocks while waiting for a request.
    HttpListenerContext context = listener.GetContext();
    HttpListenerRequest request = context.Request;
    // Obtain a response object.
    HttpListenerResponse response = context.Response;
    // Construct a response.
    string responseString = "<HTML><BODY> Hello world!</BODY></HTML>";
    byte[] buffer = System.Text.Encoding.UTF8.GetBytes(responseString);
    // Get a response stream and write the response to it.
    response.ContentLength64 = buffer.Length;
    System.IO.Stream output = response.OutputStream;
    output.Write(buffer,0,buffer.Length);
    // You must close the output stream.
    output.Close();
    listener.Stop();
}

Public Shared Sub SimpleListenerExample(prefixes As String())
    If Not HttpListener.IsSupported Then
        Console.WriteLine("Windows XP SP2 or Server 2003 is required to use the HttpListener class.")
        Return
    End If
    ' URI prefixes are required,
    ' for example "http://contoso.com:8080/index/".
    If prefixes Is Nothing Or prefixes.Length = 0 Then
        Throw New ArgumentException("prefixes")
    End If

    ' Create a listener
    Dim listener = New HttpListener()

    For Each s As String In prefixes
        listener.Prefixes.Add(s)
    Next
    listener.Start()
    Console.WriteLine("Listening...")
    ' Note: The GetContext method blocks while waiting for a request.
    Dim context As HttpListenerContext = listener.GetContext()
    Console.WriteLine("Listening...")
    ' Obtain a response object
    Dim request As HttpListenerRequest = context.Request
    ' Construct a response.
    Dim response As HttpListenerResponse = context.Response
    Dim responseString As String = "<HTML><BODY> Hello world!</BODY></HTML>"
    Dim buffer As Byte() = System.Text.Encoding.UTF8.GetBytes(responseString)
    ' Get a response stream and write the response to it.
    response.ContentLength64 = buffer.Length
    Dim output As System.IO.Stream = response.OutputStream
    output.Write(buffer, 0, buffer.Length)
    'You must close the output stream.
    output.Close()
    listener.Stop()
End Sub

Remarks

When a client makes a request to a Uniform Resource Identifier (URI) handled by an HttpListener object, the HttpListener provides a HttpListenerContext object that contains information about the sender, the request, and the response that is sent to the client. The HttpListenerContext.Request property returns the HttpListenerRequest object that describes the request.

The HttpListenerRequest object contains information about the request, such as the request HttpMethod string, UserAgent string, and request body data (see the InputStream property).

To reply to the request, you must get the associated response using the Response property.

Properties

AcceptTypes	Gets the MIME types accepted by the client.
ClientCertificateError	Gets an error code that identifies a problem with the X509Certificate provided by the client.
ContentEncoding	Gets the content encoding that can be used with data sent with the request.
ContentLength64	Gets the length of the body data included in the request.
ContentType	Gets the MIME type of the body data included in the request.
Cookies	Gets the cookies sent with the request.
HasEntityBody	Gets a Boolean value that indicates whether the request has associated body data.
Headers	Gets the collection of header name/value pairs sent in the request.
HttpMethod	Gets the HTTP method specified by the client.
InputStream	Gets a stream that contains the body data sent by the client.
IsAuthenticated	Gets a Boolean value that indicates whether the client sending this request is authenticated.
IsLocal	Gets a Boolean value that indicates whether the request is sent from the local computer.
IsSecureConnection	Gets a Boolean value that indicates whether the TCP connection used to send the request is using the Secure Sockets Layer (SSL) protocol.
IsWebSocketRequest	Gets a Boolean value that indicates whether the TCP connection was a WebSocket request.
KeepAlive	Gets a Boolean value that indicates whether the client requests a persistent connection.
LocalEndPoint	Gets the server IP address and port number to which the request is directed.
ProtocolVersion	Gets the HTTP version used by the requesting client.
QueryString	Gets the query string included in the request.
RawUrl	Gets the URL information (without the host and port) requested by the client.
RemoteEndPoint	Gets the client IP address and port number from which the request originated.
RequestTraceIdentifier	Gets the request identifier of the incoming HTTP request.
ServiceName	Gets the Service Provider Name (SPN) that the client sent on the request.
TransportContext	Gets the TransportContext for the client request.
Url	Gets the Uri object requested by the client.
UrlReferrer	Gets the Uniform Resource Identifier (URI) of the resource that referred the client to the server.
UserAgent	Gets the user agent presented by the client.
UserHostAddress	Gets the server IP address and port number to which the request is directed.
UserHostName	Gets the DNS name and, if provided, the port number specified by the client.
UserLanguages	Gets the natural languages that are preferred for the response.

Methods

BeginGetClientCertificate(AsyncCallback, Object)	Begins an asynchronous request for the client's X.509 v.3 certificate.
EndGetClientCertificate(IAsyncResult)	Ends an asynchronous request for the client's X.509 v.3 certificate.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetClientCertificate()	Retrieves the client's X.509 v.3 certificate.
GetClientCertificateAsync()	Retrieves the client's X.509 v.3 certificate as an asynchronous operation.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Jaa