AsyncKeyedLock 3.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package AsyncKeyedLock --version 3.0.0
                    
NuGet\Install-Package AsyncKeyedLock -Version 3.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="AsyncKeyedLock" Version="3.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AsyncKeyedLock" Version="3.0.0" />
                    
Directory.Packages.props
<PackageReference Include="AsyncKeyedLock" />
                    
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 AsyncKeyedLock --version 3.0.0
                    
#r "nuget: AsyncKeyedLock, 3.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 AsyncKeyedLock@3.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=AsyncKeyedLock&version=3.0.0
                    
Install as a Cake Addin
#tool nuget:?package=AsyncKeyedLock&version=3.0.0
                    
Install as a Cake Tool

AsyncKeyedLock AsyncKeyedLock

GitHub Workflow Status Nuget Nuget

An asynchronous .NET Standard 2.0 library that allows you to lock based on a key (keyed semaphores), only allowing a defined number of concurrent threads that share the same key.

For example, if you're processing transactions, you may want to limit to only one transaction per user so that the order is maintained, but meanwhile allowing parallel processing of multiple users.

Installation

The recommended means is to use NuGet, but you could also download the source code from here.

Usage

var asyncKeyedLocker = new AsyncKeyedLocker();
using (var lockObj = await asyncKeyedLocker.LockAsync(myObject))
{
	...
}

You can also set the maximum number of requests for the semaphore that can be granted concurrently (set to 1 by default):

var asyncKeyedLocker = new AsyncKeyedLocker(2);

If you would like to see how many concurrent requests there are for a semaphore for a given key:

int myRemainingCount = asyncKeyedLocker.GetRemainingCount(myObject);

If you would like to see the number of remaining threads that can enter the lock for a given key:

int myCurrentCount = asyncKeyedLocker.GetCurrentCount(myObject);

If you would like to check whether any request is using a specific key:

bool isInUse = asyncKeyedLocker.IsInUse(myObject);

And if for some reason you need to force release the requests in the semaphore for a key:

asyncKeyedLocker.ForceRelease(myObject);

You may also use Dependency Injection to inject an instance of AsyncKeyedLock.

Credits

This library is based on Stephen Cleary's solution.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (47)

Showing the top 5 NuGet packages that depend on AsyncKeyedLock:

Package Downloads
EasyCaching.Core

EasyCaching is a open source caching library that contains basic usages and some advanced usages of caching which can help us to handle caching more easier!

EFCoreSecondLevelCacheInterceptor

Entity Framework Core Second Level Caching Library.

N3O.Umbraco.Extensions

TODO

ZhileTime.Hope.DistributedLocking.Abstractions

Package Description

Microsoft.OpenApi.Kiota.Builder

The core engine behind the OpenAPI based client generator.

GitHub repositories (16)

Showing the top 16 popular GitHub repositories that depend on AsyncKeyedLock:

