HttpListener Класс

Определение

Пространство имен:
System.Net
Сборки:
netstandard.dll, System.Net.HttpListener.dll
Сборка:
System.Net.HttpListener.dll
Сборка:
System.dll
Сборка:
netstandard.dll
Исходный код:
HttpListener.cs
Исходный код:
HttpListener.cs
Исходный код:
HttpListener.cs
Исходный код:
HttpListener.cs
Исходный код:
HttpListener.cs

Предоставляет простой, программно контролируемый прослушиватель протокола HTTP. Этот класс не наследуется.

public ref class HttpListener sealed : IDisposable
public sealed class HttpListener : IDisposable
type HttpListener = class
    interface IDisposable
Public NotInheritable Class HttpListener
Implements IDisposable
Наследование
Object
HttpListener
Реализации
IDisposable

Примеры

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

Комментарии

HttpListener С помощью класса можно создать простой прослушиватель протокола HTTP, который отвечает на HTTP-запросы. Прослушиватель активен в течение всего времени существования объекта HttpListener и работает внутри вашего приложения с его разрешениями.

Чтобы использовать HttpListener, создайте новый экземпляр класса с помощью HttpListener конструктора и используйте Prefixes свойство для получения доступа к коллекции, содержащей строки, указывающие, какие префиксы универсального идентификатора ресурса (URI) должны обрабатываться HttpListener .

Строка префикса URI состоит из схемы (http или https), узла, необязательного порта и дополнительного пути. Примером полной строки префикса является http://www.contoso.com:8080/customerData/. Префиксы должны заканчиваться косой чертой ("/"). Объект HttpListener с префиксом, который наиболее тесно соответствует запрошенным URI, отвечает на запрос. Несколько HttpListener объектов не могут добавить один и тот же префикс; выбрасывается Win32Exception исключение, когда HttpListener добавляет префикс, который уже используется.

При указании порта элемент узла можно заменить на "*", чтобы показать, что HttpListener принимает запросы, отправленные на порт, если запрошенный URI не совпадает ни с одним из других префиксов. Например, чтобы получать все запросы, отправляемые через порт 8080, если запрошенный URI не обрабатывается ни одним HttpListener, префикс — http://*:8080/. Аналогичным образом, чтобы указать, что HttpListener принимает все запросы, отправленные на порт, замените элемент узла символом "+". Например: https://+:8080. Символы "*" и "+" могут присутствовать в префиксах, которые включают пути.

Подстановочные поддомены поддерживаются в префиксах URI, управляемых HttpListener объектом. Чтобы указать поддомен подстановочного знака, используйте символ "*" в составе имени узла в префиксе URI. Например, http://*.foo.com/. Передайте этот аргумент в качестве аргумента методу Add .

Предупреждение

