WorkflowCommitWorkBatchService Class

Definition

public ref class WorkflowCommitWorkBatchService abstract : System::Workflow::Runtime::Hosting::WorkflowRuntimeService

public abstract class WorkflowCommitWorkBatchService : System.Workflow.Runtime.Hosting.WorkflowRuntimeService

[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public abstract class WorkflowCommitWorkBatchService : System.Workflow.Runtime.Hosting.WorkflowRuntimeService

type WorkflowCommitWorkBatchService = class
    inherit WorkflowRuntimeService

[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type WorkflowCommitWorkBatchService = class
    inherit WorkflowRuntimeService

Public MustInherit Class WorkflowCommitWorkBatchService
Inherits WorkflowRuntimeService

Inheritance

Object

WorkflowRuntimeService

WorkflowCommitWorkBatchService

Derived

System.Workflow.Runtime.Hosting.DefaultWorkflowCommitWorkBatchService

System.Workflow.Runtime.Hosting.SharedConnectionWorkflowCommitWorkBatchService

Attributes

ObsoleteAttribute

Examples

The following example demonstrates a class that inherits from WorkflowCommitWorkBatchService.

//Implementation of the abstract WorkflowCommitWorkBatchService class
class DefaultCommitWorkBatchService : WorkflowCommitWorkBatchService
{
    protected override void CommitWorkBatch(CommitWorkBatchCallback commitWorkBatchCallback)
    {
        // Call base implementation
        try
        {
            base.CommitWorkBatch(commitWorkBatchCallback);
        }
        catch (Exception e)
        {
            // Report work batch commit failures
            Console.WriteLine("Work batch failed: " + e.Message.ToString());
            throw;
        }
    }
}

'Implementation of the abstract WorkflowCommitWorkBatchService class
Class DefaultCommitWorkBatchService
    Inherits WorkflowCommitWorkBatchService

    Protected Overrides Sub CommitWorkBatch(ByVal commitWorkBatchCallback As CommitWorkBatchCallback)
        ' Call base implementation
        Try
            MyBase.CommitWorkBatch(commitWorkBatchCallback)
        Catch e As Exception
            ' Report work batch commit failures
            Console.WriteLine("Work batch failed: " + e.Message.ToString())
            Throw
        End Try
    End Sub
End Class

Remarks

When a work batch is committed the runtime calls into the WorkflowCommitWorkBatchService and gives it a delegate to call to do the actual committing of the work batch. The runtime still has the primary responsibility of committing the work batch but allows the WorkflowCommitWorkBatchService to insert itself in the process for customization around the commit process.

This process allows custom error handling logic. If the WorkflowCommitWorkBatchService owns the transaction, which is the case when the Transaction.Current property returns null therefore necessitating the need to create a new ambient transaction, it is allowed to call the delegate more than once, creating a new transaction for each call. The most common case for this for example is to handle intermittent network problems or SQL cluster failovers. If the call to the WorkflowCommitWorkBatchService.CommitWorkBatchCallback throws an exception WorkflowCommitWorkBatchService can catch this exception, start a new transaction and call the delegate again. This gives a level of resilience to workflow instance execution that otherwise would cause workflows to terminate.

Constructors

Properties

Methods

Applies to