SqlWorkflowInstanceStore.HostLockRenewalPeriod SqlWorkflowInstanceStore.HostLockRenewalPeriod SqlWorkflowInstanceStore.HostLockRenewalPeriod SqlWorkflowInstanceStore.HostLockRenewalPeriod Property


Specifies the time period within which the host renews its lock on a workflow service instance.

 property TimeSpan HostLockRenewalPeriod { TimeSpan get(); void set(TimeSpan value); };
public TimeSpan HostLockRenewalPeriod { get; set; }
member this.HostLockRenewalPeriod : TimeSpan with get, set
Public Property HostLockRenewalPeriod As TimeSpan

Property Value

The time period.


The following code sample demonstrates using HostLockRenewalPeriod in a SqlWorkflowInstanceStore. This example is from the Built-in Configuration sample.

static void Main(string[] args)
    // Create service host.
    WorkflowServiceHost host = new WorkflowServiceHost(new CountingWorkflow(), new Uri(hostBaseAddress));

    // Add service endpoint.
    host.AddServiceEndpoint("ICountingWorkflow", new BasicHttpBinding(), "");

    // Define SqlWorkflowInstanceStoreBehavior:
    //   Set interval to renew instance lock to 5 seconds.
    //   Set interval to check for runnable instances to 2 seconds.
    //   Instance Store does not keep instances after it is completed.
    //   Select exponential back-off algorithm when retrying to load a locked instance.
    //   Instance state information is compressed using the GZip compressing algorithm. 
    SqlWorkflowInstanceStoreBehavior instanceStoreBehavior = new SqlWorkflowInstanceStoreBehavior(connectionString);
    instanceStoreBehavior.HostLockRenewalPeriod = new TimeSpan(0, 0, 5);
    instanceStoreBehavior.RunnableInstancesDetectionPeriod = new TimeSpan(0, 0, 2);
    instanceStoreBehavior.InstanceCompletionAction = InstanceCompletionAction.DeleteAll;
    instanceStoreBehavior.InstanceLockedExceptionAction = InstanceLockedExceptionAction.AggressiveRetry;
    instanceStoreBehavior.InstanceEncodingOption = InstanceEncodingOption.GZip;

    // Open service host.

    // Create a client that sends a message to create an instance of the workflow.
    ICountingWorkflow client = ChannelFactory<ICountingWorkflow>.CreateChannel(new BasicHttpBinding(), new EndpointAddress(hostBaseAddress));

    Console.WriteLine("(Press [Enter] at any time to terminate host)");


If the host does not renew the lock (in other words, extend the lease) with this in this time period, the persistence provider unlocks the instance and another host may lock the instance. The value is a TimeSpan of the form "hh:mm:ss". The minimum permitted value is "00:00:01" (1 sec). The default value of this property is "00:00:30" (30 seconds).

Applies to