HttpListener Class

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.HttpListener.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: HttpListener.cs

Source:: HttpListener.cs

Source:: HttpListener.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.

Provides a simple, programmatically controlled HTTP protocol listener. This class cannot be inherited.

public ref class HttpListener sealed : IDisposable

public sealed class HttpListener : IDisposable

type HttpListener = class
    interface IDisposable

Public NotInheritable Class HttpListener
Implements IDisposable

Inheritance: Object
HttpListener

Implements: IDisposable

Examples

// 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

For more information about this API, see Supplemental API remarks for HttpListener.

Constructors

HttpListener()

Initializes a new instance of the HttpListener class.

Properties

AuthenticationSchemes	Gets or sets the scheme used to authenticate clients.
AuthenticationSchemeSelectorDelegate	Gets or sets the delegate called to determine the protocol used to authenticate clients.
DefaultServiceNames	Gets a default list of Service Provider Names (SPNs) as determined by registered prefixes.
ExtendedProtectionPolicy	Gets or sets the ExtendedProtectionPolicy to use for extended protection for a session.
ExtendedProtectionSelectorDelegate	Gets or sets the delegate called to determine the ExtendedProtectionPolicy to use for each request.
IgnoreWriteExceptions	Gets or sets a Boolean value that specifies whether your application receives exceptions that occur when an HttpListener sends the response to the client.
IsListening	Gets a value that indicates whether HttpListener has been started.
IsSupported	Gets a value that indicates whether HttpListener can be used with the current operating system.
Prefixes	Gets the Uniform Resource Identifier (URI) prefixes handled by this HttpListener object.
Realm	Gets or sets the realm, or resource partition, associated with this HttpListener object.
TimeoutManager	The timeout manager for this HttpListener instance.
UnsafeConnectionNtlmAuthentication	Gets or sets a Boolean value that controls whether, when NTLM is used, additional requests using the same Transmission Control Protocol (TCP) connection are required to authenticate.

Methods

Abort()	Shuts down the HttpListener object immediately, discarding all currently queued requests.
BeginGetContext(AsyncCallback, Object)	Begins asynchronously retrieving an incoming request.
Close()	Shuts down the HttpListener.
EndGetContext(IAsyncResult)	Completes an asynchronous operation to retrieve an incoming client request.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetContext()	Waits for an incoming request and returns when one is received.
GetContextAsync()	Waits for an incoming request 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)
Start()	Allows this instance to receive incoming requests.
Stop()	Causes this instance to stop receiving new incoming requests and terminates processing of all ongoing requests.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IDisposable.Dispose()

Releases the resources held by this HttpListener object.

Applies to

Jaa