Export (0) Print
Expand All

HttpListener::BeginGetContext Method

Begins asynchronously retrieving an incoming request.

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

[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
IAsyncResult^ BeginGetContext(
	AsyncCallback^ callback, 
	Object^ state
)

Parameters

callback
Type: System::AsyncCallback
An AsyncCallback delegate that references the method to invoke when a client request is available.
state
Type: System::Object
A user-defined object that contains information about the operation. This object is passed to the callback delegate when the operation completes.

Return Value

Type: System::IAsyncResult
An IAsyncResult object that indicates the status of the asynchronous operation.

ExceptionCondition
HttpListenerException

A Win32 function call failed. Check the exception's ErrorCode property to determine the cause of the exception.

InvalidOperationException

This object has not been started or is currently stopped.

ObjectDisposedException

This object is closed.

The BeginGetContext method begins an asynchronous (non-blocking) call to receive incoming client requests. Before calling this method, you must call the Start method and add at least one Uniform Resource Identifier (URI) prefix to listen for by adding the URI strings to the HttpListenerPrefixCollection returned by the Prefixes property.

The asynchronous operation must be completed by calling the EndGetContext method. Typically, the method is invoked by the callback delegate.

This method does not block while the operation completes. To get an incoming request and block until the operation completes, call the GetContext method.

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

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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 demonstrates using the BeginGetContext method to specify a callback method that will handle incoming client requests.

No code example is currently available or this language may not be supported.

The following code example implements a callback method.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft