Click here to Skip to main content
15,895,799 members
Articles / General Programming

Self Hosted Web API Wrapper Class

Rate me:
Please Sign up or sign in to vote.
0.00/5 (No votes)
5 Sep 2013CPOL2 min read 11.5K   153   5  
A wrapper class to simplify the implementation of a Self Hosted Web API Service
<?xml version="1.0" encoding="utf-8"?>
<doc>
  <assembly>
    <name>System.Web.Http.SelfHost</name>
  </assembly>
  <members>
    <member name="T:System.Net.Http.HttpRequestMessageExtensions">
      <summary>Provides extension methods for <see cref="T:System.Net.Http.HttpRequestMessage" />.</summary>
    </member>
    <member name="M:System.Net.Http.HttpRequestMessageExtensions.GetSecurityMessageProperty(System.Net.Http.HttpRequestMessage)">
      <summary>Gets the current <see cref="T:System.ServiceModel.Security.SecurityMessageProperty" /> stored in the request message properties for the given request.</summary>
      <returns>The current <see cref="T:System.ServiceModel.Security.SecurityMessageProperty" />.</returns>
      <param name="request">The request.</param>
    </member>
    <member name="T:System.Web.Http.SelfHost.HttpSelfHostConfiguration">
      <summary>Contains the configuration class for HTTP Services.</summary>
    </member>
    <member name="M:System.Web.Http.SelfHost.HttpSelfHostConfiguration.#ctor(System.String)">
      <summary>Initializes a new instance of the <see cref="T:System.Web.Http.SelfHost.HttpSelfHostConfiguration" /> class.</summary>
      <param name="baseAddress">The base address in a form of string.</param>
    </member>
    <member name="M:System.Web.Http.SelfHost.HttpSelfHostConfiguration.#ctor(System.Uri)">
      <summary>Initializes a new instance of the <see cref="T:System.Web.Http.SelfHost.HttpSelfHostConfiguration" /> class.</summary>
      <param name="baseAddress">The base address in a URI form.</param>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.BaseAddress">
      <summary>Gets the base HTTP address.</summary>
      <returns>The <see cref="T:System.Uri" /> object that represents the base HTTP address.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.ClientCredentialType">
      <summary>Gets or sets the client credential type that the server expects.</summary>
      <returns>A <see cref="T:System.ServiceModel.HttpClientCredentialType" /> value that specifies the credential type.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.HostNameComparisonMode">
      <summary>Gets a value that specifies how the host name should be used in URI comparisons when dispatching an incoming message. </summary>
      <returns>One of the values of the <see cref="T:System.ServiceModel.HostNameComparisonMode" /> enumeration.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.MaxBufferSize">
      <summary>Gets or sets the maximum size of the buffer.</summary>
      <returns>The maximum size of the buffer.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.MaxConcurrentRequests">
      <summary>Gets or sets the upper limit of concurrent <see cref="T:System.Net.Http.HttpRequestMessage" /> instances  that can be processed at any given time. The default is 100 times the number of CPU cores.</summary>
      <returns>The upper limit of concurrent <see cref="T:System.Net.Http.HttpRequestMessage" /> instances  that can be processed at any given time.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.MaxReceivedMessageSize">
      <summary>Gets or sets the maximum size of the received message.</summary>
      <returns>The maximum size of the received message.</returns>
    </member>
    <member name="M:System.Web.Http.SelfHost.HttpSelfHostConfiguration.OnConfigureBinding(System.Web.Http.SelfHost.Channels.HttpBinding)">
      <summary>Called to apply the configuration on the endpoint level.</summary>
      <returns>The <see cref="T:System.ServiceModel.Channels.BindingParameterCollection" /> to use when building the <see cref="T:System.ServiceModel.Channels.IChannelListener" /> or null if no binding parameters are present.</returns>
      <param name="httpBinding">The HTTP endpoint.</param>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.ReceiveTimeout">
      <summary>Gets or sets the receive timeout.</summary>
      <returns>The receive timeout.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.SendTimeout">
      <summary>Gets or sets the send timeout.</summary>
      <returns>The send timeout.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.TransferMode">
      <summary>Gets or sets the transfer mode.</summary>
      <returns>One of the enumeration values of the <see cref="T:System.ServiceModel.TransferMode" /> enumeration .</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.UserNamePasswordValidator">
      <summary>Gets or sets the <see cref="T:System.IdentityModel.Selectors.UserNamePasswordValidator" /> that is used to validate the username and password sent over HTTP or HTTPS.</summary>
      <returns>The <see cref="T:System.IdentityModel.Selectors.UserNamePasswordValidator" /> that is used to validate the username and password sent over HTTP or HTTPS.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.HttpSelfHostConfiguration.X509CertificateValidator">
      <summary>Gets or sets the <see cref="T:System.IdentityModel.Selectors.X509CertificateValidator" />instance that will be used to validate the client certificate sent over HTTPS.</summary>
      <returns>The <see cref="T:System.IdentityModel.Selectors.X509CertificateValidator" />instance that will be used to validate the client certificate.</returns>
    </member>
    <member name="T:System.Web.Http.SelfHost.HttpSelfHostServer">
      <summary> Implementation of an <see cref="T:System.Web.Http.HttpServer" /> which listens directly to HTTP. </summary>
    </member>
    <member name="M:System.Web.Http.SelfHost.HttpSelfHostServer.#ctor(System.Web.Http.SelfHost.HttpSelfHostConfiguration)">
      <summary> Initializes a new instance of the <see cref="T:System.Web.Http.SelfHost.HttpSelfHostServer" /> class. </summary>
      <param name="configuration">The configuration.</param>
    </member>
    <member name="M:System.Web.Http.SelfHost.HttpSelfHostServer.#ctor(System.Web.Http.SelfHost.HttpSelfHostConfiguration,System.Net.Http.HttpMessageHandler)">
      <summary> Initializes a new instance of the <see cref="T:System.Web.Http.SelfHost.HttpSelfHostServer" /> class. </summary>
      <param name="configuration">The configuration.</param>
      <param name="dispatcher">The dispatcher.</param>
    </member>
    <member name="M:System.Web.Http.SelfHost.HttpSelfHostServer.CloseAsync">
      <summary> Closes the current <see cref="T:System.Web.Http.HttpServer" /> instance. </summary>
      <returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous <see cref="T:System.Web.Http.HttpServer" /> close operation.</returns>
    </member>
    <member name="M:System.Web.Http.SelfHost.HttpSelfHostServer.OpenAsync">
      <summary> Opens the current <see cref="T:System.Web.Http.HttpServer" /> instance. </summary>
      <returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous <see cref="T:System.Web.Http.HttpServer" /> open operation. Once this task completes successfully the server is running.</returns>
    </member>
    <member name="T:System.Web.Http.SelfHost.Channels.HttpBinding">
      <summary> A binding used with endpoints for web services that use strongly-type HTTP request  and response messages. </summary>
    </member>
    <member name="M:System.Web.Http.SelfHost.Channels.HttpBinding.#ctor">
      <summary>Initializes a new instance of the <see cref="T:System.Web.Http.SelfHost.Channels.HttpBinding" /> class.</summary>
    </member>
    <member name="M:System.Web.Http.SelfHost.Channels.HttpBinding.#ctor(System.Web.Http.SelfHost.Channels.HttpBindingSecurityMode)">
      <summary>Initializes a new instance of the <see cref="T:System.Web.Http.SelfHost.Channels.HttpBinding" /> class with a specified security mode.</summary>
      <param name="securityMode">An <see cref="T:System.Web.Http.SelfHost.Channels.HttpBindingSecurityMode" /> value that specifies the type of security used to configure a service endpoint using the <see cref="T:System.Web.Http.SelfHost.Channels.HttpBinding" /> binding.</param>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.ConfigureTransportBindingElement">
      <summary> Gets or sets the delegate which configures the <see cref="T:System.ServiceModel.Channels.HttpTransportBindingElement" /> that this binding creates. </summary>
      <returns>A delegate to configure the <see cref="T:System.ServiceModel.Channels.HttpTransportBindingElement" />.</returns>
    </member>
    <member name="M:System.Web.Http.SelfHost.Channels.HttpBinding.CreateBindingElements">
      <summary>Creates a collection that contains the binding elements that are part of the current binding.</summary>
      <returns>A collection that contains the binding elements from the current binding object in the correct order.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.EnvelopeVersion">
      <summary>Gets the version of SOAP that is used for messages that are processed by this binding. </summary>
      <returns>The value of the  <see cref="T:System.ServiceModel.EnvelopeVersion" /> that is used with this binding. The value is always <see cref="F:System.ServiceModel.EnvelopeVersion.None" />..</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.HostNameComparisonMode">
      <summary>Gets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.</summary>
      <returns>The <see cref="T:System.ServiceModel.HostnameComparisonMode" /> value. </returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.MaxBufferPoolSize">
      <summary>Gets or sets the maximum amount of memory allocated for the buffer manager that manages the buffers required by endpoints that use this binding.</summary>
      <returns>The maximum size, in bytes, for the pool of buffers used by an endpoint configured with this binding.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.MaxBufferSize">
      <summary>Gets or sets the maximum amount of memory that is allocated for use by the manager of the message buffers that receive messages from the channel.</summary>
      <returns>The maximum buffer size.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.MaxReceivedMessageSize">
      <summary>Gets or sets the maximum size for a message that can be processed by the binding.</summary>
      <returns>The maximum size, in bytes, for a message that is processed by the binding.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.Scheme">
      <summary>Gets the URI transport scheme for the channels and listeners that are configured with this binding.</summary>
      <returns>The transport scheme.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.Security">
      <summary>Gets or sets the security settings used with this binding.</summary>
      <returns>The security settings..</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.System#ServiceModel#Channels#IBindingRuntimePreferences#ReceiveSynchronously">
      <summary>Gets a value that indicates whether incoming requests are handled synchronously or asynchronously.</summary>
      <returns>true if requests are handled synchronously; false if handled asynchronously.</returns>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBinding.TransferMode">
      <summary>Gets or sets a value that indicates whether messages are sent buffered or streamed.</summary>
      <returns>The <see cref="T:System.ServiceModel.TransferMode" /> value that indicates whether messages are sent buffered or streamed.</returns>
    </member>
    <member name="T:System.Web.Http.SelfHost.Channels.HttpBindingSecurity">
      <summary> Specifies the types of security available to a service endpoint configured to use an <see cref="T:System.Web.Http.SelfHost.Channels.HttpBinding" /> binding. </summary>
    </member>
    <member name="M:System.Web.Http.SelfHost.Channels.HttpBindingSecurity.#ctor">
      <summary> Creates a new instance of the <see cref="T:System.Web.Http.SelfHost.Channels.HttpBindingSecurity" /> class. </summary>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBindingSecurity.Mode">
      <summary> Gets or sets the mode of security that is used by an endpoint configured to use an <see cref="T:System.Web.Http.SelfHost.Channels.HttpBinding" /> binding. </summary>
    </member>
    <member name="P:System.Web.Http.SelfHost.Channels.HttpBindingSecurity.Transport">
      <summary> Gets or sets an object that contains the transport-level security settings for the  <see cref="T:System.Web.Http.SelfHost.Channels.HttpBinding" /> binding. </summary>
    </member>
    <member name="T:System.Web.Http.SelfHost.Channels.HttpBindingSecurityMode">
      <summary> Defines the modes of security that can be used to configure a service endpoint that uses the <see cref="T:System.Web.Http.SelfHost.Channels.HttpBinding" />. </summary>
    </member>
    <member name="F:System.Web.Http.SelfHost.Channels.HttpBindingSecurityMode.None">
      <summary> Indicates no security is used with HTTP requests. </summary>
    </member>
    <member name="F:System.Web.Http.SelfHost.Channels.HttpBindingSecurityMode.Transport">
      <summary> Indicates that transport-level security is used with HTTP requests. </summary>
    </member>
    <member name="F:System.Web.Http.SelfHost.Channels.HttpBindingSecurityMode.TransportCredentialOnly">
      <summary> Indicates that only HTTP-based client authentication is provided. </summary>
    </member>
  </members>
</doc>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Architect
South Africa South Africa
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions