WorkflowServiceHost Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

System.Object
  System.ServiceModel.Channels.CommunicationObject
    System.ServiceModel.ServiceHostBase
      System.ServiceModel.Activities.WorkflowServiceHost

type WorkflowServiceHost = 
    class
        inherit ServiceHostBase
    end

NameDescription
System_CAPS_protmethodWorkflowServiceHost()

Initializes a new instance of the WorkflowServiceHost class.

System_CAPS_pubmethodWorkflowServiceHost(Activity, Uri[])

Initializes a new instance of the WorkflowServiceHost class using the specified activity and base addresses.

System_CAPS_pubmethodWorkflowServiceHost(Object, Uri[])

Initializes a new instance of the WorkflowServiceHost class using the specified service object and base addresses.

System_CAPS_pubmethodWorkflowServiceHost(WorkflowService, Uri[])

Initializes a new instance of the WorkflowServiceHost class using the specified service definition and collection of base addresses.

NameDescription
System_CAPS_pubpropertyActivity

Gets the root activity of the hosted workflow service.

System_CAPS_pubpropertyAuthentication

Gets the service authentication behavior.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyAuthorization

Gets the authorization behavior for the service hosted.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyBaseAddresses

Gets the base addresses used by the hosted service.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyChannelDispatchers

Gets the collection of channel dispatchers used by the service host.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyCloseTimeout

Gets or sets the interval of time allowed for the service host to close.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyCredentials

Gets the credential for the service hosted.(Inherited from ServiceHostBase.)

System_CAPS_protpropertyDefaultCloseTimeout

Gets the default interval of time allowed for the service host to close.(Inherited from ServiceHostBase.)

System_CAPS_protpropertyDefaultOpenTimeout

Gets the default interval of time allowed for the service host to open.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyDescription

Gets the description of the service hosted.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyDurableInstancingOptions

Gets the DurableInstancingOptions associated with the workflow service host.

System_CAPS_pubpropertyExtensions

Gets the extensions for the current specified service host.(Inherited from ServiceHostBase.)

System_CAPS_protpropertyImplementedContracts

Retrieves the contracts implemented by the service hosted.(Inherited from ServiceHostBase.)

System_CAPS_protpropertyIsDisposed

Gets a value that indicates whether the communication object has been disposed.(Inherited from CommunicationObject.)

System_CAPS_pubpropertyManualFlowControlLimit

Gets or sets the flow control limit for messages received by the service hosted.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyOpenTimeout

Gets or sets the interval of time allowed for the service host to open.(Inherited from ServiceHostBase.)

System_CAPS_pubpropertyState

Gets a value that indicates the current state of the communication object.(Inherited from CommunicationObject.)

System_CAPS_pubpropertySupportedVersions

Gets a list of workflow versions that are supported by this workflow service host.

System_CAPS_protpropertyThisLock

Gets the mutually exclusive lock that protects the class instance during a state transition.(Inherited from CommunicationObject.)

System_CAPS_pubpropertyWorkflowExtensions

Gets a WorkflowInstanceExtensionManager object to add or remove extensions to the workflow service instance.

NameDescription
System_CAPS_pubmethodAbort()

Causes a communication object to transition immediately from its current state into the closing state.(Inherited from CommunicationObject.)

System_CAPS_protmethodAddBaseAddress(Uri)

Adds a base address to the service host.(Inherited from ServiceHostBase.)

System_CAPS_pubmethodAddDefaultEndpoints()

Adds service endpoints for all base addresses in each contract found in the service host with the default binding.(Inherited from ServiceHostBase.)

System_CAPS_pubmethodAddServiceEndpoint(ServiceEndpoint)

Adds a service endpoint to the workflow service host.(Overrides ServiceHostBase.AddServiceEndpoint(ServiceEndpoint).)

System_CAPS_pubmethodAddServiceEndpoint(String, Binding, String)

Adds a service endpoint to the workflow service host using the specified contract, binding, and address.

System_CAPS_pubmethodAddServiceEndpoint(String, Binding, String, Uri)

Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI.

System_CAPS_pubmethodAddServiceEndpoint(String, Binding, Uri)

Adds a service endpoint to the workflow service host using the specified contract, binding, and address.

System_CAPS_pubmethodAddServiceEndpoint(String, Binding, Uri, Uri)

Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI.

