WorkflowServiceHost Class
Definition
Provides a host for workflows. Supports features like messaging activities, multi-instancing, and configuration.
public ref class WorkflowServiceHost : System::ServiceModel::ServiceHostBase
public class WorkflowServiceHost : System.ServiceModel.ServiceHostBase
type WorkflowServiceHost = class
inherit ServiceHostBase
Public Class WorkflowServiceHost
Inherits ServiceHostBase
- Inheritance
Examples
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();
}
Constructors
WorkflowServiceHost() |
Initializes a new instance of the WorkflowServiceHost class. |
WorkflowServiceHost(Activity, Uri[]) |
Initializes a new instance of the WorkflowServiceHost class using the specified activity and base addresses. |
WorkflowServiceHost(Object, Uri[]) |
Initializes a new instance of the WorkflowServiceHost class using the specified service object and base addresses. |
WorkflowServiceHost(WorkflowService, Uri[]) |
Initializes a new instance of the WorkflowServiceHost class using the specified service definition and collection of base addresses. |
Properties
Activity |
Gets the root activity of the hosted workflow service. |
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) |
DurableInstancingOptions |
Gets the DurableInstancingOptions associated with the workflow service host. |
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) |
SupportedVersions |
Gets a list of workflow versions that are supported by this workflow service host. |
ThisLock |
Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject) |
WorkflowExtensions |
Gets a WorkflowInstanceExtensionManager object to add or remove extensions to the workflow service instance. |
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 a service endpoint to the workflow service host. |
AddServiceEndpoint(String, Binding, String) |
Adds a service endpoint to the workflow service host using the specified contract, binding, and address. |
AddServiceEndpoint(String, Binding, String, Uri) |
Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI. |
AddServiceEndpoint(String, Binding, Uri) |
Adds a service endpoint to the workflow service host using the specified contract, binding, and address. |
AddServiceEndpoint(String, Binding, Uri, Uri) |
Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI. |
AddServiceEndpoint(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. |
AddServiceEndpoint(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. |
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 service description of the hosted workflow service using the specified key/value pair collection of address, binding, contract and behavior service endpoint information. |
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 workflow service host. |
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() |
Called when the workflow service host is aborted. |
OnBeginClose(TimeSpan, AsyncCallback, Object) |
Begins an asynchronous operation invoked when the workflow service host is closed. |
OnBeginOpen(TimeSpan, AsyncCallback, Object) |
Begins an asynchronous operation invoked when the workflow service host is opened. |
OnClose(TimeSpan) |
Closes down the hosted service, including the channel dispatchers and associated instance contexts and listeners. |
OnClosed() |
Releases resources used by the service host. (Inherited from ServiceHostBase) |
OnClosing() |
Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject) |
OnEndClose(IAsyncResult) |
Completes an asynchronous operation invoked when the workflow service host is closed. |
OnEndOpen(IAsyncResult) |
Completes an asynchronous operation invoked when the workflow service host is opened. |
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. |
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) |