HttpListener.EndGetContext Method (System.Net)

EndGetContext Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

HttpListener.EndGetContext Method

Note: This method is new in the .NET Framework version 2.0.

Completes an asynchronous operation to retrieve an incoming client request.

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

Syntax

Visual Basic (Declaration)

Public Function EndGetContext ( _
    asyncResult As IAsyncResult _
) As HttpListenerContext

Visual Basic (Usage)

Dim instance As HttpListener
Dim asyncResult As IAsyncResult
Dim returnValue As HttpListenerContext

returnValue = instance.EndGetContext(asyncResult)

public HttpListenerContext EndGetContext (
    IAsyncResult asyncResult
)

C++

public:
HttpListenerContext^ EndGetContext (
    IAsyncResult^ asyncResult
)

public HttpListenerContext EndGetContext (
    IAsyncResult asyncResult
)

JScript

public function EndGetContext (
    asyncResult : IAsyncResult
) : HttpListenerContext

Parameters

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

Return Value

An HttpListenerContext object that represents the client request.

Exceptions

Exception type	Condition
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.

Remarks

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.

Example

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

Platforms

Windows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0

Reference

HttpListener Class
HttpListener Members
System.Net Namespace