Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stephencleary/asyncex
A helper library for async/await.
https://github.com/stephencleary/asyncex
async async-await asyncex await c-sharp task
Last synced: about 1 month ago
JSON representation
A helper library for async/await.
- Host: GitHub
- URL: https://github.com/stephencleary/asyncex
- Owner: StephenCleary
- License: mit
- Created: 2014-05-08T00:54:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-01-01T05:30:30.000Z (11 months ago)
- Last Synced: 2024-05-01T12:18:36.241Z (7 months ago)
- Topics: async, async-await, asyncex, await, c-sharp, task
- Language: C#
- Size: 1.16 MB
- Stars: 3,414
- Watchers: 156
- Forks: 353
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# AsyncEx
A helper library for async/await.
Note: This README is for AsyncEx v5 (the current version). For AsyncEx v4, see [here](https://github.com/StephenCleary/AsyncEx/tree/v4).
Supports `netstandard1.3` (including .NET 4.6, .NET Core 1.0, Xamarin.iOS 10, Xamarin.Android 7, Mono 4.6, and Universal Windows 10).
[](https://www.nuget.org/packages/Nito.AsyncEx/) [](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) [](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) [](https://coveralls.io/github/StephenCleary/AsyncEx?branch=master) [](https://ci.appveyor.com/project/StephenCleary/asyncex/branch/master)
[](http://dotnetapis.com/pkg/Nito.AsyncEx)
[Overview](doc/Home.md) - [Upgrade Guide](doc/upgrade.md)
## Getting Started
Install the [NuGet package](http://www.nuget.org/packages/Nito.AsyncEx).
## AsyncLock
A lot of developers start using this library for `AsyncLock`, an async-compatible mutual exclusion mechanism. Using `AsyncLock` is straightforward:
```C#
private readonly AsyncLock _mutex = new AsyncLock();
public async Task UseLockAsync()
{
// AsyncLock can be locked asynchronously
using (await _mutex.LockAsync())
{
// It's safe to await while the lock is held
await Task.Delay(TimeSpan.FromSeconds(1));
}
}
```
`AsyncLock` also fully supports cancellation:
```C#
public async Task UseLockAsync()
{
// Attempt to take the lock only for 2 seconds.
var cts = new CancellationTokenSource(TimeSpan.FromSeconds(2));
// If the lock isn't available after 2 seconds, this will
// raise OperationCanceledException.
using (await _mutex.LockAsync(cts.Token))
{
await Task.Delay(TimeSpan.FromSeconds(1));
}
}
```
`AsyncLock` also has a synchronous API. This permits some threads to acquire the lock asynchronously while other threads acquire the lock synchronously (blocking the thread).
```C#
public async Task UseLockAsync()
{
using (await _mutex.LockAsync())
{
await Task.Delay(TimeSpan.FromSeconds(1));
}
}
public void UseLock()
{
using (_mutex.Lock())
{
Thread.Sleep(TimeSpan.FromSeconds(1));
}
}
```
## Other Coordination Primitives
`AsyncLock` is just the beginning. The AsyncEx library contains a full suite of coordination primitives: `AsyncManualResetEvent`, `AsyncAutoResetEvent`, `AsyncConditionVariable`, `AsyncMonitor`, `AsyncSemaphore`, `AsyncCountdownEvent`, and `AsyncReaderWriterLock`.
## More Stuff
There's quite a few other helpful types; see [the docs for full details](doc)
## Infrequently Asked Questions
### Older Platforms
[AsyncEx v4](https://github.com/StephenCleary/AsyncEx/tree/v4) supported .NET 4.0, Windows Store 8.1, Windows Phone Silverlight 8.0, Windows Phone Applications 8.1, and Silverlight 5.0. Support for these platforms has been dropped with AsyncEx v5.
AsyncEx v3 supported Windows Store 8.0, Windows Phone Silverlight 7.5, and Silverlight 4.0. Support for these platforms has been dropped with AsyncEx v4.