This documentation is archived and is not being maintained.

HttpListenerContext.Request Property

Gets the HttpListenerRequest that represents a client's request for a resource.

Namespace:  System.Net
Assembly:  System (in System.dll)

'Declaration
Public ReadOnly Property Request As HttpListenerRequest

Property Value

Type: System.Net.HttpListenerRequest
An HttpListenerRequest object that represents the client request.

If you close this HttpListenerContext, it will send the response to the client, close the HttpListenerResponse that contains the response, and close the HttpListenerRequest object returned by this property.

Windows XP Home Edition, Windows XP Professional x64 Edition, Windows Server 2003 Platform Note: Service pack 2 is required to use the HttpListener class.

Windows Server 2003 Platform Note: Supports the use of the HttpListener class.

The following code example demonstrates calling this method. The listener variable holds an HttpListener object.


' This example requires the System and System.Net namespaces.
Public Shared Function ClientInformation(ByVal context As HttpListenerContext) As String
    Dim user As System.Security.Principal.IPrincipal = context.User
    Dim id As System.Security.Principal.IIdentity = user.Identity
    If id Is Nothing Then
        Return "Client authentication is not enabled for this Web server."
    End If

    Dim display As String
    If id.IsAuthenticated Then
        display = String.Format("{0} was authenticated using {1}", id.Name, id.AuthenticationType)
    Else
        display = String.Format("{0} was not authenticated", id.Name)
    End If
    Return display
End Function

Public Shared Sub SimpleListenerWithAuthentication(ByVal 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 OrElse prefixes.Length = 0 Then
        Throw New ArgumentException("prefixes")
    End If

    ' Set up a listener.
    Dim listener As New HttpListener()
    For Each s As String In prefixes
        listener.Prefixes.Add(s)
    Next s
    listener.Start()
    ' Specify Negotiate as the authentication scheme.
    listener.AuthenticationSchemes = AuthenticationSchemes.Negotiate
    Console.WriteLine("Listening...")
    ' GetContext blocks while waiting for a request. 
    Dim context As HttpListenerContext = listener.GetContext()
    Dim request As HttpListenerRequest = context.Request
    ' Obtain a response object.
    Dim response As HttpListenerResponse = context.Response
    ' Construct a response.
    Dim clientInformation As String = ListenerBasic.ClientInformation(context)
    Dim buffer() As Byte = System.Text.Encoding.UTF8.GetBytes("<HTML><BODY> " & clientInformation & "</BODY></HTML>")
    ' 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)
    output.Close()
    listener.Stop()
End Sub


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: