Export (0) Print
Expand All

WorkflowServiceHost Class

Provides a host for workflows. Supports features like messaging activities, multi-instancing, and configuration.

Namespace:  System.ServiceModel.Activities
Assembly:  System.ServiceModel.Activities (in System.ServiceModel.Activities.dll)

public class WorkflowServiceHost : ServiceHostBase

The WorkflowServiceHost type exposes the following members.

  NameDescription
Protected methodWorkflowServiceHost()Initializes a new instance of the WorkflowServiceHost class.
Public methodWorkflowServiceHost(Activity, Uri[])Initializes a new instance of the WorkflowServiceHost class using the specified activity and base addresses.
Public methodWorkflowServiceHost(Object, Uri[])Initializes a new instance of the WorkflowServiceHost class using the specified service object and base addresses.
Public methodWorkflowServiceHost(WorkflowService, Uri[])Initializes a new instance of the WorkflowServiceHost class using the specified service definition and collection of base addresses.
Top

  NameDescription
Public propertyActivityGets the root activity of the hosted workflow service.
Public propertyAuthenticationGets the service authentication behavior. (Inherited from ServiceHostBase.)
Public propertyAuthorizationGets the authorization behavior for the service hosted. (Inherited from ServiceHostBase.)
Public propertyBaseAddressesGets the base addresses used by the hosted service. (Inherited from ServiceHostBase.)
Public propertyChannelDispatchersGets the collection of channel dispatchers used by the service host. (Inherited from ServiceHostBase.)
Public propertyCloseTimeoutGets or sets the interval of time allowed for the service host to close. (Inherited from ServiceHostBase.)
Public propertyCredentialsGets the credential for the service hosted. (Inherited from ServiceHostBase.)
Protected propertyDefaultCloseTimeoutGets the default interval of time allowed for the service host to close. (Inherited from ServiceHostBase.)
Protected propertyDefaultOpenTimeoutGets the default interval of time allowed for the service host to open. (Inherited from ServiceHostBase.)
Public propertyDescriptionGets the description of the service hosted. (Inherited from ServiceHostBase.)
Public propertyDurableInstancingOptionsGets the DurableInstancingOptions associated with the workflow service host.
Public propertyExtensionsGets the extensions for the current specified service host. (Inherited from ServiceHostBase.)
Protected propertyImplementedContractsRetrieves the contracts implemented by the service hosted. (Inherited from ServiceHostBase.)
Protected propertyIsDisposedGets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public propertyManualFlowControlLimitGets or sets a limit on the number of messages that can be processed by the instance context. (Inherited from ServiceHostBase.)
Public propertyOpenTimeoutGets or sets the interval of time allowed for the service host to open. (Inherited from ServiceHostBase.)
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.)
Public propertyWorkflowExtensionsGets a WorkflowInstanceExtensionManager object to add or remove extensions to the workflow service instance.
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. (Inherited from ServiceHostBase.)
Public methodAddDefaultEndpointsAdds service endpoints for all base addresses in each contract found in the service host with the default binding. (Inherited from ServiceHostBase.)
Public methodAddServiceEndpoint(ServiceEndpoint)Adds a service endpoint to the workflow service host. (Overrides ServiceHostBase.AddServiceEndpoint(ServiceEndpoint).)
Public methodAddServiceEndpoint(String, Binding, String)Adds a service endpoint to the workflow service host using the specified contract, binding, and address.
Public methodAddServiceEndpoint(String, Binding, Uri)Adds a service endpoint to the workflow service host using the specified contract, binding, and address.
Public methodAddServiceEndpoint(String, Binding, String, Uri)Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI.
Public methodAddServiceEndpoint(String, Binding, Uri, Uri)Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI.
Public methodAddServiceEndpoint(XName, Binding, String, Uri, String)Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, listen URI, and behavior configuration name.
Public methodAddServiceEndpoint(XName, Binding, Uri, Uri, String)Adds a service endpoint to the workflow service host using the specified implemented contract, binding, endpoint address, listen URI, and a behavior configuration name.
Protected methodApplyConfigurationLoads the service description information from the configuration file and applies it to the runtime being constructed. (Inherited from ServiceHostBase.)
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 methodCreateDescriptionCreates a service description of the hosted workflow service using the specified key/value pair collection of address, binding, contract and behavior service endpoint information. (Overrides ServiceHostBase.CreateDescription(IDictionary<String, ContractDescription>).)
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 a hash function for a particular type. (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. (Inherited from ServiceHostBase.)
Protected methodInitializeDescriptionCreates and initializes the service host with the contract and service descriptions. (Inherited from ServiceHostBase.)
Protected methodInitializeRuntimeInitializes the runtime for the workflow service host. (Overrides ServiceHostBase.InitializeRuntime().)
Protected methodLoadConfigurationSectionLoads the service element from the configuration file of the hosted service. (Inherited from ServiceHostBase.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnAbortCalled when the workflow service host is aborted. (Overrides ServiceHostBase.OnAbort().)
Protected methodOnBeginCloseBegins an asynchronous operation invoked when the workflow service host is closed. (Overrides ServiceHostBase.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginOpenBegins an asynchronous operation invoked when the workflow service host is opened. (Overrides ServiceHostBase.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected methodOnCloseCloses down the hosted service, including the channel dispatchers and associated instance contexts and listeners. (Overrides ServiceHostBase.OnClose(TimeSpan).)
Protected methodOnClosedReleases resources used by the service host. (Inherited from ServiceHostBase.)
Protected methodOnClosingInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodOnEndCloseCompletes an asynchronous operation invoked when the workflow service host is closed. (Overrides ServiceHostBase.OnEndClose(IAsyncResult).)
Protected methodOnEndOpenCompletes an asynchronous operation invoked when the workflow service host is opened. (Overrides ServiceHostBase.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 ServiceHostBase.OnOpen(TimeSpan).)
Protected methodOnOpenedGets the service credentials,service authentication and authorization behavior for the hosted service. (Inherited from ServiceHostBase.)
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. (Inherited from ServiceHostBase.)
Public methodSetEndpointAddressSets the endpoint address of the specified endpoint to the specified address. (Inherited from ServiceHostBase.)
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. (Inherited from ServiceHostBase.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDisposable.DisposeCloses the service host. (Inherited from ServiceHostBase.)
Top

The following example shows how to use the WorkflowServiceHost class.


Console.WriteLine("Starting up...");
WorkflowService service = CreateService();
Uri address = new Uri(Constants.ServiceBaseAddress);
WorkflowServiceHost host = new WorkflowServiceHost(service, address);

try
{
    Console.WriteLine("Opening service...");
    host.Open();

    Console.WriteLine("Service is listening on {0}...", address);
    Console.WriteLine("To terminate press ENTER");
    Console.ReadLine();
}
catch (Exception ex)
{
    Console.WriteLine("Service terminated with exception {0}", ex.ToString());
}
finally
{
    host.Close();
}


.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

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.

Community Additions

ADD
Show:
© 2014 Microsoft