Class CorsMessageHandler

Namespace

System.Web.Http.Cors

Assembly

System.Web.Http.Cors.dll

Custom DelegatingHandler for handling CORS requests.

public class CorsMessageHandler : DelegatingHandler, IDisposable

Inheritance

object

HttpMessageHandler

DelegatingHandler

CorsMessageHandler

Implements

IDisposable

Inherited Members

DelegatingHandler.Send(HttpRequestMessage, CancellationToken)

DelegatingHandler.Dispose(bool)

DelegatingHandler.InnerHandler

HttpMessageHandler.Dispose()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CorsMessageHandler(HttpConfiguration)

Initializes a new instance of the CorsMessageHandler class.

public CorsMessageHandler(HttpConfiguration httpConfiguration)

Parameters

httpConfiguration HttpConfiguration

The System.Web.Http.HttpConfiguration.

Exceptions

ArgumentNullException

httpConfiguration

Methods

HandleCorsPreflightRequestAsync(HttpRequestMessage, CorsRequestContext, CancellationToken)

Handles the preflight request specified by CORS.

public virtual Task<HttpResponseMessage> HandleCorsPreflightRequestAsync(HttpRequestMessage request, CorsRequestContext corsRequestContext, CancellationToken cancellationToken)

Parameters

request HttpRequestMessage

The request.

corsRequestContext CorsRequestContext

The cors request context.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<HttpResponseMessage>

The Task<TResult>

Exceptions

ArgumentNullException

request or corsRequestContext

HandleCorsRequestAsync(HttpRequestMessage, CorsRequestContext, CancellationToken)

Handles the actual CORS request.

public virtual Task<HttpResponseMessage> HandleCorsRequestAsync(HttpRequestMessage request, CorsRequestContext corsRequestContext, CancellationToken cancellationToken)

Parameters

request HttpRequestMessage

The HttpRequestMessage.

corsRequestContext CorsRequestContext

The System.Web.Cors.CorsRequestContext.

cancellationToken CancellationToken

The CancellationToken.

Returns

Task<HttpResponseMessage>

The Task<TResult>.

Exceptions

ArgumentNullException

request or corsRequestContext

SendAsync(HttpRequestMessage, CancellationToken)

Sends an HTTP request to the inner handler to send to the server as an asynchronous operation.

protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)

Parameters

request HttpRequestMessage

The HTTP request message to send to the server.

cancellationToken CancellationToken

A cancellation token to cancel operation.

Returns

Task<HttpResponseMessage>

Returns Task<TResult>. The task object representing the asynchronous operation.