WebServiceHost Класс

Определение

Производный класс ServiceHost, дополняющий модель программирования REST Windows Communication Foundation (WCF).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
Наследование
Производный

Примеры

В следующем примере показано, как использовать WebServiceHost класс для размещения службы, использующей модель программирования WCF RESTful.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


Комментарии

Если объект WebServiceHost не обнаруживает конечные точки в описании службы, он автоматически создает конечную точку по умолчанию по базовому адресу службы для базовых адресов HTTP и HTTPS.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 автоматически настраивает привязку конечной точки для работы со связанными параметрами безопасности IIS при использовании в защищенном виртуальном каталоге.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.

При создании конечной точки HTTP по умолчанию WebServiceHost также отключает страницу справки HTTP и функцию GET языка WSDL, чтобы конечная точка метаданных не мешала конечной точке HTTP по умолчанию.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.

В дополнение к этому, класс WebServiceHost добавляет WebHttpBehavior ко всем конечным точкам, которые еще не имеют этого расширения функциональности и содержат WebMessageEncodingElement.In addition, the WebServiceHost class adds the WebHttpBehavior to all endpoints that do not already have the behavior and that have a WebMessageEncodingElement. Если все операции службы либо имеют пустой текст HTTP-запросов, либо HTTP-запросы в виде потока, то WebServiceHost автоматически настраивает соответствующее сопоставление типа содержимого для привязки.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.

Конструкторы

WebServiceHost()

Инициализирует новый экземпляр класса WebServiceHost.Initializes a new instance of the WebServiceHost class.

WebServiceHost(Object, Uri[])

Инициализирует новый экземпляр класса WebServiceHost с заданным экземпляром и базовым адресом одноэлементного сервера.Initializes a new instance of the WebServiceHost class with the specified singleton server instance and base address.

WebServiceHost(Type, Uri[])

Инициализирует новый экземпляр класса WebServiceHost с заданным типом службы и базовым адресом.Initializes a new instance of the WebServiceHost class with the specified service type and base address.

Свойства

Authentication

Возвращает поведение проверки подлинности службы.Gets the service authentication behavior.

(Унаследовано от ServiceHostBase)
Authorization

Возвращает поведение авторизации для размещенной службы.Gets the authorization behavior for the service hosted.

(Унаследовано от ServiceHostBase)
BaseAddresses

Возвращает базовые адреса, используемые размещенной службой.Gets the base addresses used by the hosted service.

(Унаследовано от ServiceHostBase)
ChannelDispatchers

Возвращает коллекцию диспетчеров каналов, используемых узлом службы.Gets the collection of channel dispatchers used by the service host.

(Унаследовано от ServiceHostBase)
CloseTimeout

Возвращает или задает интервал времени, выделенный для операции закрытия узла службы.Gets or sets the interval of time allowed for the service host to close.

(Унаследовано от ServiceHostBase)
Credentials

Возвращает учетные данные для размещенной службы.Gets the credential for the service hosted.

(Унаследовано от ServiceHostBase)
DefaultCloseTimeout

Возвращает интервал времени по умолчанию, выделенный для операции закрытия узла службы.Gets the default interval of time allowed for the service host to close.

(Унаследовано от ServiceHostBase)
DefaultOpenTimeout

Возвращает интервал времени по умолчанию, выделенный для операции открытия узла службы.Gets the default interval of time allowed for the service host to open.

(Унаследовано от ServiceHostBase)
Description

Возвращает описание размещенной службы.Gets the description of the service hosted.

(Унаследовано от ServiceHostBase)
Extensions

Возвращает расширения для текущего заданного узла службы.Gets the extensions for the current specified service host.

(Унаследовано от ServiceHostBase)
ImplementedContracts

Извлекает контракты, реализованные размещенной службой.Retrieves the contracts implemented by the service hosted.

(Унаследовано от ServiceHostBase)
IsDisposed

Возвращает значение, указывающее, удален ли объект связи.Gets a value that indicates whether the communication object has been disposed.

(Унаследовано от CommunicationObject)
ManualFlowControlLimit

Возвращает или задает предел управления потоками для сообщений, полученных размещенной службой.Gets or sets the flow control limit for messages received by the service hosted.

(Унаследовано от ServiceHostBase)
OpenTimeout

Возвращает или задает интервал времени, выделенный для операции открытия узла службы.Gets or sets the interval of time allowed for the service host to open.

(Унаследовано от ServiceHostBase)
SingletonInstance

Возвращает одноэлементный экземпляр размещенной службы.Gets the singleton instance of the hosted service.

(Унаследовано от ServiceHost)
State

Возвращает значение, которое указывает на текущее состояние объекта связи.Gets a value that indicates the current state of the communication object.

(Унаследовано от CommunicationObject)
ThisLock

Возвращает взаимно исключающую блокировку, которая защищает экземпляр класса в процессе перехода между состояниями.Gets the mutually exclusive lock that protects the class instance during a state transition.

(Унаследовано от CommunicationObject)

Методы

Abort()

Вызывает мгновенный переход объекта связи из текущего состояния в состояние закрытия.Causes a communication object to transition immediately from its current state into the closing state.

(Унаследовано от CommunicationObject)
AddBaseAddress(Uri)

Добавляет базовый адрес в узел службы.Adds a base address to the service host.

(Унаследовано от ServiceHostBase)
AddDefaultEndpoints()

Добавляет конечные точки службы для всех базовых адресов в каждом контракте, найденных в узле службы, имеющих привязку по умолчанию.Adds service endpoints for all base addresses in each contract found in the service host with the default binding.

(Унаследовано от ServiceHostBase)
AddServiceEndpoint(ServiceEndpoint)

Добавляет заданную конечную точку службы в размещенную службу.Adds the specified service endpoint to the hosted service.

(Унаследовано от ServiceHostBase)
AddServiceEndpoint(String, Binding, String)

Добавляет конечную точку службы в размещенную службу с указанными контрактом, привязкой и адресом конечной точки.Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address.

(Унаследовано от ServiceHostBase)
AddServiceEndpoint(String, Binding, String, Uri)

Добавляет конечную точку службы в размещенную службу с указанными контрактом, привязкой, адресом конечной точки и универсальным кодом ресурса (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.

(Унаследовано от ServiceHostBase)
AddServiceEndpoint(String, Binding, Uri)

Добавляет конечную точку службы в размещенную службу с указанными контрактом, привязкой и универсальным кодом ресурса (URI), содержащим адрес конечной точки.Adds a service endpoint to the hosted service with a specified contract, binding, and a URI that contains the endpoint address.

(Унаследовано от ServiceHostBase)
AddServiceEndpoint(String, Binding, Uri, Uri)

Добавляет конечную точку службы в размещенную службу с указанными контрактом, привязкой и универсальными кодами ресурса (URI), содержащими адреса конечных точек и прослушивания.Adds a service endpoint to the hosted service with the specified contract, binding, and URIs that contain the endpoint and listening addresses.

(Унаследовано от ServiceHostBase)
AddServiceEndpoint(Type, Binding, String)

Добавляет конечную точку службы в размещенную службу с указанными контрактом, привязкой и адресом конечной точки.Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address.

(Унаследовано от ServiceHost)
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.

(Унаследовано от 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.

(Унаследовано от 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.

(Унаследовано от ServiceHost)
ApplyConfiguration()

Загружает описание службы из файла конфигурации и применяет его к создаваемой среде выполнения.Loads the service description from the configuration file and applies it to the runtime being constructed.

(Унаследовано от ServiceHost)
BeginClose(AsyncCallback, Object)

Начинает асинхронную операцию закрытия объекта связи.Begins an asynchronous operation to close a communication object.

(Унаследовано от CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)

Начинает асинхронную операцию закрытия объекта связи с заданным временем ожидания.Begins an asynchronous operation to close a communication object with a specified timeout.

(Унаследовано от CommunicationObject)
BeginOpen(AsyncCallback, Object)

Начинает асинхронную операцию открытия объекта связи.Begins an asynchronous operation to open a communication object.

(Унаследовано от CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)

Начинает асинхронную операцию открытия объекта связи в течение заданного интервала времени.Begins an asynchronous operation to open a communication object within a specified interval of time.

(Унаследовано от CommunicationObject)
Close()

Вызывает переход объекта связи из текущего состояния в состояние Closed.Causes a communication object to transition from its current state into the closed state.

(Унаследовано от CommunicationObject)
Close(TimeSpan)

Вызывает переход объекта связи из его текущего состояния в состояние Closed в течение заданного интервала времени.Causes a communication object to transition from its current state into the closed state within a specified interval of time.

(Унаследовано от CommunicationObject)
CreateDescription(IDictionary<String,ContractDescription>)

Создает описание размещенной службы.Creates a description of the service hosted.

(Унаследовано от ServiceHost)
EndClose(IAsyncResult)

Завершает асинхронную операцию закрытия объекта связи.Completes an asynchronous operation to close a communication object.

(Унаследовано от CommunicationObject)
EndOpen(IAsyncResult)

Завершает асинхронную операцию открытия объекта связи.Completes an asynchronous operation to open a communication object.

(Унаследовано от CommunicationObject)
Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Fault()

Вызывает переход объекта связи из текущего состояния в состояние Faulted.Causes a communication object to transition from its current state into the faulted state.

(Унаследовано от CommunicationObject)
GetCommunicationObjectType()

Возвращает тип объекта связи.Gets the type of communication object.

(Унаследовано от CommunicationObject)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IncrementManualFlowControlLimit(Int32)

Увеличивает значение предела скорости потока сообщений в размещенную службу на заданную величину.Increases the limit on the flow rate of messages to the hosted service by a specified increment.

(Унаследовано от ServiceHostBase)
InitializeDescription(Object, UriSchemeKeyedCollection)

Инициализирует описание службы, размещенной на основе ее экземпляра и указанных базовых адресов.Initializes a description of the service hosted based on its instance and specified base addresses.

(Унаследовано от ServiceHost)
InitializeDescription(Type, UriSchemeKeyedCollection)

Инициализирует описание службы, размещенной на основе ее типа и указанных базовых адресов.Initializes a description of the service hosted based on its type and specified base addresses.

(Унаследовано от ServiceHost)
InitializeDescription(UriSchemeKeyedCollection)

Создает и инициализирует узел службы с описаниями контрактов и служб.Creates and initializes the service host with the contract and service descriptions.

(Унаследовано от ServiceHostBase)
InitializeRuntime()

Инициализирует среду выполнения для узла службы.Initializes the runtime for the service host.

(Унаследовано от ServiceHostBase)
LoadConfigurationSection(ServiceElement)

Загружает элемент службы из файла конфигурации размещенной службы.Loads the service element from the configuration file of the hosted service.

(Унаследовано от ServiceHostBase)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
OnAbort()

Прерывает работу службы.Aborts the service.

(Унаследовано от ServiceHostBase)
OnBeginClose(TimeSpan, AsyncCallback, Object)

Начинает асинхронную операцию, вызванную закрытием узла службы.Begins an asynchronous operation invoked on the close of the service host.

(Унаследовано от ServiceHostBase)
OnBeginOpen(TimeSpan, AsyncCallback, Object)

Начинает асинхронную операцию, вызванную открытием узла службы.Begins an asynchronous operation invoked on the opening of the service host.

(Унаследовано от ServiceHostBase)
OnClose(TimeSpan)

Закрывает размещенную службу, включая диспетчеры каналов и связанные контексты и прослушиватели экземпляра.Closes down the hosted service, including their channel dispatchers and associated instance contexts and listeners.

(Унаследовано от ServiceHostBase)
OnClosed()

Удаляет службы с возможностью удаления, размещенные во время закрытия узла службы.Disposes of disposable services that are being hosted when the service host is closed.

(Унаследовано от ServiceHost)
OnClosing()

Вызывается в процессе перехода объекта связи в состояние закрытия.Invoked during the transition of a communication object into the closing state.

(Унаследовано от CommunicationObject)
OnEndClose(IAsyncResult)

Завершает асинхронную операцию, вызванную закрытием узла службы.Completes an asynchronous operation invoked on the closing of the service host.

(Унаследовано от ServiceHostBase)
OnEndOpen(IAsyncResult)

Завершает асинхронную операцию, вызванную открытием узла службы.Completes an asynchronous operation invoked on the opening of the service host.

(Унаследовано от ServiceHostBase)
OnFaulted()

Вставляет операцию обработки объекта связи после перехода объекта в состояние Faulted в связи с вызовом синхронной операции ошибки.Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation.

(Унаследовано от CommunicationObject)
OnOpen(TimeSpan)

Открывает диспетчеры каналов.Opens the channel dispatchers.

(Унаследовано от ServiceHostBase)
OnOpened()

Возвращает учетные данные службы, проверку подлинности службы и поведение авторизации для размещенной службы.Gets the service credentials,service authentication and authorization behavior for the hosted service.

(Унаследовано от ServiceHostBase)
OnOpening()

Вызывается при открытии экземпляра WebServiceHost.Called when the WebServiceHost instance opens.

Open()

Вызывает переход объекта связи из состояния Created в состояние Opened.Causes a communication object to transition from the created state into the opened state.

(Унаследовано от CommunicationObject)
Open(TimeSpan)

Вызывает переход объекта связи из состояния Created в состояние Opened в течение заданного интервала времени.Causes a communication object to transition from the created state into the opened state within a specified interval of time.

(Унаследовано от CommunicationObject)
ReleasePerformanceCounters()

Освобождает счетчики производительности диспетчера каналов и служб для размещенной службы.Releases the service and channel dispatcher performance counters for the hosted service.

(Унаследовано от ServiceHostBase)
SetEndpointAddress(ServiceEndpoint, String)

Задает в качестве адреса указанной конечной точки указанный адрес.Sets the endpoint address of the specified endpoint to the specified address.

(Унаследовано от ServiceHostBase)
ThrowIfDisposed()

Вызывает исключение, если объект связи удален.Throws an exception if the communication object is disposed.

(Унаследовано от CommunicationObject)
ThrowIfDisposedOrImmutable()

Создает исключение, если для свойства объекта связи State не установлено значение Created.Throws an exception if the communication object the State property is not set to the Created state.

(Унаследовано от CommunicationObject)
ThrowIfDisposedOrNotOpen()

Создает исключение, если объект связи не находится в состоянии Opened.Throws an exception if the communication object is not in the Opened state.

(Унаследовано от CommunicationObject)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

События

Closed

Происходит при переходе объекта связи в состояние Closed.Occurs when a communication object transitions into the closed state.

(Унаследовано от CommunicationObject)
Closing

Происходит при переходе объекта связи в состояние закрытия.Occurs when a communication object transitions into the closing state.

(Унаследовано от CommunicationObject)
Faulted

Происходит при переходе объекта связи в состояние Faulted.Occurs when a communication object transitions into the faulted state.

(Унаследовано от CommunicationObject)
Opened

Происходит при переходе объекта связи в состояние Opened.Occurs when a communication object transitions into the opened state.

(Унаследовано от CommunicationObject)
Opening

Происходит при переходе объекта связи в состояние открытия.Occurs when a communication object transitions into the opening state.

(Унаследовано от CommunicationObject)
UnknownMessageReceived

Происходит при получении неизвестного сообщения.Occurs when an unknown message is received.

(Унаследовано от ServiceHostBase)

Явные реализации интерфейса

IDisposable.Dispose()

Закрывает узел службы.Closes the service host.

(Унаследовано от ServiceHostBase)

Применяется к