HttpListener.Start Method

Definition

Namespace:

System.Net

Assembly:

System.Net.HttpListener.dll

Source:

HttpListener.Managed.cs

Allows this instance to receive incoming requests.

public:
 void Start();

public void Start ();

member this.Start : unit -> unit

Public Sub Start ()

Exceptions

HttpListenerException

A Win32 function call failed. Check the exception's ErrorCode property to determine the cause of the exception.

ObjectDisposedException

This object is closed.

Examples

The following code example demonstrates using the Start method to begin processing incoming requests.

public static void NonblockingListener(string [] prefixes)
{
    HttpListener listener = new HttpListener();
    foreach (string s in prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.Start();
    IAsyncResult result = listener.BeginGetContext(new AsyncCallback(ListenerCallback),listener);
    // Applications can do some work here while waiting for the
    // request. If no work can be done until you have processed a request,
    // use a wait handle to prevent this thread from terminating
    // while the asynchronous operation completes.
    Console.WriteLine("Waiting for request to be processed asyncronously.");
    result.AsyncWaitHandle.WaitOne();
    Console.WriteLine("Request processed asyncronously.");
    listener.Close();
}

Public Shared Sub NonblockingListener(ByVal prefixes As String())
    Dim listener As HttpListener = New HttpListener()

    For Each s As String In prefixes
        listener.Prefixes.Add(s)
    Next

    listener.Start()
    Dim result As IAsyncResult = listener.BeginGetContext(New AsyncCallback(AddressOf ListenerCallback), listener)
    ' Applications can do some work here while waiting for the 
    ' request. If no work can be done until you have processed a request,
    ' use a wait handle to prevent this thread from terminating
    ' while the asynchronous operation completes.
    Console.WriteLine("Waiting for request to be processed asyncronously.")
    result.AsyncWaitHandle.WaitOne()
    Console.WriteLine("Request processed asyncronously.")
    listener.Close()
End Sub

Remarks

This method must be called before you call the GetContext or BeginGetContext method.

After you have started an HttpListener object, you can use the Stop method to stop it.

Note

If this listener instance uses https, you must install and select a Server Certificate. Otherwise, an HttpWebRequest query of this HttpListener will fail with an unexpected close of the connection. You can configure Server Certificates and other listener options by using HttpCfg.exe.

Notes to Callers

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.