MKS.KeyedLocking.Redis 1.0.0

dotnet add package MKS.KeyedLocking.Redis --version 1.0.0
                    
NuGet\Install-Package MKS.KeyedLocking.Redis -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="MKS.KeyedLocking.Redis" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MKS.KeyedLocking.Redis" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="MKS.KeyedLocking.Redis" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MKS.KeyedLocking.Redis --version 1.0.0
                    
#r "nuget: MKS.KeyedLocking.Redis, 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.
#:package MKS.KeyedLocking.Redis@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MKS.KeyedLocking.Redis&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=MKS.KeyedLocking.Redis&version=1.0.0
                    
Install as a Cake Tool

MKS.KeyedLocking.Redis

Distributed keyed locking via Redis using StackExchange.Redis.

Features

  • LockTake / LockRelease / LockExtend - Idiomatic StackExchange.Redis lock APIs
  • Automatic TTL renewal - Background timer extends the lock while held
  • Polling-based wait - Configurable retry interval when the lock is busy
  • Dead lock cleanup - Keys expire by TTL if the process crashes
  • DI integration - AddRedisKeyedLock() extension method

Installation

dotnet add package MKS.KeyedLocking.Redis

Dependency Injection

builder.Services.AddSingleton<IConnectionMultiplexer>(_ =>
    ConnectionMultiplexer.Connect("localhost:6379"));

builder.Services.AddRedisKeyedLock(options =>
{
    options.LockTtl = TimeSpan.FromSeconds(30);
    options.RetryInterval = TimeSpan.FromMilliseconds(100);
});

Usage

public class PaymentService(IKeyedLockService lockService)
{
    public async Task ProcessPaymentAsync(string paymentId, CancellationToken cancellationToken)
    {
        await using (await lockService.AcquireAsync($"payment:{paymentId}", TimeSpan.FromSeconds(10), cancellationToken))
        {
            // critical section - coordinated across all application instances
        }
    }
}

Composite Decorator

When multiple threads in the same process contend for the same key, wrap with the composite decorator to reduce Redis polling:

services.AddRedisKeyedLock()
        .AddCompositeKeyedLock();

Notes

  • Register IConnectionMultiplexer and IKeyedLockService as Singleton
  • For multi-master Redis clusters with strict safety requirements, consider RedLock.net
  • Single Redis or Sentinel deployments are well served by this implementation

Requirements

  • .NET 10.0
  • StackExchange.Redis
  • MKS.KeyedLocking.Abstractions 1.0.0+
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 130 7/6/2026

Version 1.0.0: Initial release.
      RedisKeyedLockService with AddRedisKeyedLock DI extension.