Using the HttpListener class, you can create a simple HTTP protocol listener that responds to HTTP requests. The listener is active for the lifetime of the HttpListener object and runs within your application with its permissions.

Note
This class is available only on computers running the Windows XP SP2 or Windows Server 2003 operating systems. If you attempt to create an HttpListener object on a computer that is running an earlier operating system, the constructor throws a PlatformNotSupportedException exception.

To use HttpListener, create a new instance of the class using the HttpListener constructor and use the Prefixes property to gain access to the collection that holds the strings that specify which Uniform Resource Identifier (URI) prefixes the HttpListener should process.

A URI prefix string is composed of a scheme (http or https), a host, an optional port, and an optional path. An example of a complete prefix string is "http://www.contoso.com:8080/customerData/". Prefixes must end in a forward slash ("/"). The HttpListener object with the prefix that most closely matches a requested URI responds to the request. Multiple HttpListener objects cannot add the same prefix; a Win32Exception exception is thrown if a HttpListener adds a prefix that is already in use.

When a port is specified, the host element can be replaced with "*" to indicate that the HttpListener accepts requests sent to the port if the requested URI does not match any other prefix. For example, to receive all requests sent to port 8080 when the requested URI is not handled by any HttpListener, the prefix is "http://*:8080/". Similarly, to specify that the HttpListener accepts all requests sent to a port, replace the host element with the "+" character, "https://+:8080". The "*" and "+" characters can be present in prefixes that include paths.

To begin listening for requests from clients, add the URI prefixes to the collection and call the Start method. HttpListener offers both synchronous and asynchronous models for processing client requests. Requests and their associated responses are accessed using the HttpListenerContext object returned by the GetContext method or its asynchronous counterparts, the BeginGetContext and EndGetContext methods.

The synchronous model is appropriate if your application should block while waiting for a client request and if you want to process only one request at a time. Using the synchronous model, call the GetContext method, which waits for a client to send a request. The method returns an HttpListenerContext object to you for processing when one occurs.

In the more complex asynchronous model, your application does not block while waiting for requests and each request is processed in its own execution thread. Use the BeginGetContext method to specify an application-defined method to be called for each incoming request. Within that method, call the EndGetContext method to obtain the request, process it, and respond.

In either model, incoming requests are accessed using the HttpListenerContext..::.Request property and are represented by HttpListenerRequest objects. Similarly, responses are accessed using the HttpListenerContext..::.Response property and are represented by HttpListenerResponse objects. These objects share some functionality with the HttpWebRequest and HttpWebResponse objects, but the latter objects cannot be used in conjunction with HttpListener because they implement client, not server, behaviors.

An HttpListener can require client authentication. You can either specify a particular scheme to use for authentication, or you can specify a delegate that determines the scheme to use. You must require some form of authentication to obtain information about the client's identity. For additional information, see the User, AuthenticationSchemes, and AuthenticationSchemeSelectorDelegate properties.

Note
If you create an HttpListener using https, you must select a Server Certificate for that listener. Otherwise, an HttpWebRequest query of this HttpListener will fail with an unexpected close of the connection.

Note
You can configure Server Certificates and other listener options by using HttpCfg.exe. See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/http/http/httpcfg_exe.asp for more details. The executable is shipped with Windows Server 2003, or can be built from source code available in the Platform SDK.

Note
If you specify multiple authentication schemes for the HttpListener, the listener will challenge clients in the following order: Negotiate, NTLM, Digest, and then Basic.

Windows Server 2003 Platform Note: Is required to use this class.

Windows XP Home Edition, Windows XP Professional x64 Edition, Windows Server 2003 Platform Note: Service Pack 2 or later is required to use this class

The following code example demonstrates using a HttpListener.

// 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();
}

.NET Framework

.NET Framework Client Profile

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

Reference

Other Resources

La clase HttpListener le permite crear un agente de escucha del protocolo HTTP sencillo que responde a las solicitudes HTTP. El agente de escucha está activo durante el período de duración del objeto HttpListener y se ejecuta dentro de una aplicación con sus permisos.

Nota
Esta clase sólo está disponible en los equipos que ejecutan el sistema operativo Windows XP SP2 o Windows Server 2003. Si intenta crear un objeto HttpListener en un equipo que está ejecutando un sistema operativo más antiguo, el constructor produce una excepción PlatformNotSupportedException.

Para utilizar HttpListener, cree una instancia nueva de la clase utilizando el constructor HttpListener y utilice la propiedad Prefixes para obtener acceso a la colección que contiene las cadenas que especifican qué prefijos de identificador uniforme de recursos (identificador URI) debería procesar HttpListener.

Una cadena del prefijo URI está compuesta por un esquema (http o https), un host, un puerto opcional y una ruta de acceso opcional. Un ejemplo de una cadena del prefijo completa es "http://www.contoso.com:8080/customerData/". Los prefijos deben finalizar en una barra diagonal ("/"). Responde a la solicitud el objeto HttpListener con el prefijo más parecido a un identificador URI solicitado. Objetos HttpListener distintos no pueden agregar el mismo prefijo; se produce una excepción Win32Exception si HttpListener agrega un prefijo que ya está en uso.

Cuando se especifica un puerto, el elemento de host se puede reemplazar con "*" para indicar que HttpListener acepta solicitudes enviadas al puerto si el identificador URI solicitado no coincide con ningún otro prefijo. Por ejemplo, para recibir todas las solicitudes enviadas al puerto 8080 cuando no hay ningún objeto HttpListener que controle el identificador URI solicitado, el prefijo es "http://*:8080/". De manera similar, para especificar que HttpListener acepta todas las solicitudes enviadas a un puerto, reemplace el elemento de host con el carácter "+", "https://+:8080". Los caracteres "*" y "+" pueden estar presentes en prefijos que incluyen rutas de acceso.

Para comenzar a escuchar las solicitudes de los clientes, agregue los prefijos URI a la colección y llame al método Start. HttpListener proporciona los modelos sincrónico y asincrónico para procesar las solicitudes de cliente. El acceso a las solicitudes y sus respuestas asociadas se realiza por medio del objeto HttpListenerContext devuelto por el método GetContext o sus homólogos asincrónicos, los métodos BeginGetContext y EndGetContext.

El modelo sincrónico es adecuado si su aplicación se debe bloquear para esperar una solicitud de cliente y si sólo desea procesar una solicitud a la vez. Con el modelo sincrónico, llame al método GetContext, que espera a que un cliente envíe una solicitud. El método devuelve un objeto HttpListenerContext que puede procesarse cuando aparezca uno.

En el modelo asincrónico más complejo, su aplicación no se bloquea en espera de solicitudes y cada solicitud se procesa en su propio subproceso de ejecución. Utilice el método BeginGetContext para especificar un método definido por la aplicación al que se llamará por cada solicitud de entrada. Dentro de ese método, llame al método EndGetContext para obtener la solicitud, procesarla y responderla.

En los dos modelos, el acceso a las solicitudes de entrada tiene lugar por medio de la propiedad HttpListenerContext..::.Request y están representadas por objetos HttpListenerRequest. De forma similar, el acceso a las respuestas se realiza utilizando la propiedad HttpListenerContext..::.Response y se representan mediante objetos HttpListenerResponse. Estos objetos comparten algunas funcionalidades con los objetos HttpWebRequest y HttpWebResponse, pero los últimos no se pueden utilizar junto con HttpListener porque implementan comportamientos de cliente, no de servidor.

Un objeto HttpListener puede requerir autenticación del cliente. Puede especificar un esquema determinado que desee utilizar para la autenticación o bien un delegado para determinar el esquema a utilizar. Debe exigir algún tipo de autenticación para obtener información sobre la identidad del cliente. Para obtener más información, vea las propiedades User, AuthenticationSchemes y AuthenticationSchemeSelectorDelegate.

Nota
Si crea un objeto HttpListener mediante https, seleccione un Certificado de servidor para ese agente de escucha. De lo contrario, en una consulta HttpWebRequest de HttpListener se producirá un error, con el cierre inesperado de la conexión.

Nota
Puede configurar Certificados de servidor y otras opciones de agente de escucha con HttpCfg.exe. Para obtener más información, vea http://msdn.microsoft.com/es-es/library/aa364478(vs.85).aspx. La aplicación ejecutable se distribuye con Windows Server 2003 o se puede generar a partir del código fuente disponible en el Platform SDK.

Nota
Si especifica varios esquemas de autenticación para el objeto HttpListener, el agente de escucha desafiará los clientes en el orden siguiente: Negotiate, NTLM, Digest y, a continuación, Basic.

Nota de la plataforma Windows Server 2003: Se requiere para poder utilizar esta clase.

Nota de la plataforma Windows XP Home Edition, Windows XP Professional x64 Edition, Windows Server 2003: Se requiere Service Pack 2 o posterior para utilizar esta clase

En el ejemplo de código siguiente se muestra la forma de utilizar un objeto HttpListener.

// 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();
}

.NET Framework

.NET Framework Client Profile

Windows 7, Windows Vista SP1 o posterior, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (no se admite Server Core), Windows Server 2008 R2 (se admite Server Core con SP1 o posterior), Windows Server 2003 SP2

Referencia

Otros recursos