crozone.AsyncResetEvents 1.0.0

AsyncResetEvents

Async compatible auto and manual reset events for NetStandard 2.0

Install-Package crozone.AsyncResetEvents -Version 1.0.0
dotnet add package crozone.AsyncResetEvents --version 1.0.0
<PackageReference Include="crozone.AsyncResetEvents" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add crozone.AsyncResetEvents --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

AsyncResetEvents

Async compatible auto and manual reset events.

Async compatible reset events

These reset events aim to serve the same purpose as the .NET AutoResetEvent and ManualResetEvent, but with async methods.

This allows events to be awaited in a manner that doesn't block the thread, allowing easy, efficient, and threadsafe signalling and synchronization.

Requirements

The library is written for NetStandard 2.0, and is entirely self-contained.

Derivative code

The code is based on Stephen Toub's async primatives implementation

It is also based on Stephen Cleary's AsyncEx library.

Implementation

AsyncAutoResetEvent and AsyncManualResetEvent both share a common underlying implementation, contained within AsyncResetEvent. The AsyncAutoResetEvent and AsyncManualResetEvent classes themselves are really just thin convenience wrappers, and all they do is set a single boolean value within AsyncResetEvent to tweak its behaviour between manual and auto modes.

The motivation for this was to provide a straightforward, maintainable, and easy to test implementation. This leads to a slightly less efficient manual reset event, but (IMHO) easier to understand and maintain code.

AsyncResetEvents

Async compatible auto and manual reset events.

Async compatible reset events

These reset events aim to serve the same purpose as the .NET AutoResetEvent and ManualResetEvent, but with async methods.

This allows events to be awaited in a manner that doesn't block the thread, allowing easy, efficient, and threadsafe signalling and synchronization.

Requirements

The library is written for NetStandard 2.0, and is entirely self-contained.

Derivative code

The code is based on Stephen Toub's async primatives implementation

It is also based on Stephen Cleary's AsyncEx library.

Implementation

AsyncAutoResetEvent and AsyncManualResetEvent both share a common underlying implementation, contained within AsyncResetEvent. The AsyncAutoResetEvent and AsyncManualResetEvent classes themselves are really just thin convenience wrappers, and all they do is set a single boolean value within AsyncResetEvent to tweak its behaviour between manual and auto modes.

The motivation for this was to provide a straightforward, maintainable, and easy to test implementation. This leads to a slightly less efficient manual reset event, but (IMHO) easier to understand and maintain code.

Release Notes

Initial Release

  • .NETStandard 2.0

    • No dependencies.

Version History

Version Downloads Last updated
1.0.0 257 12/13/2017