System_CAPS_pubmethodAddServiceEndpoint(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.

System_CAPS_pubmethodAddServiceEndpoint(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.

System_CAPS_protmethodApplyConfiguration()

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

System_CAPS_pubmethodBeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.(Inherited from CommunicationObject.)

System_CAPS_pubmethodClose()

Causes a communication object to transition from its current state into the closed state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodClose(TimeSpan)

Causes a communication object to transition from its current state into the closed state within a specified interval of time.(Inherited from CommunicationObject.)

System_CAPS_protmethodCreateDescription(IDictionary<String, ContractDescription>)

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

System_CAPS_pubmethodEndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodEndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFault()

Causes a communication object to transition from its current state into the faulted state.(Inherited from CommunicationObject.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGetCommunicationObjectType()

Gets the type of communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIncrementManualFlowControlLimit(Int32)

Increases the limit on the flow rate of messages to the hosted service by a specified increment.(Inherited from ServiceHostBase.)

System_CAPS_protmethodInitializeDescription(UriSchemeKeyedCollection)

Creates and initializes the service host with the contract and service descriptions.(Inherited from ServiceHostBase.)

System_CAPS_protmethodInitializeRuntime()

Initializes the runtime for the workflow service host.(Overrides ServiceHostBase.InitializeRuntime().)

System_CAPS_protmethodLoadConfigurationSection(ServiceElement)

Loads the service element from the configuration file of the hosted service.(Inherited from ServiceHostBase.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnAbort()

Called when the workflow service host is aborted.(Overrides ServiceHostBase.OnAbort().)

System_CAPS_protmethodOnBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation invoked when the workflow service host is closed.(Overrides ServiceHostBase.OnBeginClose(TimeSpan, AsyncCallback, Object).)

System_CAPS_protmethodOnBeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation invoked on the opening of the service host.(Inherited from ServiceHostBase.)

System_CAPS_protmethodOnClose(TimeSpan)

Closes down the hosted service, including the channel dispatchers and associated instance contexts and listeners.(Overrides ServiceHostBase.OnClose(TimeSpan).)

System_CAPS_protmethodOnClosed()

Releases resources used by the service host.(Inherited from ServiceHostBase.)

System_CAPS_protmethodOnClosing()

Invoked during the transition of a communication object into the closing state.(Inherited from CommunicationObject.)

System_CAPS_protmethodOnEndClose(IAsyncResult)

Completes an asynchronous operation invoked when the workflow service host is closed.(Overrides ServiceHostBase.OnEndClose(IAsyncResult).)

System_CAPS_protmethodOnEndOpen(IAsyncResult)

Completes an asynchronous operation invoked on the opening of the service host.(Inherited from ServiceHostBase.)

System_CAPS_protmethodOnFaulted()

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

System_CAPS_protmethodOnOpen(TimeSpan)

Opens the channel dispatchers.(Inherited from ServiceHostBase.)

System_CAPS_protmethodOnOpened()

Gets the service credentials,service authentication and authorization behavior for the hosted service.(Inherited from ServiceHostBase.)

System_CAPS_protmethodOnOpening()

Invoked during the transition of a communication object into the opening state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodOpen()

Causes a communication object to transition from the created state into the opened state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodOpen(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.(Inherited from CommunicationObject.)

System_CAPS_protmethodReleasePerformanceCounters()

Releases the service and channel dispatcher performance counters for the hosted service.(Inherited from ServiceHostBase.)

System_CAPS_pubmethodSetEndpointAddress(ServiceEndpoint, String)

Sets the endpoint address of the specified endpoint to the specified address.(Inherited from ServiceHostBase.)

System_CAPS_protmethodThrowIfDisposed()

Throws an exception if the communication object is disposed.(Inherited from CommunicationObject.)

System_CAPS_protmethodThrowIfDisposedOrImmutable()

Throws an exception if the communication object the State property is not set to the Created state.(Inherited from CommunicationObject.)

System_CAPS_protmethodThrowIfDisposedOrNotOpen()

Throws an exception if the communication object is not in the Opened state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventClosed

Occurs when a communication object transitions into the closed state.(Inherited from CommunicationObject.)

System_CAPS_pubeventClosing

Occurs when a communication object transitions into the closing state.(Inherited from CommunicationObject.)

System_CAPS_pubeventFaulted

Occurs when a communication object transitions into the faulted state.(Inherited from CommunicationObject.)

System_CAPS_pubeventOpened

Occurs when a communication object transitions into the opened state.(Inherited from CommunicationObject.)

System_CAPS_pubeventOpening

Occurs when a communication object transitions into the opening state.(Inherited from CommunicationObject.)

System_CAPS_pubeventUnknownMessageReceived

Occurs when an unknown message is received.(Inherited from ServiceHostBase.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable.Dispose()

Closes the service host. (Inherited from ServiceHostBase.)

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
Available since 4.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: