Class HttpServer

Namespace

System.Web.Http

Assembly

System.Web.Http.dll

Defines an implementation of an HttpMessageHandler which dispatches an incoming HttpRequestMessage and creates an HttpResponseMessage as a result.

public class HttpServer : DelegatingHandler, IDisposable

Inheritance

object

HttpMessageHandler

DelegatingHandler

HttpServer

Implements

IDisposable

Inherited Members

DelegatingHandler.Send(HttpRequestMessage, CancellationToken)

DelegatingHandler.InnerHandler

HttpMessageHandler.Dispose()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

HttpServer()

Initializes a new instance of the HttpServer class, using the default configuration and dispatcher.

public HttpServer()

HttpServer(HttpMessageHandler)

Initializes a new instance of the HttpServer class with a specified dispatcher.

public HttpServer(HttpMessageHandler dispatcher)

Parameters

dispatcher HttpMessageHandler

The HTTP dispatcher that will handle incoming requests.

HttpServer(HttpConfiguration)

Initializes a new instance of the HttpServer class with a specified configuration.

public HttpServer(HttpConfiguration configuration)

Parameters

configuration HttpConfiguration

The HttpConfiguration used to configure this instance.

HttpServer(HttpConfiguration, HttpMessageHandler)

Initializes a new instance of the HttpServer class with a specified configuration and dispatcher.

public HttpServer(HttpConfiguration configuration, HttpMessageHandler dispatcher)

Parameters

configuration HttpConfiguration

The HttpConfiguration used to configure this instance.

dispatcher HttpMessageHandler

The HTTP dispatcher that will handle incoming requests.

Properties

Configuration

Gets the HttpConfiguration used to configure this instance.

public HttpConfiguration Configuration { get; }

Property Value

HttpConfiguration

The HttpConfiguration used to configure this instance.

Dispatcher

Gets the HTTP dispatcher that handles incoming requests.

public HttpMessageHandler Dispatcher { get; }

Property Value

HttpMessageHandler

The HTTP dispatcher that handles incoming requests.

Methods

Dispose(bool)

Releases the unmanaged resources that are used by the object and, optionally, releases the managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Initialize()

Prepares the server for operation.

protected virtual void Initialize()

SendAsync(HttpRequestMessage, CancellationToken)

Dispatches an incoming HttpRequestMessage.

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

Parameters

request HttpRequestMessage

The request to dispatch.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task<HttpResponseMessage>

A task representing the asynchronous operation.