Repository Stars
jellyfin/jellyfin
The Free Software Media System - Server Backend & API
abpframework/abp
Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.
Tyrrrz/DiscordChatExporter
Saves Discord chat logs to a file
microsoft/kiota
OpenAPI based HTTP Client code generator
ZiggyCreatures/FusionCache
FusionCache is an easy to use, fast and robust hybrid cache with advanced resiliency features.
stefanprodan/AspNetCoreRateLimit
ASP.NET Core rate limiting middleware
dotnetcore/EasyCaching
:boom: EasyCaching is an open source caching library that contains basic usages and some advanced usages of caching which can help us to handle caching more easier!
smartstore/Smartstore
A modular, scalable and ultra-fast open-source all-in-one eCommerce platform built on ASP.NET Core 7
VahidN/EFCoreSecondLevelCacheInterceptor
EF Core Second Level Cache Interceptor
omeryanar/FileExplorer
Windows File Explorer alternative with tab browsing
ForNeVeR/Cesium
C compiler for the CLI platform
trimble-oss/dba-dash
DBA Dash - SQL Server Monitoring Tool
ShokoAnime/Shokofin
Repository for Shokofin, a plugin that brings Shoko to Jellyfin.
sa-es-ir/DotNet.RateLimit
A Distributed RateLimit for Controller-Actions and Minimal API.
vesoapp/veso
Open source media server.
VahidN/DNTCommon.Web.Core
DNTCommon.Web.Core provides common scenarios' solutions for ASP.NET Core applications.
Version Downloads Last Updated
8.0.1 3,027 1/24/2026
8.0.0 38,887 1/2/2026
8.0.0-beta2 105 12/31/2025
8.0.0-beta 101 12/31/2025
7.1.8 709,988 11/23/2025
7.1.8-beta5 178 11/23/2025
7.1.8-beta4 182 11/23/2025
7.1.8-beta3 188 11/23/2025
7.1.8-beta2 174 11/23/2025
7.1.8-beta 179 11/23/2025
7.1.7 252,870 10/4/2025
7.1.6 2,379,346 4/12/2025
7.1.5-alpha 219 4/12/2025
7.1.4 1,012,139 11/22/2024
7.1.4-preview 224 11/22/2024
7.1.3 508,491 11/10/2024
7.0.2 218,457 10/13/2024
7.0.1 1,399,784 8/20/2024
7.0.0 172,435 7/21/2024
7.0.0-rc3 252 7/20/2024
7.0.0-rc2 249 7/20/2024
7.0.0-rc1 272 6/29/2024
7.0.0-beta 259 6/29/2024
7.0.0-alpha 251 6/29/2024
6.4.2 595,911 4/21/2024
6.4.1 2,831 4/21/2024
6.4.0 2,262 4/20/2024
6.3.4 3,314,533 1/23/2024
6.3.4-rc 705 1/23/2024
6.3.4-beta 668 1/23/2024
6.3.3 25,953 1/14/2024
6.3.2 2,794 1/14/2024
6.3.0 2,905 1/14/2024
6.2.6 26,031 1/1/2024
6.2.5 3,042 12/30/2023
6.2.4 125,697 12/6/2023
6.2.3 8,392 12/3/2023
6.2.3-beta 885 12/2/2023
6.2.2 1,313,018 10/9/2023
6.2.1 2,541,201 4/10/2023
6.2.0 119,943 2/25/2023
6.1.1 73,419 1/27/2023
6.1.1-rc 1,306 1/27/2023
6.1.1-beta 1,250 1/27/2023
6.1.0 23,001 1/26/2023
6.0.5 54,636 1/2/2023
6.0.5-alpha 1,299 12/30/2022
6.0.4 4,087 12/30/2022
6.0.4-rc6 1,257 12/30/2022
6.0.4-rc5 1,291 12/30/2022
6.0.4-rc3 1,264 12/30/2022
6.0.4-rc 1,248 12/29/2022
6.0.4-beta 1,295 12/29/2022
6.0.4-alpha 1,331 12/29/2022
6.0.3 4,597 12/29/2022
6.0.2 34,474 12/18/2022
6.0.1 4,072 12/17/2022 6.0.1 is deprecated because it has critical bugs.
5.1.2 5,129 12/16/2022
5.1.1 14,166 12/13/2022
5.1.0 6,210 12/3/2022
5.0.4 12,203 11/27/2022
5.0.3 4,558 11/26/2022
5.0.3-rc 1,297 11/26/2022
5.0.2-rc 1,263 11/26/2022
5.0.1 5,033 11/19/2022
4.0.2 9,296 11/13/2022
3.2.3 5,351 10/26/2022
3.2.1 4,346 10/23/2022
3.2.0 4,004 10/23/2022
3.0.1 4,552 10/18/2022
3.0.0 4,346 10/16/2022
2.0.3 18,616 6/29/2022 2.0.3 is deprecated because it has critical bugs.
2.0.2 20,817 3/13/2022 2.0.2 is deprecated because it has critical bugs.
2.0.1 4,518 3/13/2022 2.0.1 is deprecated because it has critical bugs.
2.0.0 4,416 3/11/2022 2.0.0 is deprecated because it has critical bugs.
1.1.0 5,831 12/11/2021 1.1.0 is deprecated because it has critical bugs.
1.0.1 4,537 11/22/2021
1.0.0 5,432 11/22/2021

Fixed serious issue with concurrent threads having been limited to 1 irrespective of setting in the constructor. Also added a few features and tests.