Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

HttpListener.EndGetContext Method

Completes an asynchronous operation to retrieve an incoming client request.

Namespace:  System.Net
Assembly:  System (in System.dll)
public function EndGetContext(
	asyncResult : IAsyncResult
) : HttpListenerContext

Parameters

asyncResult
Type: System.IAsyncResult

An IAsyncResult object that was obtained when the asynchronous operation was started.

Return Value

Type: System.Net.HttpListenerContext
An HttpListenerContext object that represents the client request.
ExceptionCondition
ArgumentException

asyncResult was not obtained by calling the BeginGetContext method.

ArgumentNullException

asyncResult is a null reference (Nothing in Visual Basic).

InvalidOperationException

The EndGetContext method was already called for the specified asyncResult object.

ObjectDisposedException

This object is closed.

The EndGetContext method is called, usually within an application-defined callback method invoked by a delegate, to obtain the HttpListenerContext object that contains an incoming client request and its associated response. This method completes an operation previously started by calling the BeginGetContext method. If the operation has not completed, this method blocks until it does.

Because calling the EndGetContext method requires the HttpListener object, this object is typically passed into a callback method by using the state object passed into the BeginGetContext method. You can obtain this state object by using the AsyncState property of the asyncResult object.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

Notes to Callers:

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

The following code example shows the implementation of a callback method that calls the EndGetContext method.

public static void ListenerCallback(IAsyncResult result)
{
    HttpListener listener = (HttpListener) result.AsyncState;
    // Call EndGetContext to complete the asynchronous operation.
    HttpListenerContext context = listener.EndGetContext(result);
    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();
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.