ServiceHostBase ServiceHostBase ServiceHostBase ServiceHostBase Class

Definition

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

public ref class ServiceHostBase abstract : System::ServiceModel::Channels::CommunicationObject, IDisposable, System::ServiceModel::IExtensibleObject<System::ServiceModel::ServiceHostBase ^>
public abstract class ServiceHostBase : System.ServiceModel.Channels.CommunicationObject, IDisposable, System.ServiceModel.IExtensibleObject<System.ServiceModel.ServiceHostBase>
type ServiceHostBase = class
    inherit CommunicationObject
    interface IExtensibleObject<ServiceHostBase>
    interface IDisposable
Public MustInherit Class ServiceHostBase
Inherits CommunicationObject
Implements IDisposable, IExtensibleObject(Of ServiceHostBase)
Inheritance
Derived
Implements

Examples

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

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.

Constructors

ServiceHostBase() ServiceHostBase() ServiceHostBase() ServiceHostBase()

Initializes a new instance of the ServiceHostBase class.

Properties

Authentication Authentication Authentication Authentication

Gets the service authentication behavior.

Authorization Authorization Authorization Authorization

Gets the authorization behavior for the service hosted.

BaseAddresses BaseAddresses BaseAddresses BaseAddresses

Gets the base addresses used by the hosted service.

ChannelDispatchers ChannelDispatchers ChannelDispatchers ChannelDispatchers

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

CloseTimeout CloseTimeout CloseTimeout CloseTimeout

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

Credentials Credentials Credentials Credentials

Gets the credential for the service hosted.

DefaultCloseTimeout DefaultCloseTimeout DefaultCloseTimeout DefaultCloseTimeout

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

DefaultOpenTimeout DefaultOpenTimeout DefaultOpenTimeout DefaultOpenTimeout

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

Description Description Description Description

Gets the description of the service hosted.

Extensions Extensions Extensions Extensions

Gets the extensions for the current specified service host.

ImplementedContracts ImplementedContracts ImplementedContracts ImplementedContracts

Retrieves the contracts implemented by the service hosted.

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.

OpenTimeout OpenTimeout OpenTimeout OpenTimeout

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

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)

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.

AddDefaultEndpoints() AddDefaultEndpoints() AddDefaultEndpoints() AddDefaultEndpoints()

Adds service endpoints for all base addresses in each contract found in the service host with the default binding.

AddServiceEndpoint(ServiceEndpoint) AddServiceEndpoint(ServiceEndpoint) AddServiceEndpoint(ServiceEndpoint) AddServiceEndpoint(ServiceEndpoint)

Adds the specified service endpoint to the hosted service.

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.

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.

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.

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.

ApplyConfiguration() ApplyConfiguration() ApplyConfiguration() ApplyConfiguration()

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

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>)

When implemented in a derived class, creates the description of the hosted service.

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.

InitializeDescription(UriSchemeKeyedCollection) InitializeDescription(UriSchemeKeyedCollection) InitializeDescription(UriSchemeKeyedCollection) InitializeDescription(UriSchemeKeyedCollection)

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

InitializeRuntime() InitializeRuntime() InitializeRuntime() InitializeRuntime()

Initializes the runtime for the service host.

LoadConfigurationSection(ServiceElement) LoadConfigurationSection(ServiceElement) LoadConfigurationSection(ServiceElement) LoadConfigurationSection(ServiceElement)

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

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

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

Aborts the service.

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.

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.

OnClose(TimeSpan) OnClose(TimeSpan) OnClose(TimeSpan) OnClose(TimeSpan)

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

OnClosed() OnClosed() OnClosed() OnClosed()

Releases resources used by the service host.

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.

OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult)

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

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.

OnOpened() OnOpened() OnOpened() OnOpened()

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

OnOpening() OnOpening() OnOpening() OnOpening()

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

(Inherited from CommunicationObject)
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.

SetEndpointAddress(ServiceEndpoint, String) SetEndpointAddress(ServiceEndpoint, String) SetEndpointAddress(ServiceEndpoint, String) SetEndpointAddress(ServiceEndpoint, String)

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

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.

Explicit Interface Implementations

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

Closes the service host.

Applies to