Подстановочные знаки верхнего уровня (http://*:8080/ и http://+:8080) не должны использоваться. Использование подстановочных символов верхнего уровня может привести к уязвимостям безопасности и поставить ваше приложение под угрозу. Это относится как к строгим, так и к нестрогим подстановочным знакам. Используйте явные имена хостов вместо подстановочных знаков. Привязки с подстановочными знаками на уровне дочерних доменов (например *.mysub.com) не создают таких угроз безопасности, если вы полностью контролируете родительский домен (в отличие от варианта *.com, создающего уязвимость). Дополнительные сведения см. в разделе rfc7230-5.4 .

Чтобы начать прослушивание запросов от клиентов, добавьте префиксы URI в коллекцию и вызовите Start метод. HttpListener предлагает синхронные и асинхронные модели для обработки клиентских запросов. Обращение к запросам и их связанным ответам производится с помощью объекта HttpListenerContext, возвращаемого методом GetContext или его асинхронными эквивалентами — методами BeginGetContext и EndGetContext.

Синхронная модель подходит, если приложение должно блокироваться во время ожидания клиентского запроса и если вы хотите обработать только один запрос за раз. С помощью синхронной модели вызовите GetContext метод, который ожидает отправки запроса клиенту. Метод возвращает объект HttpListenerContext для обработки, когда это происходит.

В более сложной асинхронной модели приложение не блокируется во время ожидания запросов, и каждый запрос обрабатывается в собственном потоке выполнения. BeginGetContext Используйте метод, чтобы указать определяемый приложением метод для каждого входящего запроса. В рамках этого метода вызовите метод EndGetContext, чтобы получить, обработать и ответить на запрос.

В любой модели входящие запросы получают доступ к свойству HttpListenerContext.Request и представлены объектами HttpListenerRequest . Аналогичным образом ответы получают с использованием свойства HttpListenerContext.Response и представлены объектами HttpListenerResponse. Эти объекты имеют некоторые функциональные возможности, сходные с объектами HttpWebRequest и HttpWebResponse, но последние объекты нельзя использовать в сочетании с HttpListener, потому что они реализуют клиентское, а не серверное поведение.

Для HttpListener может потребоваться проверка подлинности клиента. Можно указать определенную схему, используемую для проверки подлинности, или указать делегат, определяющий используемую схему. Чтобы получить информацию о личности клиента, необходимо требовать какую-либо форму аутентификации. Дополнительные сведения см. в свойствах User, AuthenticationSchemes и AuthenticationSchemeSelectorDelegate.

Note

Если вы создаёте HttpListener с использованием https, вы должны выбрать сертификат сервера для данного прослушивателя. В противном случае запросы к этому HttpListener завершатся неожиданным закрытием соединения.

Note

Сертификаты сервера и другие параметры прослушивателя можно настроить с помощью сетевой оболочки (netsh.exe). Дополнительные сведения см. в статье Network Shell (Netsh ). Исполняемый файл стал поставляться с Windows Server 2008 и Windows Vista.

Note

Если для HttpListener задано несколько схем проверки подлинности, прослушиватель вызовет клиентов в следующем порядке: Negotiate, NTLM, Digest, а затем Basic.

HTTP.sys

Класс HttpListener построен на основе HTTP.sysпрослушивателя режима ядра, который обрабатывает весь HTTP-трафик для Windows. HTTP.sys обеспечивает управление подключениями, регулирование пропускной способности и ведение журнала веб-сервера. Используйте средство HttpCfg.exe для добавления SSL-сертификатов.

Начиная с .NET 11, реализация Windows HTTP.sys в HttpListener поддерживает буферизацию ответов на уровне ядра. При включении данные ответа буферизуются HTTP.sys перед отправкой клиенту, что может повысить пропускную способность для соединений с высокой задержкой. Это можно включить, вызвав AppContext.SetSwitch метод следующим образом:

AppContext.SetSwitch("System.Net.HttpListener.EnableKernelResponseBuffering", true);

Конструкторы

Имя Описание
HttpListener()

Инициализирует новый экземпляр класса HttpListener.

Свойства

Имя Описание
AuthenticationSchemes

Возвращает или задает схему, используемую для проверки подлинности клиентов.
AuthenticationSchemeSelectorDelegate

Возвращает или задает делегат, вызываемого для определения протокола, используемого для проверки подлинности клиентов.
DefaultServiceNames

Возвращает список имен поставщиков услуг (SPN) по умолчанию, определенный зарегистрированными префиксами.
ExtendedProtectionPolicy

Возвращает или задает значение, используемое ExtendedProtectionPolicy для расширенной защиты сеанса.
ExtendedProtectionSelectorDelegate

Возвращает или задает делегат, вызываемого для определения используемого ExtendedProtectionPolicy для каждого запроса.
IgnoreWriteExceptions

Возвращает или задает Boolean значение, указывающее, получает ли приложение исключения, возникающие при HttpListener отправке ответа клиенту.
IsListening

Возвращает значение, указывающее, был ли HttpListener запущен.
IsSupported

Возвращает значение, указывающее, можно ли HttpListener использовать с текущей операционной системой.
Prefixes

Возвращает префиксы универсального идентификатора ресурса (URI), обрабатываемые этим HttpListener объектом.
Realm

Возвращает или задает область или секцию ресурсов, связанную с этим HttpListener объектом.
TimeoutManager

Диспетчер времени ожидания для этого HttpListener экземпляра.
UnsafeConnectionNtlmAuthentication

Возвращает или задает Boolean значение, которое определяет, требуется ли при использовании NTLM дополнительные запросы с использованием того же соединения TCP.

Методы

Имя Описание
Abort()

HttpListener Немедленно завершает работу объекта, отменяя все запросы в очереди.
BeginGetContext(AsyncCallback, Object)

Начинает асинхронно извлечение входящего запроса.
Close()

Завершает работу HttpListener.
EndGetContext(IAsyncResult)

Завершает асинхронную операцию для получения входящего запроса клиента.
Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetContext()

Ожидает входящего запроса и возвращается при получении.
GetContextAsync()

Ожидает входящего запроса в качестве асинхронной операции.
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает Type текущего экземпляра.

(Унаследовано от Object)
MemberwiseClone()

Создает неглубокую копию текущей Object.

(Унаследовано от Object)
Start()

Позволяет этому экземпляру получать входящие запросы.
Stop()

Заставляет этот экземпляр перестать получать новые входящие запросы и завершает обработку всех текущих запросов.
ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)

Явные реализации интерфейса

Имя Описание
IDisposable.Dispose()

Освобождает ресурсы, удерживаемые этим HttpListener объектом.

Применяется к

См. также раздел