AsyncKeyedLock 2.0.2

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

// Install AsyncKeyedLock as a Cake Tool
#tool nuget:?package=AsyncKeyedLock&version=2.0.2

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 myCount = asyncKeyedLocker.GetCount(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. 
.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 (34)

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!

Volo.Abp.DistributedLocking.Abstractions The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Package Description

EFCoreSecondLevelCacheInterceptor

Entity Framework Core Second Level Caching Library.

N3O.Umbraco.Extensions

TODO

ZhileTime.Hope.DistributedLocking.Abstractions

Package Description

GitHub repositories (6)

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

Repository Stars
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
Exports Discord chat logs to a file
stefanprodan/AspNetCoreRateLimit
ASP.NET Core rate limiting middleware
smartstore/Smartstore
A modular, scalable and ultra-fast open-source all-in-one eCommerce platform built on ASP.NET Core 7
omeryanar/FileExplorer
Windows File Explorer alternative with tab browsing
Version Downloads Last updated
6.4.2 102,607 4/21/2024
6.4.1 914 4/21/2024
6.4.0 312 4/20/2024
6.3.4 472,282 1/23/2024
6.3.4-rc 531 1/23/2024
6.3.4-beta 511 1/23/2024
6.3.3 10,693 1/14/2024
6.3.2 986 1/14/2024
6.3.0 1,112 1/14/2024
6.2.6 15,771 1/1/2024
6.2.5 1,186 12/30/2023
6.2.4 50,295 12/6/2023
6.2.3 3,597 12/3/2023
6.2.3-beta 736 12/2/2023
6.2.2 475,407 10/9/2023
6.2.1 1,642,153 4/10/2023
6.2.0 84,378 2/25/2023
6.1.1 60,263 1/27/2023
6.1.1-rc 1,043 1/27/2023
6.1.1-beta 1,045 1/27/2023
6.1.0 16,324 1/26/2023
6.0.5 39,076 1/2/2023
6.0.5-alpha 1,058 12/30/2022
6.0.4 2,338 12/30/2022
6.0.4-rc6 1,042 12/30/2022
6.0.4-rc5 1,071 12/30/2022
6.0.4-rc3 1,048 12/30/2022
6.0.4-rc 1,010 12/29/2022
6.0.4-beta 1,069 12/29/2022
6.0.4-alpha 1,098 12/29/2022
6.0.3 2,830 12/29/2022
6.0.2 27,693 12/18/2022
6.0.1 2,223 12/17/2022
5.1.2 3,289 12/16/2022
5.1.1 10,856 12/13/2022
5.1.0 3,774 12/3/2022
5.0.4 10,360 11/27/2022
5.0.3 2,729 11/26/2022
5.0.3-rc 1,072 11/26/2022
5.0.2-rc 1,026 11/26/2022
5.0.1 3,203 11/19/2022
4.0.2 5,889 11/13/2022
3.2.3 3,572 10/26/2022
3.2.1 2,570 10/23/2022
3.2.0 2,248 10/23/2022
3.0.1 2,757 10/18/2022
3.0.0 2,564 10/16/2022
2.0.3 16,633 6/29/2022
2.0.2 16,559 3/13/2022
2.0.1 2,646 3/13/2022
2.0.0 2,721 3/11/2022
1.1.0 3,880 12/11/2021
1.0.1 2,663 11/22/2021
1.0.0 2,384 11/22/2021

Updated documentation.