HttpListenerPrefixCollection.Add(String) Метод

  • Ссылка

Определение

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

Добавляет префикс универсального кода ресурса (URI) в коллекцию.

public:
 virtual void Add(System::String ^ uriPrefix);
public void Add (string uriPrefix);
abstract member Add : string -> unit
override this.Add : string -> unit
Public Sub Add (uriPrefix As String)

Параметры

uriPrefix
String

Строка String, указывающая сведения об URI, которые сравниваются во входящих запросах. Префикс должен завершаться косой чертой ("/").

Реализации

Add(T)

Исключения

ArgumentNullException

uriPrefix имеет значение null.

ArgumentException

Параметр uriPrefix не использует схему http:// или https://. Это единственные схемы, поддерживаемые объектами HttpListener.

-или-

Параметр uriPrefix задан неправильно. Строка должна завершаться косой чертой ("/").

ObjectDisposedException

Объект HttpListener, связанный с этой коллекцией, закрыт.

HttpListenerException

Вызов функции Windows завершился сбоем. Проверьте свойство исключения ErrorCode, чтобы определить причину исключения. Это исключение будет вызвано, если другой объект HttpListener уже добавил этот префикс uriPrefix.

Примеры

В следующем примере кода создается HttpListener и добавляется заданный пользователем префикс в его HttpListenerPrefixCollection.

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

Комментарии

Этот метод добавляет префикс URI к набору префиксов, управляемых связанным HttpListener объектом. При проверке uriPrefix допустимости регистр игнорируется.

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

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

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

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

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