HttpListenerResponse.Close Method (Byte[], Boolean)

 

Returns the specified byte array to the client and releases the resources held by this HttpListenerResponse instance.

Namespace:   System.Net
Assembly:  System (in System.dll)

member Close : 
        responseEntity:byte[] *
        willBlock:bool -> unit

Parameters

responseEntity
Type: System.Byte[]

A Byte array that contains the response to send to the client.

willBlock
Type: System.Boolean

true to block execution while flushing the stream to the client; otherwise, false.

Exception Condition
ArgumentNullException

responseEntity is null.

ObjectDisposedException

This object is closed.

If you are sending body data with the response, you can use this method to send it as a Byte array instead of writing the body data to the OutputStream property and calling the Close method.

This method closes the response stream and the HttpListenerRequest associated with the response.

The following code example demonstrates calling this method.

// 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();
}

.NET Framework
Available since 2.0
Return to top
Show: