Export (0) Print
Expand All

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.

  NameDescription
Protected methodServiceHostBaseInitializes a new instance of the ServiceHostBase class.
Top

  NameDescription
Public propertyAuthenticationGets the service authentication behavior.
Public propertyAuthorizationGets the authorization behavior for the service hosted.
Public propertyBaseAddressesGets the base addresses used by the hosted service.
Public propertyChannelDispatchersGets the collection of channel dispatchers used by the service host.
Public propertyCloseTimeoutGets or sets the interval of time allowed for the service host to close.
Public propertyCredentialsGets the credential for the service hosted.
Protected propertyDefaultCloseTimeoutGets the default interval of time allowed for the service host to close. (Overrides CommunicationObject.DefaultCloseTimeout.)
Protected propertyDefaultOpenTimeoutGets the default interval of time allowed for the service host to open. (Overrides CommunicationObject.DefaultOpenTimeout.)
Public propertyDescriptionGets the description of the service hosted.
Public propertyExtensionsGets the extensions for the current specified service host.
Protected propertyImplementedContractsRetrieves the contracts implemented by the service hosted.
Protected propertyIsDisposedGets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public propertyManualFlowControlLimitGets or sets the flow control limit for messages received by the service hosted.
Public propertyOpenTimeoutGets or sets the interval of time allowed for the service host to open.
Public propertyStateGets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected propertyThisLockGets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top

  NameDescription
Public methodAbortCauses a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Protected methodAddBaseAddressAdds a base address to the service host.
Public methodAddDefaultEndpointsAdds service endpoints for all base addresses in each contract found in the service host with the default binding.
Public methodAddServiceEndpoint(ServiceEndpoint)Adds the specified service endpoint to the hosted service.
Public methodAddServiceEndpoint(String, Binding, String)Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address.
Public methodAddServiceEndpoint(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 methodAddServiceEndpoint(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 methodAddServiceEndpoint(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 methodApplyConfigurationLoads the service description information from the configuration file and applies it to the runtime being constructed.
Public methodBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public methodBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public methodClose()Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public methodClose(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 methodCreateDescriptionWhen implemented in a derived class, creates the description of the hosted service.
Public methodEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFaultCauses a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetCommunicationObjectTypeGets the type of communication object. (Inherited from CommunicationObject.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIncrementManualFlowControlLimitIncreases the limit on the flow rate of messages to the hosted service by a specified increment.
Protected methodInitializeDescriptionCreates and initializes the service host with the contract and service descriptions.
Protected methodInitializeRuntimeInitializes the runtime for the service host.
Protected methodLoadConfigurationSectionLoads the service element from the configuration file of the hosted service.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnAbortAborts the service. (Overrides CommunicationObject.OnAbort().)
Protected methodOnBeginCloseBegins an asynchronous operation invoked on the close of the service host. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginOpenBegins an asynchronous operation invoked on the opening of the service host. (Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected methodOnCloseCloses down the hosted service, including their channel dispatchers and associated instance contexts and listeners. (Overrides CommunicationObject.OnClose(TimeSpan).)
Protected methodOnClosedReleases resources used by the service host. (Overrides CommunicationObject.OnClosed().)
Protected methodOnClosingInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodOnEndCloseCompletes an asynchronous operation invoked on the closing of the service host. (Overrides CommunicationObject.OnEndClose(IAsyncResult).)
Protected methodOnEndOpenCompletes an asynchronous operation invoked on the opening of the service host. (Overrides CommunicationObject.OnEndOpen(IAsyncResult).)
Protected methodOnFaultedInserts 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 methodOnOpenOpens the channel dispatchers. (Overrides CommunicationObject.OnOpen(TimeSpan).)
Protected methodOnOpenedGets the service credentials,service authentication and authorization behavior for the hosted service. (Overrides CommunicationObject.OnOpened().)
Protected methodOnOpeningInvoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject.)
Public methodOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public methodOpen(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 methodReleasePerformanceCountersReleases the service and channel dispatcher performance counters for the hosted service.
Public methodSetEndpointAddressSets the endpoint address of the specified endpoint to the specified address.
Protected methodThrowIfDisposedThrows an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrImmutableThrows an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrNotOpenThrows an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventClosedOccurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public eventClosingOccurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public eventFaultedOccurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public eventOpenedOccurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public eventOpeningOccurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Public eventUnknownMessageReceivedOccurs when an unknown message is received.
Top

  NameDescription
Explicit interface implemetationPrivate methodIDisposable.DisposeCloses the service host.
Top

Use the ServiceHostBase class to create hosts that provide a custom programming model. The Windows Communication Foundation (WCF) 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.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft