ServiceHost Class

Reference

Definition

Namespace:: System.ServiceModel

Assembly:: System.ServiceModel.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.

Provides a host for services.

public ref class ServiceHost : System::ServiceModel::ServiceHostBase

public class ServiceHost : System.ServiceModel.ServiceHostBase

type ServiceHost = class
    inherit ServiceHostBase

Public Class ServiceHost
Inherits ServiceHostBase

Inheritance: Object

CommunicationObject

ServiceHostBase
ServiceHost

Derived: System.ServiceModel.Security.WSTrustServiceHost

System.ServiceModel.Web.WebServiceHost

Examples

// Host the service within this EXE console application.
public static void Main()
{
  using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService)))
  {
    try
    {
      // Open the ServiceHost to start listening for messages.
      serviceHost.Open();

        // The service can now be accessed.
      Console.WriteLine("The service is ready.");
      Console.WriteLine("Press <ENTER> to terminate service.");
      Console.ReadLine();

      // Close the ServiceHost.
      serviceHost.Close();
    }
    catch (TimeoutException timeProblem)
    {
      Console.WriteLine(timeProblem.Message);
      Console.ReadLine();
    }
    catch (CommunicationException commProblem)
    {
      Console.WriteLine(commProblem.Message);
      Console.ReadLine();
    }
  }
}

' Host the service within this EXE console application.
Public Shared Sub Main()
    ' Create a ServiceHost for the CalculatorService type and use the base address from config.
    Using svcHost As New ServiceHost(GetType(CalculatorService))
        Try
            ' Open the ServiceHost to start listening for messages.
            svcHost.Open()

            ' The service can now be accessed.
            Console.WriteLine("The service is ready.")
            Console.WriteLine("Press <ENTER> to terminate service.")
            Console.WriteLine()
            Console.ReadLine()

            'Close the ServiceHost.
            svcHost.Close()

        Catch timeout As TimeoutException
            Console.WriteLine(timeout.Message)
            Console.ReadLine()
        Catch commException As CommunicationException
            Console.WriteLine(commException.Message)
            Console.ReadLine()
        End Try
    End Using

End Sub

Remarks

Implements the host used by the Windows Communication Foundation (WCF) service model programming model.

Use the ServiceHost class to configure and expose a service for use by client applications when you are not using Internet Information Services (IIS) or Windows Activation Services (WAS) to expose a service. Both IIS and WAS interact with a ServiceHost object on your behalf.

To expose a service for use by callers, WCF requires a complete service description (represented by the ServiceDescription class). The ServiceHost class creates a ServiceDescription from the service type and configuration information and then uses that description to create ChannelDispatcher objects for each endpoint in the description.

Use a ServiceHost object to load a service, configure endpoints, apply security settings, and start listeners to handle incoming requests.

Constructors

ServiceHost()	Initializes a new instance of the ServiceHost class.
ServiceHost(Object, Uri[])	Initializes a new instance of the ServiceHost class with the instance of the service and its base addresses specified.
ServiceHost(Type, Uri[])	Initializes a new instance of the ServiceHost class with the type of service and its base addresses specified.

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.
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.
AddServiceEndpoint(Type, Binding, String)	Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address.
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.
AddServiceEndpoint(Type, Binding, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, and URI that contains the endpoint address.
ApplyConfiguration()	Loads the service description from the configuration file and applies it to the runtime being constructed.
ApplyConfiguration()	Loads the service description information from the configuration file and applies it to the runtime being constructed. (Inherited from ServiceHostBase)
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.
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.
InitializeDescription(Type, UriSchemeKeyedCollection)	Initializes a description of the service hosted based on its type and specified base addresses.
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.
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()	Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject)
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

Share via