WebServiceHost Class

Reference

Definition

Namespace:: System.ServiceModel.Web

Assembly:: System.ServiceModel.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A ServiceHost derived class that compliments the Windows Communication Foundation (WCF) REST programming model.

public ref class WebServiceHost : System::ServiceModel::ServiceHost

public class WebServiceHost : System.ServiceModel.ServiceHost

type WebServiceHost = class
    inherit ServiceHost

Public Class WebServiceHost
Inherits ServiceHost

Inheritance: Object

CommunicationObject

ServiceHostBase

ServiceHost
WebServiceHost

Derived: System.Data.Services.DataServiceHost

Examples

The following example shows how to use the WebServiceHost class to host a service that makes use of the WCF REST programming model.

[ServiceContract]
public interface ICalculator
{
    [OperationContract]
    [WebInvoke(UriTemplate = "add?x={x}&y={y}")]
    long Add(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "sub?x={x}&y={y}")]
    long Subtract(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "mult?x={x}&y={y}")]
    long Multiply(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "div?x={x}&y={y}")]
    long Divide(long x, long y);

    [OperationContract]
    [WebGet(UriTemplate = "hello?name={name}")]
    string SayHello(string name);
}

public class CalcService : ICalculator
{
    public long Add(long x, long y)
    {
        return x + y;
    }

    public long Subtract(long x, long y)
    {
        return x - y;
    }

    public long Multiply(long x, long y)
    {
        return x * y;
    }

    public long Divide(long x, long y)
    {
        return x / y;
    }

    public string SayHello(string name)
    {
        return "Hello " + name;
    }
}

class Program
{
    static void Main(string[] args)
    {
        Uri baseAddress = new Uri("http://localhost:8000/");

        WebServiceHost svcHost = new WebServiceHost(typeof(CalcService), baseAddress);

        try
        {
            svcHost.Open();

            Console.WriteLine("Service is running");
            Console.WriteLine("Press enter to quit...");
            Console.ReadLine();

            svcHost.Close();
        }
        catch (CommunicationException cex)
        {
            Console.WriteLine("An exception occurred: {0}", cex.Message);
            svcHost.Abort();
        }
    }
}

<ServiceContract()> _
Public Interface ICalculator
    <OperationContract()> _
    <WebInvoke(UriTemplate:="add?x={x}&y={y}")> _
    Function Add(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="sub?x={x}&y={y}")> _
    Function Subtract(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="mult?x={x}&y={y}")> _
    Function Multiply(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="div?x={x}&y={y}")> _
    Function Divide(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebGet(UriTemplate:="hello?name={name}")> _
    Function SayHello(ByVal name As String) As String
End Interface

Public Class CalcService
    Implements ICalculator
    Public Function Add(ByVal x As Long, ByVal y As Long) As Long Implements ICalculator.Add
        Return x + y
    End Function

    Public Function Subtract(ByVal x As Long, ByVal y As Long) As Long Implements ICalculator.Subtract
        Return x - y
    End Function

    Public Function Multiply(ByVal x As Long, ByVal y As Long) As Long Implements ICalculator.Multiply
        Return x * y
    End Function

    Public Function Divide(ByVal x As Long, ByVal y As Long) As Long Implements ICalculator.Divide
        Return x / y
    End Function

    Public Function SayHello(ByVal name As String) As String Implements ICalculator.SayHello
        Return "Hello " + name
    End Function
End Class

Remarks

If WebServiceHost finds no endpoints in the service description, it automatically creates a default endpoint at the service's base address for HTTP and HTTPS base addresses. It does not create an endpoint automatically if the user has configured an endpoint explicitly at the base address. WebServiceHost automatically configures the endpoint's binding to work with the associated Internet Information Services (IIS) security settings when used in a secure virtual directory.

When creating a default HTTP endpoint, the WebServiceHost also disables the HTTP Help page and the Web Services Description Language (WSDL) GET functionality so the metadata endpoint does not interfere with the default HTTP endpoint.

In addition, the WebServiceHost class adds the WebHttpBehavior to all endpoints that do not already have the behavior and that have a WebMessageEncodingElement. If all the operations on the service have either empty HTTP request bodies or deal with the HTTP request body as a stream, then the WebServiceHost automatically configures the appropriate content type mapper for the binding.

Constructors

WebServiceHost()	Initializes a new instance of the WebServiceHost class.
WebServiceHost(Object, Uri[])	Initializes a new instance of the WebServiceHost class with the specified singleton server instance and base address.
WebServiceHost(Type, Uri[])	Initializes a new instance of the WebServiceHost class with the specified service type and base address.

Properties

Authentication	Gets the service authentication behavior. (Inherited from ServiceHostBase)
Authorization	Gets the authorization behavior for the service hosted. (Inherited from ServiceHostBase)
BaseAddresses	Gets the base addresses used by the hosted service. (Inherited from ServiceHostBase)
ChannelDispatchers	Gets the collection of channel dispatchers used by the service host. (Inherited from ServiceHostBase)
CloseTimeout	Gets or sets the interval of time allowed for the service host to close. (Inherited from ServiceHostBase)
Credentials	Gets the credential for the service hosted. (Inherited from ServiceHostBase)
DefaultCloseTimeout	Gets the default interval of time allowed for the service host to close. (Inherited from ServiceHostBase)
DefaultOpenTimeout	Gets the default interval of time allowed for the service host to open. (Inherited from ServiceHostBase)
Description	Gets the description of the service hosted. (Inherited from ServiceHostBase)
Extensions	Gets the extensions for the current specified service host. (Inherited from ServiceHostBase)
ImplementedContracts	Retrieves the contracts implemented by the service hosted. (Inherited from ServiceHostBase)
IsDisposed	Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject)
ManualFlowControlLimit	Gets or sets the flow control limit for messages received by the service hosted. (Inherited from ServiceHostBase)
OpenTimeout	Gets or sets the interval of time allowed for the service host to open. (Inherited from ServiceHostBase)
SingletonInstance	Gets the singleton instance of the hosted service. (Inherited from ServiceHost)
State	Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject)
ThisLock	Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject)
AddBaseAddress(Uri)	Adds a base address to the service host. (Inherited from ServiceHostBase)
AddDefaultEndpoints()	Adds service endpoints for all base addresses in each contract found in the service host with the default binding. (Inherited from ServiceHostBase)
AddServiceEndpoint(ServiceEndpoint)	Adds the specified service endpoint to the hosted service. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, String, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, endpoint address and URI that contains the address at which it listens. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, String)	Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, Uri, Uri)	Adds a service endpoint to the hosted service with the specified contract, binding, and URIs that contain the endpoint and listening addresses. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, and a URI that contains the endpoint address. (Inherited from ServiceHostBase)
AddServiceEndpoint(Type, Binding, String, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, an endpoint address, and a URI on which the service listens. (Inherited from ServiceHost)
AddServiceEndpoint(Type, Binding, String)	Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address. (Inherited from ServiceHost)
AddServiceEndpoint(Type, Binding, Uri, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, a URI that contains the endpoint address, and a URI on which the service listens. (Inherited from ServiceHost)
AddServiceEndpoint(Type, Binding, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, and URI that contains the endpoint address. (Inherited from ServiceHost)
ApplyConfiguration()	Loads the service description from the configuration file and applies it to the runtime being constructed. (Inherited from ServiceHost)
BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject)
Close()	Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject)
Close(TimeSpan)	Causes a communication object to transition from its current state into the closed state within a specified interval of time. (Inherited from CommunicationObject)
CreateDescription(IDictionary<String,ContractDescription>)	Creates a description of the service hosted. (Inherited from ServiceHost)
EndClose(IAsyncResult)	Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
EndOpen(IAsyncResult)	Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Fault()	Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject)
GetCommunicationObjectType()	Gets the type of communication object. (Inherited from CommunicationObject)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IncrementManualFlowControlLimit(Int32)	Increases the limit on the flow rate of messages to the hosted service by a specified increment. (Inherited from ServiceHostBase)
InitializeDescription(Object, UriSchemeKeyedCollection)	Initializes a description of the service hosted based on its instance and specified base addresses. (Inherited from ServiceHost)
InitializeDescription(Type, UriSchemeKeyedCollection)	Initializes a description of the service hosted based on its type and specified base addresses. (Inherited from ServiceHost)
InitializeDescription(UriSchemeKeyedCollection)	Creates and initializes the service host with the contract and service descriptions. (Inherited from ServiceHostBase)
InitializeRuntime()	Initializes the runtime for the service host. (Inherited from ServiceHostBase)
LoadConfigurationSection(ServiceElement)	Loads the service element from the configuration file of the hosted service. (Inherited from ServiceHostBase)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Aborts the service. (Inherited from ServiceHostBase)
OnBeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation invoked on the close of the service host. (Inherited from ServiceHostBase)
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation invoked on the opening of the service host. (Inherited from ServiceHostBase)
OnClose(TimeSpan)	Closes down the hosted service, including their channel dispatchers and associated instance contexts and listeners. (Inherited from ServiceHostBase)
OnClosed()	Disposes of disposable services that are being hosted when the service host is closed. (Inherited from ServiceHost)
OnClosing()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnEndClose(IAsyncResult)	Completes an asynchronous operation invoked on the closing of the service host. (Inherited from ServiceHostBase)
OnEndOpen(IAsyncResult)	Completes an asynchronous operation invoked on the opening of the service host. (Inherited from ServiceHostBase)
OnFaulted()	Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation. (Inherited from CommunicationObject)
OnOpen(TimeSpan)	Opens the channel dispatchers. (Inherited from ServiceHostBase)
OnOpened()	Gets the service credentials,service authentication and authorization behavior for the hosted service. (Inherited from ServiceHostBase)
OnOpening()	Called when the WebServiceHost instance opens.
Open()	Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject)
Open(TimeSpan)	Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from CommunicationObject)
ReleasePerformanceCounters()	Releases the service and channel dispatcher performance counters for the hosted service. (Inherited from ServiceHostBase)
SetEndpointAddress(ServiceEndpoint, String)	Sets the endpoint address of the specified endpoint to the specified address. (Inherited from ServiceHostBase)
ThrowIfDisposed()	Throws an exception if the communication object is disposed. (Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable()	Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen()	Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

Closed	Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject)
Closing	Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject)
Faulted	Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject)
Opened	Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject)
Opening	Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject)
UnknownMessageReceived	Occurs when an unknown message is received. (Inherited from ServiceHostBase)

Explicit Interface Implementations

IDisposable.Dispose()

Closes the service host.

(Inherited from ServiceHostBase)

Applies to

Sdílet prostřednictvím