AsyncKeyedLock 6.4.0

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

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

AsyncKeyedLock AsyncKeyedLock

GitHub Workflow Status NuGet NuGet Codacy Grade Codecov

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(o =>
  {
    o.PoolSize = 20; // this is NOT a concurrency limit
    o.PoolInitialFill = 1;
  });

...

using (await _asyncKeyedLocker.LockAsync("test123"))
{
  ...
}

This libary also supports conditional locking. 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.

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 Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  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 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. 
.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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (33)

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 and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides 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 40,435 4/21/2024
6.4.1 823 4/21/2024
6.4.0 225 4/20/2024
6.3.4 338,982 1/23/2024
6.3.4-rc 523 1/23/2024
6.3.4-beta 504 1/23/2024
6.3.3 9,486 1/14/2024
6.3.2 905 1/14/2024
6.3.0 1,022 1/14/2024
6.2.6 15,406 1/1/2024
6.2.5 1,099 12/30/2023
6.2.4 46,725 12/6/2023
6.2.3 3,385 12/3/2023
6.2.3-beta 729 12/2/2023
6.2.2 420,327 10/9/2023
6.2.1 1,583,159 4/10/2023
6.2.0 82,857 2/25/2023
6.1.1 59,664 1/27/2023
6.1.1-rc 1,036 1/27/2023
6.1.1-beta 1,039 1/27/2023
6.1.0 16,233 1/26/2023
6.0.5 37,764 1/2/2023
6.0.5-alpha 1,050 12/30/2022
6.0.4 2,256 12/30/2022
6.0.4-rc6 1,034 12/30/2022
6.0.4-rc5 1,064 12/30/2022
6.0.4-rc3 1,042 12/30/2022
6.0.4-rc 1,004 12/29/2022
6.0.4-beta 1,062 12/29/2022
6.0.4-alpha 1,086 12/29/2022
6.0.3 2,747 12/29/2022
6.0.2 27,610 12/18/2022
6.0.1 2,141 12/17/2022
5.1.2 3,193 12/16/2022
5.1.1 10,772 12/13/2022
5.1.0 3,643 12/3/2022
5.0.4 10,183 11/27/2022
5.0.3 2,645 11/26/2022
5.0.3-rc 1,066 11/26/2022
5.0.2-rc 1,020 11/26/2022
5.0.1 3,120 11/19/2022
4.0.2 5,671 11/13/2022
3.2.3 3,484 10/26/2022
3.2.1 2,484 10/23/2022
3.2.0 2,166 10/23/2022
3.0.1 2,672 10/18/2022
3.0.0 2,477 10/16/2022
2.0.3 16,536 6/29/2022
2.0.2 16,306 3/13/2022
2.0.1 2,553 3/13/2022
2.0.0 2,636 3/11/2022
1.1.0 3,789 12/11/2021
1.0.1 2,581 11/22/2021
1.0.0 2,275 11/22/2021

New methods for conditional locking which can be used in recursive methods as a workaround for reentrancy. If the condition is false, it enters without locking.