HttpListenerResponse.Close 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
将响应发送到客户端，并释放此 HttpListenerResponse 实例占用的资源。
重载
| Close() |
将响应发送到客户端，并释放此 HttpListenerResponse 实例占用的资源。 |
| Close(Byte[], Boolean) |
将指定的字节数组发送到客户端，并释放此 HttpListenerResponse 实例占用的资源。 |
Close()
将响应发送到客户端，并释放此 HttpListenerResponse 实例占用的资源。
public:
void Close();public void Close();[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public void Close();member this.Close : unit -> unit[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Close : unit -> unitPublic Sub Close ()- 属性
示例
下面的代码示例演示如何调用此方法以将 (403) 响应发送到 Forbidden 客户端。
static string message403;
static HttpListenerResponse preMade403Response;
static void SendBadCertificateResponse(HttpListenerResponse response)
{
if (preMade403Response == null)
{
// Set up an authentication error response template.
response.StatusCode = (int)HttpStatusCode.Forbidden;
response.StatusDescription = "403 Forbidden";
response.ProtocolVersion = new Version("1.1");
response.SendChunked = false;
preMade403Response = response;
}
else
{
response.CopyFrom(preMade403Response);
}
// The response body cannot be saved in the template.
StringBuilder message = new StringBuilder();
message.Append("<HTML><BODY>");
message.Append("<p> Error message 403: Access is denied due to a missing or invalid client certificate.</p>");
message.Append("</BODY></HTML>");
message403 = message.ToString();
// Turn the error message into a byte array using the
// encoding from the response when present.
System.Text.Encoding encoding = response.ContentEncoding;
if (encoding == null)
{
encoding = System.Text.Encoding.UTF8;
response.ContentEncoding = encoding;
}
byte[] buffer = encoding.GetBytes(message403);
response.ContentLength64 = buffer.Length;
// Write the error message.
System.IO.Stream stream = response.OutputStream;
stream.Write(buffer, 0, buffer.Length);
// Send the response.
response.Close();
}
Private Shared message403 As String
Private Shared preMade403Response As HttpListenerResponse
Private Shared Sub SendBadCertificateResponse(ByVal response As HttpListenerResponse)
If preMade403Response Is Nothing Then
' Set up an authentication error response template.
response.StatusCode = Cint(HttpStatusCode.Forbidden)
response.StatusDescription = "403 Forbidden"
response.ProtocolVersion = New Version("1.1")
response.SendChunked = False
Else
response.CopyFrom(preMade403Response)
End If
' The response body cannot be saved in the template.
Dim message As New StringBuilder()
message.Append("<HTML><BODY>")
message.Append("<p> Error message 403: Access is denied due to a missing or invalid client certificate.</p>")
message.Append("</BODY></HTML>")
message403 = message.ToString()
' Turn the error message into a byte array using the
' encoding from the response when present.
Dim encoding As System.Text.Encoding = response.ContentEncoding
If encoding Is Nothing Then
encoding = System.Text.Encoding.UTF8
response.ContentEncoding = encoding
End If
Dim buffer() As Byte = encoding.GetBytes(message403)
response.ContentLength64 = buffer.Length
' Write the error message.
Dim stream As System.IO.Stream = response.OutputStream
stream.Write(buffer, 0, buffer.Length)
' Send the response.
response.Close()
End Sub
注解
此方法关闭响应流以及与 HttpListenerRequest 响应关联的 。
另请参阅
适用于
Close(Byte[], Boolean)
将指定的字节数组发送到客户端，并释放此 HttpListenerResponse 实例占用的资源。
public:
void Close(cli::array <System::Byte> ^ responseEntity, bool willBlock);public void Close(byte[] responseEntity, bool willBlock);[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public void Close(byte[] responseEntity, bool willBlock);member this.Close : byte[] * bool -> unit[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Close : byte[] * bool -> unitPublic Sub Close (responseEntity As Byte(), willBlock As Boolean)参数
- willBlock
- Boolean
如果要在刷新到客户端的流时阻止执行，则为 true；否则为 false。
- 属性
例外
responseEntity 为 null。
此对象已关闭。
示例
下面的代码示例演示如何调用此方法。
// This example requires the System and System.Net namespaces.
public static void SimpleListenerExample2(string[] prefixes)
{
// 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;
// Demonstrate using the close overload that takes an
// entity body.
// Specify true to block while data is transmitted.
response.Close(buffer, true);
listener.Stop();
}
Public Shared Sub SimpleListenerExample2(ByVal prefixes As String())
' 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 As HttpListener = New HttpListener()
' Add the prefixes
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()
Dim request As HttpListenerRequest = context.Request
' Obtain a response object.
Dim response As HttpListenerResponse = context.Response
' Construct a 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
' Demonstrate using the close overload that takes an
' entity body.
' Specify true to block while data Is transmitted.
response.Close(buffer, True)
listener.Stop()
End Sub
注解
如果要随响应一起发送正文数据，则可以使用此方法将其作为 Byte 数组发送，而不是将正文数据写入 OutputStream 属性并调用 Close 方法。
此方法关闭响应流以及与 HttpListenerRequest 响应关联的 。
如果将 false 指定为 willBlock，则方法将立即返回 ，并在发送数据后以异步方式关闭连接。
注意
如果以异步方式关闭，则调用方无法确定何时发送了数据。 除此之外，释放 HttpListenerResponseHttpListenerContext 或 HttpListener 可能会在发送所有数据之前关闭连接。
