HttpListenerPrefixCollection.Add(String) 方法

定義

將統一資源識別元 (URI) 前置詞加入至集合。Adds a Uniform Resource Identifier (URI) prefix to the collection.

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 資訊。A String that identifies the URI information that is compared in incoming requests. 前置詞必須以斜線 ("/") 結束。The prefix must be terminated with a forward slash ("/").

實作

例外狀況

uriPrefixnulluriPrefix is null.

uriPrefix 不會使用 http:// 或 https:// 配置。uriPrefix does not use the http:// or https:// scheme. 這些是唯一支援 HttpListener 物件的配置。These are the only schemes supported for HttpListener objects.

-或--or- uriPrefix 不是格式正確的 URI 前置詞。uriPrefix is not a correctly formatted URI prefix. 請確定字串結尾為 "/"。Make sure the string is terminated with a "/".

與此集合相關聯的 HttpListener 已關閉。The HttpListener associated with this collection is closed.

Windows 函式呼叫失敗。A Windows function call failed. 請檢查例外狀況的 ErrorCode 屬性,以判斷造成例外狀況的原因。Check the exception's ErrorCode property to determine the cause of the exception. 如果另一個 HttpListener 已經加入前置詞 uriPrefix,就會擲回這個例外狀況。This exception is thrown if another HttpListener has already added the prefix uriPrefix.

範例

下列程式碼範例會建立HttpListener , 並在其HttpListenerPrefixCollection中新增使用者指定的前置詞。The following code example creates an HttpListener and adds user-specified prefixes to its 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物件所管理的前置詞集合。This method adds a URI prefix to the set of prefixes managed by the associated HttpListener object. 檢查uriPrefix以確定它是有效的時, 會忽略大小寫。When checking uriPrefix to ensure it is valid, case is ignored.

URI 前置字串是由配置 (HTTP 或 HTTPs)、主機、選擇性埠和選擇性路徑所組成, 例如 "http://www.contoso.com:8080/customerData/"。A URI prefix string is composed of a scheme (http or https), a host, an optional port, and an optional path, for example, "http://www.contoso.com:8080/customerData/". 前置詞必須以斜線 ("/") 結束。The prefix must be terminated with a forward slash ("/"). HttpListener , 其前置詞最符合要求的 URI 會回應要求。The HttpListener with the prefix that most closely matches a requested URI responds to the request. HttpListener個物件無法加入相同的前置詞。Multiple HttpListener objects cannot add the same prefix. 如果加入的前置詞已在使用中, 則會擲回例外狀況。HttpListenerException HttpListenerAn HttpListenerException exception is thrown if an HttpListener adds a prefix that is already in use.

指定埠時, 可以使用 "*" 取代主機元素, 以指出如果要求的 URI 不符合任何其他前置詞, 則會接受傳送至埠的HttpListener要求。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. 例如, 當要求的 URI 不是由任何其他HttpListener的處理時, 若要接收傳送至埠8080的所有要求, 則前置詞為 "http://*:8080/"。For example, to receive all requests sent to port 8080 when the requested URI is not handled by any other HttpListener, the prefix is "http://*:8080/". 同樣地, 若要指定HttpListener接受所有傳送至埠的要求, 請將主機元素取代為 "+" 字元, "https://+: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.

從 .net 4.5.3 和 Windows 10 開始, 由HttpListener物件管理的 URI 前置詞支援萬用字元子域。Starting with .NET 4.5.3 and Windows 10, wildcard subdomains are supported in URI prefixes that are managed by an HttpListener object. 若要指定萬用字元子域, 請在 URI*前置詞中使用 "" 字元做為主機名稱的一部分: http://*.foo.com/例如,, 並將其當做引數傳遞至 HttpListenerPrefixCollection. Add 方法。To specify a wildcard subdomain, use the "*" character as part of the hostname in a URI prefix: for example, http://*.foo.com/, and pass this as the argument to the HttpListenerPrefixCollection.Add method. 這可在 .NET 4.5.3 和 Windows 10 上使用;在較早的版本中, 這會產生HttpListenerExceptionThis will work on .NET 4.5.3 and Windows 10; in earlier versions, this would generate an HttpListenerException

安全性

WebPermission
接受網路連接。To accept network connections. 相關聯的列舉:AcceptAssociated enumeration: Accept

適用於

另請參閱