AsyncSharp 1.4.2

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

// Install AsyncSharp as a Cake Tool
#tool nuget:?package=AsyncSharp&version=1.4.2                

AsyncSharp

NuGet NuGet

A collection of async friendly classes for resource control, including AsyncSemaphore, AsyncMutex, and ReadersWriterAsyncLock. All classes provide both synchronous and asynchronous methods that expose both timeouts and cancellation token support.

AsyncSemaphore

AsyncSemaphore provides similar functionality to SemaphoreSlim, along with the ability to acquire more than 1 count in a single operation, to release all at once, optional fairness (for both synchronous and asynchronous operations together), and optional disposable acquire and release operations. Below are examples of the three classes available and some of their methods being used.

  • Async locking example:
using var semaphore = new AsyncSemaphore(1, 1);
await semaphore.WaitAsync();
try 
{
    // Your operation
}
finally
{
    semaphore.Release();
}
  • Synchronous locking example:
using var semaphore = new AsyncSemaphore(1, 1);
semaphore.Wait();
try 
{
    // Your operation
}
finally
{
    semaphore.Release();
}
  • Disposable locking example:
using var semaphore = new AsyncSemaphore(1, 1);
using (await semaphore.WaitAndReleaseAsync())
{
    // Your operation
}
  • Acquire example:
using var semaphore = new AsyncSemaphore(5, 5);
await semaphore.WaitAsync(2);
try 
{
    // Your operation
}
finally
{
    semaphore.Release(2);
}
  • Acquire with fairness example:
using var semaphore = new AsyncSemaphore(5, 5, true);
await semaphore.WaitAsync(2);
try 
{
    // Your operation
}
finally
{
    semaphore.Release(2);
}
  • Throttling example:
using var semaphore = new AsyncSemaphore(10, 10);
using var cancellationTokenSource = new CancellationTokenSource();
_ = Task.Run(async () => 
{
    // In a background task, release up to 10 per second
    while (!cancellationTokenSource.IsCancellationRequested)
    {
        await Task.Delay(1000);
        semaphore.ReleaseUpTo(10);
    }
});

while (!cancellationTokenSource.IsCancellationRequested)
{
    // This restricts the DoHeavyThrottledOperation to a maximum of 10/second
    var throttledAmountAvailable = semaphore.AcquireUpTo(10);
    await DoHeavyThrottledOperation(throttledAmountAvailable);
}

AsyncMutex

AsyncMutex provides similar functionality to AsyncSemaphore, but only allows for an exclusive acquire of the mutex (similar as a traditional mutex/lock).

  • Async locking example:
using var mutex = new AsyncMutex();
await mutex.LockAsync();
try 
{
    // Your operation
}
finally
{
    mutex.Unlock();
}
  • Synchronous locking example:
using var mutex = new AsyncMutex();
mutex.Lock();
try 
{
    // Your operation
}
finally
{
    mutex.Unlock();
}
  • Disposable locking example:
using var mutex = new AsyncMutex();
using (await mutex.LockAndUnlockAsync())
{
    // Your operation
}

ReadersWriterAsyncLock

Provides a readers-writer lock that is both async friendly, allows for optional fairness, optional max number of readers, and optional upgradeable locks. This allows for multiple readers, while acquiring the writer lock creates exclusive access (meaning no other readers or writers).

  • Acquire a reader lock:
using var readersWriterAsyncLock = new ReadersWriterAsyncLock();
using (var readerLock = await readersWriterAsyncLock.AcquireReader())
{
    // Do operations while holding reader lock
}
  • Acquire a writer lock:
using var readersWriterAsyncLock = new ReadersWriterAsyncLock();
using (var writerLock = await readersWriterAsyncLock.AcquireWriter())
{
    // Do operations while holding exclusive writer lock
}
  • Acquiring a reader lock and upgrading to a writer lock example:
using var readersWriterAsyncLock = new ReadersWriterAsyncLock();
using (var upgradeableLock = await readersWriterAsyncLock.AcquireUpgradeableReaderAsync())
{
    // Do operations while holding reader lock
    using (var writerLock = await upgradeableLock.UpgradeToWriterAsync())
    {
        // Do operations while holding writer lock
    }
    // Finish any operations with reader lock
}
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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.4.2 2,409 9/19/2024
1.4.1 309 8/26/2024
1.4.0 128 8/22/2024
1.3.2 130 8/22/2024
1.3.1 118 8/22/2024
1.3.0 112 8/18/2024
1.2.0 98 7/13/2024
1.1.0 86 7/11/2024
1.0.2 80 7/10/2024
1.0.1 86 7/8/2024