HttpListener Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет простой, программно контролируемый прослушиватель протокола HTTP. Этот класс не наследуется.
public ref class HttpListener sealed : IDisposable
public sealed class HttpListener : IDisposable
type HttpListener = class
interface IDisposable
Public NotInheritable Class HttpListener
Implements IDisposable
- Наследование
-
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();
}
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
Комментарии
Дополнительные сведения об этом API см. в дополнительных примечаниях API для HttpListener.
Конструкторы
| Имя | Описание |
|---|---|
| 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 объектом. |