This topic has not yet been rated - Rate this topic

ServiceHostBase Class

Extends the ServiceHostBase class to implement hosts that expose custom programming models.

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public abstract class ServiceHostBase : CommunicationObject, 
	IExtensibleObject<ServiceHostBase>, IDisposable

The ServiceHostBase type exposes the following members.

  Name Description
Protected method ServiceHostBase Initializes a new instance of the ServiceHostBase class.
Top
  Name Description
Public property Authentication Gets the service authentication behavior.
Public property Authorization Gets the authorization behavior for the service hosted.
Public property BaseAddresses Gets the base addresses used by the hosted service.
Public property ChannelDispatchers Gets the collection of channel dispatchers used by the service host.
Public property CloseTimeout Gets or sets the interval of time allowed for the service host to close.
Public property Credentials Gets the credential for the service hosted.
Protected property DefaultCloseTimeout Gets the default interval of time allowed for the service host to close. (Overrides CommunicationObject.DefaultCloseTimeout.)
Protected property DefaultOpenTimeout Gets the default interval of time allowed for the service host to open. (Overrides CommunicationObject.DefaultOpenTimeout.)
Public property Description Gets the description of the service hosted.
Public property Extensions Gets the extensions for the current specified service host.
Protected property ImplementedContracts Retrieves the contracts implemented by the service hosted.
Protected property IsDisposed Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public property ManualFlowControlLimit Gets or sets the flow control limit for messages received by the service hosted.
Public property OpenTimeout Gets or sets the interval of time allowed for the service host to open.
Public property State Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected property ThisLock Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top
  Name Description
Public method Abort Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Protected method AddBaseAddress Adds a base address to the service host.
Public method AddDefaultEndpoints Adds service endpoints for all base addresses in each contract found in the service host with the default binding.
Public method AddServiceEndpoint(ServiceEndpoint) Adds the specified service endpoint to the hosted service.
Public method AddServiceEndpoint(String, Binding, String) Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address.
Public method 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.
Public method 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.
Public method 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.
Protected method ApplyConfiguration Loads the service description information from the configuration file and applies it to the runtime being constructed.
Public method BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public method BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public method Close() Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public method 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.)
Protected method CreateDescription When implemented in a derived class, creates the description of the hosted service.
Public method EndClose Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method EndOpen Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Fault Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetCommunicationObjectType Gets the type of communication object. (Inherited from CommunicationObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IncrementManualFlowControlLimit Increases the limit on the flow rate of messages to the hosted service by a specified increment.
Protected method InitializeDescription Creates and initializes the service host with the contract and service descriptions.
Protected method InitializeRuntime Initializes the runtime for the service host.
Protected method LoadConfigurationSection Loads the service element from the configuration file of the hosted service.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnAbort Aborts the service. (Overrides CommunicationObject.OnAbort().)
Protected method OnBeginClose Begins an asynchronous operation invoked on the close of the service host. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginOpen Begins an asynchronous operation invoked on the opening of the service host. (Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected method OnClose Closes down the hosted service, including their channel dispatchers and associated instance contexts and listeners. (Overrides CommunicationObject.OnClose(TimeSpan).)
Protected method OnClosed Releases resources used by the service host. (Overrides CommunicationObject.OnClosed().)
Protected method OnClosing Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method OnEndClose Completes an asynchronous operation invoked on the closing of the service host. (Overrides CommunicationObject.OnEndClose(IAsyncResult).)
Protected method OnEndOpen Completes an asynchronous operation invoked on the opening of the service host. (Overrides CommunicationObject.OnEndOpen(IAsyncResult).)
Protected method 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.)
Protected method OnOpen Opens the channel dispatchers. (Overrides CommunicationObject.OnOpen(TimeSpan).)
Protected method OnOpened Gets the service credentials,service authentication and authorization behavior for the hosted service. (Overrides CommunicationObject.OnOpened().)
Protected method OnOpening Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject.)
Public method Open() Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public method 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.)
Protected method ReleasePerformanceCounters Releases the service and channel dispatcher performance counters for the hosted service.
Public method SetEndpointAddress Sets the endpoint address of the specified endpoint to the specified address.
Protected method ThrowIfDisposed Throws an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrImmutable Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event Closed Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public event Closing Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public event Faulted Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public event Opened Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public event Opening Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Public event UnknownMessageReceived Occurs when an unknown message is received.
Top
  Name Description
Explicit interface implemetation Private method IDisposable.Dispose Closes the service host.
Top

Use the ServiceHostBase class to create hosts that provide a custom programming model. The service programming model uses the ServiceHost class.

Special note for Managed C++ users deriving from this class:

  • Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor.

  • Avoid destructors; they cause the compiler to auto-generate IDisposable.

  • Avoid non-reference members; they can cause the compiler to auto-generate IDisposable.

  • Avoid finalizers; but if you include one, you should suppress the build warning and call SuppressFinalize(Object) and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated IDisposable behavior.

This sample uses the ServiceHost class, which is derived from ServiceHostBase.


// 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();
    }
  }
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