WebRequestExtensionsGetResponseAsync Method (WebRequest, Boolean, CancellationToken) |
Returns a response to an Internet request as an asynchronous operation.
Namespace: Rackspace.ThreadingAssembly: Rackspace.Threading (in Rackspace.Threading.dll) Version: 1.1.0.0
Syntax
public static Task<WebResponse> GetResponseAsync(
this WebRequest request,
bool throwOnError,
CancellationToken cancellationToken
)
<ExtensionAttribute>
Public Shared Function GetResponseAsync (
request As WebRequest,
throwOnError As Boolean,
cancellationToken As CancellationToken
) As Task(Of WebResponse)
public:
[ExtensionAttribute]
static Task<WebResponse^>^ GetResponseAsync(
WebRequest^ request,
bool throwOnError,
CancellationToken cancellationToken
)
[<ExtensionAttribute>]
static member GetResponseAsync :
request : WebRequest *
throwOnError : bool *
cancellationToken : CancellationToken -> Task<WebResponse>
Parameters
- request
- Type: System.NetWebRequest
The request. - throwOnError
- Type: SystemBoolean
to throw a WebException if the StatusCode of the response is greater than 400; otherwise, to return the WebResponse in the result for these cases. - cancellationToken
- Type: System.ThreadingCancellationToken
The CancellationToken that will be assigned to the new Task.
Return Value
Type:
TaskWebResponseA
Task object which represents the asynchronous operation.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
WebRequest. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
Exceptions
Exception | Condition |
ArgumentNullException | If request is . |
WebException |
If Abort was previously called.
-or- If the timeout period for the request expired. -or- If an error occurred while processing the request. |
Remarks
This operation will not block. The returned
TaskTResult object will
complete after a response to an Internet request is available.
Version Information
.NET Framework
Supported in: 4.5, 4.0, 3.5
Rackspace Threading Library
Supported in: 1.1, 1.0
See Also