HttpListenerResponse.Close メソッド

  • リファレンス

定義

名前空間:
System.Net
アセンブリ:
System.Net.HttpListener.dll
アセンブリ:
System.dll
アセンブリ:
netstandard.dll

クライアントに応答を送信し、この HttpListenerResponse インスタンスに保持されているリソースを解放します。

オーバーロード

Close()

クライアントに応答を送信し、この HttpListenerResponse インスタンスに保持されているリソースを解放します。
Close(Byte[], Boolean)

指定されたバイト配列をクライアントに返し、この HttpListenerResponse インスタンスに保持されているリソースを解放します。

Close()

ソース:
HttpListenerResponse.Managed.cs
ソース:
HttpListenerResponse.Managed.cs
ソース:
HttpListenerResponse.Managed.cs

クライアントに応答を送信し、この HttpListenerResponse インスタンスに保持されているリソースを解放します。

public:
 void Close();
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public void Close ();
public void Close ();
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Close : unit -> unit
member this.Close : unit -> unit
Public Sub Close ()
属性
UnsupportedOSPlatformAttribute

例

次のコード例では、このメソッドを呼び出して (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.Managed.cs
ソース:
HttpListenerResponse.Managed.cs
ソース:
HttpListenerResponse.Managed.cs

指定されたバイト配列をクライアントに返し、この HttpListenerResponse インスタンスに保持されているリソースを解放します。

public:
 void Close(cli::array <System::Byte> ^ responseEntity, bool willBlock);
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public void Close (byte[] responseEntity, bool willBlock);
public void Close (byte[] responseEntity, bool willBlock);
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.Close : byte[] * bool -> unit
member this.Close : byte[] * bool -> unit
Public Sub Close (responseEntity As Byte(), willBlock As Boolean)

パラメーター

responseEntity
Byte[]

クライアントに送信する応答を格納している Byte 配列。

willBlock
Boolean

クライアントへのストリームのフラッシュ中は実行をブロックする場合は true、それ以外の場合は false。

属性
UnsupportedOSPlatformAttribute

例外

ArgumentNullException

responseEntity が nullです。

ObjectDisposedException

オブジェクトが閉じています。

例

次のコード例では、このメソッドの呼び出しを示します。

// 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呼び出Closeす代わりに、このメソッドを使用してOutputStream配列として送信できます。

このメソッドは、応答ストリームと、応答に関連付けられている を HttpListenerRequest 閉じます。

が としてwillBlock指定されている場合false、メソッドは直ちにを返し、データが送信されると接続は非同期的に閉じられます。

Note

非同期的に閉じると、呼び出し元はデータがいつ送信されたかを判断できません。 それに加えて、 を破棄するかHttpListenerResponseHttpListenerContextHttpListener、すべてのデータが送信される前に接続を閉じることがあります。

こちらもご覧ください

適用対象