AsyncKeyedLock 7.0.1
dotnet add package AsyncKeyedLock --version 7.0.1
NuGet\Install-Package AsyncKeyedLock -Version 7.0.1
<PackageReference Include="AsyncKeyedLock" Version="7.0.1" />
paket add AsyncKeyedLock --version 7.0.1
#r "nuget: AsyncKeyedLock, 7.0.1"
// Install AsyncKeyedLock as a Cake Addin #addin nuget:?package=AsyncKeyedLock&version=7.0.1 // Install AsyncKeyedLock as a Cake Tool #tool nuget:?package=AsyncKeyedLock&version=7.0.1
AsyncKeyedLock
An asynchronous .NET Standard 2.0 library that allows you to lock based on a key (keyed semaphores), limiting concurrent threads sharing the same key to a specified number, with optional pooling for reducing memory allocations.
For example, suppose you were processing financial transactions, but while working on one account you wouldn't want to concurrently process a transaction for the same account. Of course, you could just add a normal lock, but then you can only process one transaction at a time. If you're processing a transaction for account A, you may want to also be processing a separate transaction for account B. That's where AsyncKeyedLock comes in: it allows you to lock but only if the key matches.
The library uses two very different methods for locking, AsyncKeyedLocker
which uses an underlying ConcurrentDictionary
that's cleaned up after use and StripedAsyncKeyedLocker
which uses a technique called striped locking. Both have their advantages and disadvantages, and in order to help you choose you are highly recommended to read about it in the wiki.
A simple non-keyed lock is also available through AsyncNonKeyedLocker
.
Installation and usage
Using this library is straightforward. Here's a simple example for using AsyncKeyedLocker
:
private static readonly AsyncKeyedLocker<string> _asyncKeyedLocker = new();
...
using (await _asyncKeyedLocker.LockAsync("test123"))
{
...
}
This libary also supports conditional locking, whether for AsyncKeyedLocker
, StripedAsyncKeyedLocker
or AsyncNonKeyedLocker
. This could provide a workaround for reentrancy
in some scenarios for example in recursion:
double factorial = Factorial(number);
public static double Factorial(int number, bool isFirst = true)
{
using (await _asyncKeyedLocker.ConditionalLockAsync("test123", isFirst))
{
if (number == 0)
return 1;
return number * Factorial(number-1, false);
}
}
For more help with AsyncKeyedLocker
or for examples with StripedAsyncKeyedLocker
or AsyncNonKeyedLocker
(for simple, non-keyed locking), please take a look at our wiki.
Pooling change in v7.0.0
Prior to AsyncKeyedLock 7.0.0, pooling was disabled by default and you needed to specify a pool size in order to enable it. Now pooling is enabled by default with an initial fill of 1 and a pool size of 20. In order to retain the same functionality you need to now specify a pool size of 0 within AsyncKeyedLockOptions. Read more about pooling in our wiki.
Benchmarks
This library has been extensively benchmarked against several other options and our benchmarks run publicly and transparently on Github Actions.
Credits
Check out our list of contributors!
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. 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 is compatible. 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 is compatible. 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 is compatible. |
.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 is compatible. |
.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. |
-
.NETStandard 2.0
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
.NETStandard 2.1
- No dependencies.
-
net5.0
- No dependencies.
-
net6.0
- No dependencies.
-
net7.0
- No dependencies.
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (37)
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
Package Description |
|
EFCoreSecondLevelCacheInterceptor
Entity Framework Core Second Level Caching Library. |
|
N3O.Umbraco.Extensions
TODO |
|
ZhileTime.Hope.DistributedLocking.Abstractions
Package Description |
GitHub repositories (14)
Showing the top 5 popular GitHub repositories that depend on AsyncKeyedLock:
Repository | Stars |
---|---|
jellyfin/jellyfin
The Free Software Media System
|
|
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
|
|
microsoft/kiota
OpenAPI based HTTP Client code generator
|
Version | Downloads | Last updated | |
---|---|---|---|
7.0.1 | 11,695 | 8/20/2024 | |
7.0.0 | 49,650 | 7/21/2024 | |
7.0.0-rc3 | 83 | 7/20/2024 | |
7.0.0-rc2 | 78 | 7/20/2024 | |
7.0.0-rc1 | 108 | 6/29/2024 | |
7.0.0-beta | 90 | 6/29/2024 | |
7.0.0-alpha | 84 | 6/29/2024 | |
6.4.2 | 200,755 | 4/21/2024 | |
6.4.1 | 1,010 | 4/21/2024 | |
6.4.0 | 403 | 4/20/2024 | |
6.3.4 | 712,018 | 1/23/2024 | |
6.3.4-rc | 534 | 1/23/2024 | |
6.3.4-beta | 517 | 1/23/2024 | |
6.3.3 | 12,394 | 1/14/2024 | |
6.3.2 | 1,066 | 1/14/2024 | |
6.3.0 | 1,192 | 1/14/2024 | |
6.2.6 | 16,297 | 1/1/2024 | |
6.2.5 | 1,264 | 12/30/2023 | |
6.2.4 | 56,749 | 12/6/2023 | |
6.2.3 | 3,995 | 12/3/2023 | |
6.2.3-beta | 737 | 12/2/2023 | |
6.2.2 | 557,509 | 10/9/2023 | |
6.2.1 | 1,734,655 | 4/10/2023 | |
6.2.0 | 86,266 | 2/25/2023 | |
6.1.1 | 60,642 | 1/27/2023 | |
6.1.1-rc | 1,047 | 1/27/2023 | |
6.1.1-beta | 1,051 | 1/27/2023 | |
6.1.0 | 16,412 | 1/26/2023 | |
6.0.5 | 40,971 | 1/2/2023 | |
6.0.5-alpha | 1,062 | 12/30/2022 | |
6.0.4 | 2,416 | 12/30/2022 | |
6.0.4-rc6 | 1,049 | 12/30/2022 | |
6.0.4-rc5 | 1,076 | 12/30/2022 | |
6.0.4-rc3 | 1,052 | 12/30/2022 | |
6.0.4-rc | 1,014 | 12/29/2022 | |
6.0.4-beta | 1,075 | 12/29/2022 | |
6.0.4-alpha | 1,103 | 12/29/2022 | |
6.0.3 | 2,907 | 12/29/2022 | |
6.0.2 | 27,814 | 12/18/2022 | |
6.0.1 | 2,300 | 12/17/2022 | |
5.1.2 | 3,374 | 12/16/2022 | |
5.1.1 | 10,933 | 12/13/2022 | |
5.1.0 | 3,915 | 12/3/2022 | |
5.0.4 | 10,497 | 11/27/2022 | |
5.0.3 | 2,809 | 11/26/2022 | |
5.0.3-rc | 1,075 | 11/26/2022 | |
5.0.2-rc | 1,032 | 11/26/2022 | |
5.0.1 | 3,287 | 11/19/2022 | |
4.0.2 | 6,285 | 11/13/2022 | |
3.2.3 | 3,652 | 10/26/2022 | |
3.2.1 | 2,649 | 10/23/2022 | |
3.2.0 | 2,327 | 10/23/2022 | |
3.0.1 | 2,834 | 10/18/2022 | |
3.0.0 | 2,642 | 10/16/2022 | |
2.0.3 | 16,716 | 6/29/2022 | |
2.0.2 | 17,185 | 3/13/2022 | |
2.0.1 | 2,724 | 3/13/2022 | |
2.0.0 | 2,801 | 3/11/2022 | |
1.1.0 | 3,962 | 12/11/2021 | |
1.0.1 | 2,735 | 11/22/2021 | |
1.0.0 | 2,504 | 11/22/2021 |
Deterministic builds, AOT and trimming.