DistributedLeaseManager.EntityFrameworkCore 1.0.0

dotnet add package DistributedLeaseManager.EntityFrameworkCore --version 1.0.0
NuGet\Install-Package DistributedLeaseManager.EntityFrameworkCore -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DistributedLeaseManager.EntityFrameworkCore" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DistributedLeaseManager.EntityFrameworkCore --version 1.0.0
#r "nuget: DistributedLeaseManager.EntityFrameworkCore, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DistributedLeaseManager.EntityFrameworkCore as a Cake Addin
#addin nuget:?package=DistributedLeaseManager.EntityFrameworkCore&version=1.0.0

// Install DistributedLeaseManager.EntityFrameworkCore as a Cake Tool
#tool nuget:?package=DistributedLeaseManager.EntityFrameworkCore&version=1.0.0

DistributedLeaseManager.EntityFrameworkCore

NuGet

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 Entity Framework Core.

Usage

  1. Register the Distributed Lease Manager in the DI container using the EF Core database provider of your choice:

    builder.Services.AddEfCoreDistributedLeaseManager(builder =>
        builder.UseSqlServer("Server=(localdb)\\MSSQLLocalDB;Integrated Security=true;Database=DatabaseName",
            options => options.MigrationsAssembly(Assembly.GetExecutingAssembly().FullName)),
        "DistributedLeases");
    
  2. Add and apply a database migration:

    dotnet ef migrations add InitDistributedLeasesTable
    dotnet ef database update
    
  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)
    }
    
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 243 10/21/2023