WorkflowServiceHost Class

Reference

Definition

Namespace:: System.ServiceModel

Assembly:: System.WorkflowServices.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

The WF3 types are deprecated. Instead, please use the new WF4 types from System.Activities.*

Provides host for workflow-based services.

public ref class WorkflowServiceHost : System::ServiceModel::ServiceHostBase

public class WorkflowServiceHost : System.ServiceModel.ServiceHostBase

[System.Obsolete("The WF3 types are deprecated.  Instead, please use the new WF4 types from System.Activities.*")]
public class WorkflowServiceHost : System.ServiceModel.ServiceHostBase

type WorkflowServiceHost = class
    inherit ServiceHostBase

[<System.Obsolete("The WF3 types are deprecated.  Instead, please use the new WF4 types from System.Activities.*")>]
type WorkflowServiceHost = class
    inherit ServiceHostBase

Public Class WorkflowServiceHost
Inherits ServiceHostBase

Inheritance: Object

CommunicationObject

ServiceHostBase
WorkflowServiceHost

Attributes: ObsoleteAttribute

Remarks

Implements the host used by the Windows Communication Foundation (WCF) service model programming model.

Use the WorkflowServiceHost class to configure and expose a workflow as service for use by client applications when you are not using Internet Information Services (IIS) or Windows Activation Services (WAS) to expose a service. Both IIS and WAS interact with a WorkflowServiceHost object on your behalf.

To expose a workflow as service for use by callers, WCF requires a complete service description (represented by the ServiceDescription class). The WorkflowServiceHost class creates a ServiceDescription from the workflow service type and configuration information and then uses that description to create ChannelDispatcher objects for each endpoint in the description.

Use a WorkflowServiceHost object to load a workflow service, configure endpoints, apply security settings, and start listeners to handle incoming requests.

Constructors

WorkflowServiceHost()	Initializes a new instance of the WorkflowServiceHost class.
WorkflowServiceHost(Stream, Stream, ITypeProvider, Uri[])	Initializes a new instance of the WorkflowServiceHost class using a byte stream that contains the workflow definition, a byte stream that contains the workflow rules definition, a type provider for custom activity types, and the base addresses of the service specified.
WorkflowServiceHost(Stream, Stream, Uri[])	Initializes a new instance of the WorkflowServiceHost class using a byte stream that contains the workflow definition, a byte stream that contains the workflow rules definition, and the base addresses of the service specified.
WorkflowServiceHost(Stream, Uri[])	Initializes a new instance of the WorkflowServiceHost class using a byte stream that contains the workflow definition and the base addresses of the service specified.
WorkflowServiceHost(String, String, ITypeProvider, Uri[])	Initializes a new instance of the WorkflowServiceHost class using a path to the workflow definition, a path to the workflow rules definition, a type provider for custom activity types, and the base addresses of the service specified.
WorkflowServiceHost(String, String, Uri[])	Initializes a new instance of the WorkflowServiceHost class using a path to the workflow definition, a path to the workflow rules definition, and the base addresses of the service specified.
WorkflowServiceHost(String, Uri[])	Initializes a new instance of the WorkflowServiceHost class using a path to the workflow definition and the base addresses of the service specified.
WorkflowServiceHost(Type, Uri[])	Initializes a new instance of the WorkflowServiceHost class using a workflow type and the base addresses of the service specified.

Properties

Authentication	Gets the service authentication behavior. (Inherited from ServiceHostBase)
Authorization	Gets the authorization behavior for the service hosted. (Inherited from ServiceHostBase)
BaseAddresses	Gets the base addresses used by the hosted service. (Inherited from ServiceHostBase)
ChannelDispatchers	Gets the collection of channel dispatchers used by the service host. (Inherited from ServiceHostBase)
CloseTimeout	Gets or sets the interval of time allowed for the service host to close. (Inherited from ServiceHostBase)
Credentials	Gets the credential for the service hosted. (Inherited from ServiceHostBase)
DefaultCloseTimeout	Gets the default interval of time allowed for the service host to close. (Inherited from ServiceHostBase)
DefaultOpenTimeout	Gets the default interval of time allowed for the service host to open. (Inherited from ServiceHostBase)
Description	Gets the description of the service hosted. (Inherited from ServiceHostBase)
Extensions	Gets the extensions for the current specified service host. (Inherited from ServiceHostBase)
ImplementedContracts	Retrieves the contracts implemented by the service hosted. (Inherited from ServiceHostBase)
IsDisposed	Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject)
ManualFlowControlLimit	Gets or sets the flow control limit for messages received by the service hosted. (Inherited from ServiceHostBase)
OpenTimeout	Gets or sets the interval of time allowed for the service host to open. (Inherited from ServiceHostBase)
State	Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject)
ThisLock	Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject)
AddBaseAddress(Uri)	Adds a base address to the service host. (Inherited from ServiceHostBase)
AddDefaultEndpoints()	Adds service endpoints for all base addresses in each contract found in the service host with the default binding. (Inherited from ServiceHostBase)
AddServiceEndpoint(ServiceEndpoint)	Adds the specified service endpoint to the hosted service. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, String)	Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address. (Inherited from ServiceHostBase)
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. (Inherited from ServiceHostBase)
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. (Inherited from ServiceHostBase)
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. (Inherited from ServiceHostBase)
AddServiceEndpoint(Type, Binding, String)	Adds a service endpoint for the workflow service using the specified contract, binding, and endpoint address.
AddServiceEndpoint(Type, Binding, String, Uri)	Adds a service endpoint to the workflow service with a specified contract, a binding, an endpoint address, and a URI on which the service listens.
AddServiceEndpoint(Type, Binding, Uri)	Adds a service endpoint to the workflow service with a specified contract, binding, and URI that contains the endpoint address.
AddServiceEndpoint(Type, Binding, Uri, Uri)	Adds a service endpoint to the workflow service with a specified contract, a binding, a URI that contains the endpoint address, and a URI on which the service listens.
ApplyConfiguration()	Loads the service description information from the configuration file and applies it to the runtime being constructed. (Inherited from ServiceHostBase)
BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject)
Close()	Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject)
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>)	Creates a description of the workflow service.
EndClose(IAsyncResult)	Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
EndOpen(IAsyncResult)	Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Fault()	Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject)
GetCommunicationObjectType()	Gets the type of communication object. (Inherited from CommunicationObject)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IncrementManualFlowControlLimit(Int32)	Increases the limit on the flow rate of messages to the hosted service by a specified increment. (Inherited from ServiceHostBase)
InitializeDescription(UriSchemeKeyedCollection)	Creates and initializes the service host with the contract and service descriptions. (Inherited from ServiceHostBase)
InitializeRuntime()	Initializes the runtime for the service host. (Inherited from ServiceHostBase)
LoadConfigurationSection(ServiceElement)	Loads the service element from the configuration file of the hosted service. (Inherited from ServiceHostBase)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Aborts the service. (Inherited from ServiceHostBase)
OnBeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation invoked on the close of the service host. (Inherited from ServiceHostBase)
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation invoked on the opening of the service host. (Inherited from ServiceHostBase)
OnClose(TimeSpan)	Closes down the hosted service, including their channel dispatchers and associated instance contexts and listeners. (Inherited from ServiceHostBase)
OnCloseAsync(TimeSpan)	(Inherited from CommunicationObject)
OnClosed()	Releases resources used by the service host. (Inherited from ServiceHostBase)
OnClosing()	This method is called before the WorkflowServiceHost is put into a closing state.
OnEndClose(IAsyncResult)	Completes an asynchronous operation invoked on the closing of the service host. (Inherited from ServiceHostBase)
OnEndOpen(IAsyncResult)	Completes an asynchronous operation invoked on the opening of the service host. (Inherited from ServiceHostBase)
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)	Opens the channel dispatchers. (Inherited from ServiceHostBase)
OnOpenAsync(TimeSpan)	(Inherited from CommunicationObject)
OnOpened()	Gets the service credentials,service authentication and authorization behavior for the hosted service. (Inherited from ServiceHostBase)
OnOpening()	Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject)
Open()	Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject)
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()	Releases the service and channel dispatcher performance counters for the hosted service. (Inherited from ServiceHostBase)
SetEndpointAddress(ServiceEndpoint, String)	Sets the endpoint address of the specified endpoint to the specified address. (Inherited from ServiceHostBase)
ThrowIfDisposed()	Throws an exception if the communication object is disposed. (Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable()	Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen()	Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

Closed	Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject)
Closing	Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject)
Faulted	Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject)
Opened	Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject)
Opening	Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject)
UnknownMessageReceived	Occurs when an unknown message is received. (Inherited from ServiceHostBase)

Explicit Interface Implementations

IDisposable.Dispose()

Closes the service host.

(Inherited from ServiceHostBase)

Applies to