AsyncKeyLock 1.0.4

dotnet add package AsyncKeyLock --version 1.0.4                
NuGet\Install-Package AsyncKeyLock -Version 1.0.4                
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="AsyncKeyLock" Version="1.0.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AsyncKeyLock --version 1.0.4                
#r "nuget: AsyncKeyLock, 1.0.4"                
#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 AsyncKeyLock as a Cake Addin
#addin nuget:?package=AsyncKeyLock&version=1.0.4

// Install AsyncKeyLock as a Cake Tool
#tool nuget:?package=AsyncKeyLock&version=1.0.4                

AsyncKeyLock

License: MIT NuGet

Async Key-based Reader Writer Lock with Cancellation Support

  • Can create reader and writer locks (with key).
  • A reader lock allows concurrent access for read-only operations.
  • A writer lock allows exclusive access for operations.
  • It based internally on TaskCompletionSources which will be queued.

How to use it

//async lock
AsyncLock asyncLock = new AsyncLock();

//async lock with key
AsyncLock<string> asyncLock = new AsyncLock<string>();

//acquire reader lock
var d1 = await asyncLock.ReaderLockAsync("123");

//release reader lock
d1.Dispose();

//set timeout
using CancellationTokenSource cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));

//acquire writer lock
using var d2 = await asyncLock.WriterLockAsync("123", cts.Token);

//use writer lock scope to break long running reader lock
using (ReaderReleaser r1 = await asyncLock.ReaderLockAsync())
{
   //use reader lock

   if (..)
   {
      r1.UseWriterLockAsync(async () => { /*use writer lock here*/ });
   }

   //continue with reader lock
}

Benchmarks

Create und release locks

grafik

Create and release key locks

grafik

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

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on AsyncKeyLock:

Package Downloads
ImageWizard.Core

Image processing middleware based on ASP.NET and ImageSharp / SkiaSharp / SvgNet.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.4 7,366 2/19/2023
1.0.3 235 2/4/2023
1.0.2 242 2/3/2023