DistributedLeaseManager.AzureBlobStorage

DistributedLeaseManager.AzureBlobStorage

Description

A simple C#/.NET distributed lease/lock manager (DLM) implementation.

Inspired by the https://github.com/fbeltrao/azfunctions-distributed-locking

This library contains a lease storage implemented using the Azure Blob Storage.

Usage

1. (Optionally) Register your Azure Blob Client in the DI container

2. Register the Distributed Lease Manager in the DI container:

   builder.Services.AddBlobStorageDistributedLeaseManager("distributed-leases-container");

   or specify the Blob Storage connection string in case you skipped the first step:

   builder.Services.AddBlobStorageDistributedLeaseManager("connection-string", "distributed-leases-container");

3. Inside your controller/service inject the IDistributedLeaseManager and call the TryAcquireLease method. Verify if the result was successful - if it was then you can proceed with the operation; otherwise, someone else has acquired the lease:

   await using var leaseResult = await leaseManager.TryAcquireLease(resourceId, TimeSpan.FromSeconds(5));
   
   if (!leaseResult.IsSuccessful)
   {
       // Someone else has required the lease for the resource.
       // You may want to either retry the acqusition or abort the operation.
   }
   else
   {
       // You are the lease owner now and can safely process the resource.
       // The lease will be released either when the leaseResult gets disposed
       // or when the lease expires (in the example above, in 5 seconds)
   }