HttpListener.GetContextAsync Method

Definition

Namespace:

System.Net

Assembly:

System.Net.HttpListener.dll

Source:

HttpListener.cs

Waits for an incoming request as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::Net::HttpListenerContext ^> ^ GetContextAsync();

public System.Threading.Tasks.Task<System.Net.HttpListenerContext> GetContextAsync ();

member this.GetContextAsync : unit -> System.Threading.Tasks.Task<System.Net.HttpListenerContext>

Public Function GetContextAsync () As Task(Of HttpListenerContext)

Returns

Task<HttpListenerContext>

The task object representing the asynchronous operation. The Result property on the task object returns an HttpListenerContext object that represents a client request.

Remarks

This operation will not block. The returned Task<TResult> object will complete when the incoming request has been received.

Before calling this method, you must call the Start method and add at least one URI prefix to listen for by adding the URI strings to the HttpListenerPrefixCollection returned by the Prefixes property. For a detailed description of prefixes, see the HttpListener class overview.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by GetContext().

See also

• HttpListenerContext