DataServiceHost DataServiceHost DataServiceHost DataServiceHost Class

Definition

Important

This API is not CLS-compliant.

The WCF Data Services class derived from WebServiceHost used to instantiate data services.

public ref class DataServiceHost : System::ServiceModel::Web::WebServiceHost
[System.CLSCompliant(false)]
public class DataServiceHost : System.ServiceModel.Web.WebServiceHost
type DataServiceHost = class
    inherit WebServiceHost
Public Class DataServiceHost
Inherits WebServiceHost
Inheritance
Attributes

Remarks

WCF Data Services are not autonomous server entities. Instead, the service is a component hosted in an environment such as the Windows Communication Foundation (WCF) that provides core server networking facilities. Specifically, a service does not bind to and listen on a network socket for incoming requests to its Representational State Transfer (REST) entry points. The host handles direct interactions with the network and support caching, scalability, and authentication modules.

WCF Data Services defines a generic hosting interface IDataServiceHost that abstracts its implementation from a specific host. This allows WCF Data Services to run in a range of hosting environments. For more information, see Hosting the Data Service.

Constructors

DataServiceHost(Type, Uri[]) DataServiceHost(Type, Uri[]) DataServiceHost(Type, Uri[]) DataServiceHost(Type, Uri[])

Instantiates DataServiceHost for WCF Data Services.

Methods

Abort() Abort() Abort() Abort()

Causes a communication object to transition immediately from its current state into the closing state.

(Inherited from CommunicationObject)
AddBaseAddress(Uri) AddBaseAddress(Uri) AddBaseAddress(Uri) AddBaseAddress(Uri)

Adds a base address to the service host.

(Inherited from ServiceHostBase)
AddDefaultEndpoints() AddDefaultEndpoints() AddDefaultEndpoints() 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) AddServiceEndpoint(ServiceEndpoint) AddServiceEndpoint(ServiceEndpoint) AddServiceEndpoint(ServiceEndpoint)

Adds the specified service endpoint to the hosted service.

(Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, String) AddServiceEndpoint(String, Binding, String) AddServiceEndpoint(String, Binding, String) 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, String, Uri) AddServiceEndpoint(String, Binding, String, Uri) AddServiceEndpoint(String, Binding, String, Uri) 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, Uri) AddServiceEndpoint(String, Binding, Uri) AddServiceEndpoint(String, Binding, Uri) 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(String, Binding, Uri, Uri) AddServiceEndpoint(String, Binding, Uri, Uri) AddServiceEndpoint(String, Binding, Uri, Uri) 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(Type, Binding, String) AddServiceEndpoint(Type, Binding, String) AddServiceEndpoint(Type, Binding, String) 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, String, Uri) AddServiceEndpoint(Type, Binding, String, Uri) AddServiceEndpoint(Type, Binding, String, Uri) 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, Uri) AddServiceEndpoint(Type, Binding, Uri) AddServiceEndpoint(Type, Binding, Uri) 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)
AddServiceEndpoint(Type, Binding, Uri, Uri) AddServiceEndpoint(Type, Binding, Uri, Uri) AddServiceEndpoint(Type, Binding, Uri, Uri) 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)
ApplyConfiguration() ApplyConfiguration() ApplyConfiguration() ApplyConfiguration()

Loads the service description from the configuration file and applies it to the runtime being constructed.

(Inherited from ServiceHost)
BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

(Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.

(Inherited from CommunicationObject)
Close() Close() Close() Close()

Causes a communication object to transition from its current state into the closed state.

(Inherited from CommunicationObject)
Close(TimeSpan) Close(TimeSpan) Close(TimeSpan) 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>) CreateDescription(IDictionary<String,ContractDescription>) CreateDescription(IDictionary<String,ContractDescription>) CreateDescription(IDictionary<String,ContractDescription>)

Creates a description of the service hosted.

(Inherited from ServiceHost)
EndClose(IAsyncResult) EndClose(IAsyncResult) EndClose(IAsyncResult) EndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
EndOpen(IAsyncResult) EndOpen(IAsyncResult) EndOpen(IAsyncResult) EndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Fault() Fault() Fault() Fault()

Causes a communication object to transition from its current state into the faulted state.

(Inherited from CommunicationObject)
GetCommunicationObjectType() GetCommunicationObjectType() GetCommunicationObjectType() GetCommunicationObjectType()

Gets the type of communication object.

(Inherited from CommunicationObject)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
IncrementManualFlowControlLimit(Int32) IncrementManualFlowControlLimit(Int32) IncrementManualFlowControlLimit(Int32) 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) InitializeDescription(Object, UriSchemeKeyedCollection) InitializeDescription(Object, UriSchemeKeyedCollection) InitializeDescription(Object, UriSchemeKeyedCollection)

Initializes a description of the service hosted based on its instance and specified base addresses.

(Inherited from ServiceHost)
InitializeDescription(Type, UriSchemeKeyedCollection) InitializeDescription(Type, UriSchemeKeyedCollection) InitializeDescription(Type, UriSchemeKeyedCollection) InitializeDescription(Type, UriSchemeKeyedCollection)

Initializes a description of the service hosted based on its type and specified base addresses.

(Inherited from ServiceHost)
InitializeDescription(UriSchemeKeyedCollection) InitializeDescription(UriSchemeKeyedCollection) InitializeDescription(UriSchemeKeyedCollection) InitializeDescription(UriSchemeKeyedCollection)

Creates and initializes the service host with the contract and service descriptions.

(Inherited from ServiceHostBase)
InitializeRuntime() InitializeRuntime() InitializeRuntime() InitializeRuntime()

Initializes the runtime for the service host.

(Inherited from ServiceHostBase)
LoadConfigurationSection(ServiceElement) LoadConfigurationSection(ServiceElement) LoadConfigurationSection(ServiceElement) LoadConfigurationSection(ServiceElement)

Loads the service element from the configuration file of the hosted service.

(Inherited from ServiceHostBase)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnAbort() OnAbort() OnAbort() OnAbort()

Aborts the service.

(Inherited from ServiceHostBase)
OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation invoked on the close of the service host.

(Inherited from ServiceHostBase)
OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation invoked on the opening of the service host.

(Inherited from ServiceHostBase)
OnClose(TimeSpan) OnClose(TimeSpan) OnClose(TimeSpan) OnClose(TimeSpan)

Closes down the hosted service, including their channel dispatchers and associated instance contexts and listeners.

(Inherited from ServiceHostBase)
OnClosed() OnClosed() OnClosed() OnClosed()

Disposes of disposable services that are being hosted when the service host is closed.

(Inherited from ServiceHost)
OnClosing() OnClosing() OnClosing() OnClosing()

Invoked during the transition of a communication object into the closing state.

(Inherited from CommunicationObject)
OnEndClose(IAsyncResult) OnEndClose(IAsyncResult) OnEndClose(IAsyncResult) OnEndClose(IAsyncResult)

Completes an asynchronous operation invoked on the closing of the service host.

(Inherited from ServiceHostBase)
OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult)

Completes an asynchronous operation invoked on the opening of the service host.

(Inherited from ServiceHostBase)
OnFaulted() OnFaulted() OnFaulted() 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) OnOpen(TimeSpan) OnOpen(TimeSpan) OnOpen(TimeSpan)

Opens the channel dispatchers.

(Inherited from ServiceHostBase)
OnOpened() OnOpened() OnOpened() OnOpened()

Gets the service credentials,service authentication and authorization behavior for the hosted service.

(Inherited from ServiceHostBase)
OnOpening() OnOpening() OnOpening() OnOpening()

Called when the WebServiceHost instance opens.

(Inherited from WebServiceHost)
Open() Open() Open() Open()

Causes a communication object to transition from the created state into the opened state.

(Inherited from CommunicationObject)
Open(TimeSpan) Open(TimeSpan) Open(TimeSpan) 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() ReleasePerformanceCounters() ReleasePerformanceCounters() ReleasePerformanceCounters()

Releases the service and channel dispatcher performance counters for the hosted service.

(Inherited from ServiceHostBase)
SetEndpointAddress(ServiceEndpoint, String) SetEndpointAddress(ServiceEndpoint, String) SetEndpointAddress(ServiceEndpoint, String) SetEndpointAddress(ServiceEndpoint, String)

Sets the endpoint address of the specified endpoint to the specified address.

(Inherited from ServiceHostBase)
ThrowIfDisposed() ThrowIfDisposed() ThrowIfDisposed() ThrowIfDisposed()

Throws an exception if the communication object is disposed.

(Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable()

Throws an exception if the communication object the State property is not set to the Created state.

(Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen()

Throws an exception if the communication object is not in the Opened state.

(Inherited from CommunicationObject)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Events

Closed Closed Closed Closed

Occurs when a communication object transitions into the closed state.

(Inherited from CommunicationObject)
Closing Closing Closing Closing

Occurs when a communication object transitions into the closing state.

(Inherited from CommunicationObject)
Faulted Faulted Faulted Faulted

Occurs when a communication object transitions into the faulted state.

(Inherited from CommunicationObject)
Opened Opened Opened Opened

Occurs when a communication object transitions into the opened state.

(Inherited from CommunicationObject)
Opening Opening Opening Opening

Occurs when a communication object transitions into the opening state.

(Inherited from CommunicationObject)
UnknownMessageReceived UnknownMessageReceived UnknownMessageReceived UnknownMessageReceived

Occurs when an unknown message is received.

(Inherited from ServiceHostBase)

Properties

Authentication Authentication Authentication Authentication

Gets the service authentication behavior.

(Inherited from ServiceHostBase)
Authorization Authorization Authorization Authorization

Gets the authorization behavior for the service hosted.

(Inherited from ServiceHostBase)
BaseAddresses BaseAddresses BaseAddresses BaseAddresses

Gets the base addresses used by the hosted service.

(Inherited from ServiceHostBase)
ChannelDispatchers ChannelDispatchers ChannelDispatchers ChannelDispatchers

Gets the collection of channel dispatchers used by the service host.

(Inherited from ServiceHostBase)
CloseTimeout CloseTimeout CloseTimeout CloseTimeout

Gets or sets the interval of time allowed for the service host to close.

(Inherited from ServiceHostBase)
Credentials Credentials Credentials Credentials

Gets the credential for the service hosted.

(Inherited from ServiceHostBase)
DefaultCloseTimeout DefaultCloseTimeout DefaultCloseTimeout DefaultCloseTimeout

Gets the default interval of time allowed for the service host to close.

(Inherited from ServiceHostBase)
DefaultOpenTimeout DefaultOpenTimeout DefaultOpenTimeout DefaultOpenTimeout

Gets the default interval of time allowed for the service host to open.

(Inherited from ServiceHostBase)
Description Description Description Description

Gets the description of the service hosted.

(Inherited from ServiceHostBase)
Extensions Extensions Extensions Extensions

Gets the extensions for the current specified service host.

(Inherited from ServiceHostBase)
ImplementedContracts ImplementedContracts ImplementedContracts ImplementedContracts

Retrieves the contracts implemented by the service hosted.

(Inherited from ServiceHostBase)
IsDisposed IsDisposed IsDisposed IsDisposed

Gets a value that indicates whether the communication object has been disposed.

(Inherited from CommunicationObject)
ManualFlowControlLimit ManualFlowControlLimit ManualFlowControlLimit ManualFlowControlLimit

Gets or sets the flow control limit for messages received by the service hosted.

(Inherited from ServiceHostBase)
OpenTimeout OpenTimeout OpenTimeout OpenTimeout

Gets or sets the interval of time allowed for the service host to open.

(Inherited from ServiceHostBase)
SingletonInstance SingletonInstance SingletonInstance SingletonInstance

Gets the singleton instance of the hosted service.

(Inherited from ServiceHost)
State State State State

Gets a value that indicates the current state of the communication object.

(Inherited from CommunicationObject)
ThisLock ThisLock ThisLock ThisLock

Gets the mutually exclusive lock that protects the class instance during a state transition.

(Inherited from CommunicationObject)

Explicit Interface Implementations

IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose()

Closes the service host.

(Inherited from ServiceHostBase)

Applies to