AsyncAwaitBestPractices 8.0.0
dotnet add package AsyncAwaitBestPractices --version 8.0.0
NuGet\Install-Package AsyncAwaitBestPractices -Version 8.0.0
<PackageReference Include="AsyncAwaitBestPractices" Version="8.0.0" />
paket add AsyncAwaitBestPractices --version 8.0.0
#r "nuget: AsyncAwaitBestPractices, 8.0.0"
// Install AsyncAwaitBestPractices as a Cake Addin #addin nuget:?package=AsyncAwaitBestPractices&version=8.0.0 // Install AsyncAwaitBestPractices as a Cake Tool #tool nuget:?package=AsyncAwaitBestPractices&version=8.0.0
AsyncAwaitBestPractices
Available on NuGet: https://www.nuget.org/packages/AsyncAwaitBestPractices/
SafeFireAndForget
- An extension method to safely fire-and-forget a
Task
or aValueTask
- Ensures the
Task
will rethrow anException
if anException
is caught inIAsyncStateMachine.MoveNext()
- An extension method to safely fire-and-forget a
WeakEventManager
- Avoids memory leaks when events are not unsubscribed
- Used by
AsyncCommand
,AsyncCommand<T>
,AsyncValueCommand
,AsyncValueCommand<T>
- Usage instructions
Setup
- Available on NuGet: https://www.nuget.org/packages/AsyncAwaitBestPractices/
- Add to any project supporting .NET Standard 1.0
Usage
SafeFireAndForget
An extension method to safely fire-and-forget a Task
.
SafeFireAndForget
allows a Task to safely run on a different thread while the calling thread does not wait for its completion.
public static async void SafeFireAndForget(this System.Threading.Tasks.Task task, System.Action<System.Exception>? onException = null, bool continueOnCapturedContext = false)
public static async void SafeFireAndForget(this System.Threading.Tasks.ValueTask task, System.Action<System.Exception>? onException = null, bool continueOnCapturedContext = false)
Basic Usage - Task
void HandleButtonTapped(object sender, EventArgs e)
{
// Allows the async Task method to safely run on a different thread while the calling thread continues, not awaiting its completion
// onException: If an Exception is thrown, print it to the Console
ExampleAsyncMethod().SafeFireAndForget(onException: ex => Console.WriteLine(ex));
// HandleButtonTapped continues execution here while `ExampleAsyncMethod()` is running on a different thread
// ...
}
async Task ExampleAsyncMethod()
{
await Task.Delay(1000);
}
Basic Usage - ValueTask
If you're new to ValueTask, check out this great write-up, Understanding the Whys, Whats, and Whens of ValueTask.
void HandleButtonTapped(object sender, EventArgs e)
{
// Allows the async ValueTask method to safely run on a different thread while the calling thread continues, not awaiting its completion
// onException: If an Exception is thrown, print it to the Console
ExampleValueTaskMethod().SafeFireAndForget(onException: ex => Console.WriteLine(ex));
// HandleButtonTapped continues execution here while `ExampleAsyncMethod()` is running on a different thread
// ...
}
async ValueTask ExampleValueTaskMethod()
{
var random = new Random();
if (random.Next(10) > 9)
await Task.Delay(1000);
}
Advanced Usage
void InitializeSafeFireAndForget()
{
// Initialize SafeFireAndForget
// Only use `shouldAlwaysRethrowException: true` when you want `.SafeFireAndForget()` to always rethrow every exception. This is not recommended, because there is no way to catch an Exception rethrown by `SafeFireAndForget()`; `shouldAlwaysRethrowException: true` should **not** be used in Production/Release builds.
SafeFireAndForgetExtensions.Initialize(shouldAlwaysRethrowException: false);
// SafeFireAndForget will print every exception to the Console
SafeFireAndForgetExtensions.SetDefaultExceptionHandling(ex => Console.WriteLine(ex));
}
void UninitializeSafeFireAndForget()
{
// Remove default exception handling
SafeFireAndForgetExtensions.RemoveDefaultExceptionHandling()
}
void HandleButtonTapped(object sender, EventArgs e)
{
// Allows the async Task method to safely run on a different thread while not awaiting its completion
// onException: If a WebException is thrown, print its StatusCode to the Console. **Note**: If a non-WebException is thrown, it will not be handled by `onException`
// Because we set `SetDefaultExceptionHandling` in `void InitializeSafeFireAndForget()`, the entire exception will also be printed to the Console
ExampleAsyncMethod().SafeFireAndForget<WebException>(onException: ex =>
{
if(ex.Response is HttpWebResponse webResponse)
Console.WriteLine($"Task Exception\n Status Code: {webResponse.StatusCode}");
});
ExampleValueTaskMethod().SafeFireAndForget<WebException>(onException: ex =>
{
if(ex.Response is HttpWebResponse webResponse)
Console.WriteLine($"ValueTask Error\n Status Code: {webResponse.StatusCode}");
});
// HandleButtonTapped continues execution here while `ExampleAsyncMethod()` and `ExampleValueTaskMethod()` run in the background
}
async Task ExampleAsyncMethod()
{
await Task.Delay(1000);
throw new WebException();
}
async ValueTask ExampleValueTaskMethod()
{
var random = new Random();
if (random.Next(10) > 9)
await Task.Delay(1000);
throw new WebException();
}
WeakEventManager
An event implementation that enables the garbage collector to collect an object without needing to unsubscribe event handlers.
Inspired by Xamarin.Forms.WeakEventManager.
Using EventHandler
readonly WeakEventManager _canExecuteChangedEventManager = new WeakEventManager();
public event EventHandler CanExecuteChanged
{
add => _canExecuteChangedEventManager.AddEventHandler(value);
remove => _canExecuteChangedEventManager.RemoveEventHandler(value);
}
void OnCanExecuteChanged() => _canExecuteChangedEventManager.RaiseEvent(this, EventArgs.Empty, nameof(CanExecuteChanged));
Using Delegate
readonly WeakEventManager _propertyChangedEventManager = new WeakEventManager();
public event PropertyChangedEventHandler PropertyChanged
{
add => _propertyChangedEventManager.AddEventHandler(value);
remove => _propertyChangedEventManager.RemoveEventHandler(value);
}
void OnPropertyChanged([CallerMemberName]string propertyName = "") => _propertyChangedEventManager.RaiseEvent(this, new PropertyChangedEventArgs(propertyName), nameof(PropertyChanged));
Using Action
readonly WeakEventManager _weakActionEventManager = new WeakEventManager();
public event Action ActionEvent
{
add => _weakActionEventManager.AddEventHandler(value);
remove => _weakActionEventManager.RemoveEventHandler(value);
}
void OnActionEvent(string message) => _weakActionEventManager.RaiseEvent(message, nameof(ActionEvent));
WeakEventManager<T>
An event implementation that enables the garbage collector to collect an object without needing to unsubscribe event handlers.
Inspired by Xamarin.Forms.WeakEventManager.
Using EventHandler<T>
readonly WeakEventManager<string> _errorOcurredEventManager = new WeakEventManager<string>();
public event EventHandler<string> ErrorOcurred
{
add => _errorOcurredEventManager.AddEventHandler(value);
remove => _errorOcurredEventManager.RemoveEventHandler(value);
}
void OnErrorOcurred(string message) => _errorOcurredEventManager.RaiseEvent(this, message, nameof(ErrorOcurred));
Using Action<T>
readonly WeakEventManager<string> _weakActionEventManager = new WeakEventManager<string>();
public event Action<string> ActionEvent
{
add => _weakActionEventManager.AddEventHandler(value);
remove => _weakActionEventManager.RemoveEventHandler(value);
}
void OnActionEvent(string message) => _weakActionEventManager.RaiseEvent(message, nameof(ActionEvent));
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. 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 is compatible. 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 | netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard1.0 is compatible. netstandard1.1 was computed. netstandard1.2 was computed. netstandard1.3 was computed. netstandard1.4 was computed. netstandard1.5 was computed. netstandard1.6 was computed. netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net45 was computed. net451 was computed. net452 was computed. net46 was computed. 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 | tizen30 was computed. tizen40 was computed. tizen60 was computed. |
Universal Windows Platform | uap was computed. uap10.0 was computed. |
Windows Phone | wp8 was computed. wp81 was computed. wpa81 was computed. |
Windows Store | netcore was computed. netcore45 was computed. netcore451 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 1.0
- System.Reflection.Emit.Lightweight (>= 4.7.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
- System.ValueTuple (>= 4.5.0)
-
.NETStandard 2.0
- System.Reflection.Emit.Lightweight (>= 4.7.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
.NETStandard 2.1
- No dependencies.
-
net6.0
- No dependencies.
-
net7.0
- No dependencies.
-
net8.0
- No dependencies.
NuGet packages (17)
Showing the top 5 NuGet packages that depend on AsyncAwaitBestPractices:
Package | Downloads |
---|---|
AsyncAwaitBestPractices.MVVM
Async Extensions for ICommand Includes AsyncCommand and IAsyncCommand which allows ICommand to safely be used asynchronously with Task. Includes AsyncValueCommand and IAsyncValueCommand which allows ICommand to safely be used asynchronously with ValueTask |
|
Mopups
Popups for MAUI |
|
Jakar.Extensions
Extensions to aid in development. |
|
Xam.Shell.Badge
A small plugin to ease the use of badges on Shell Bottom Bars |
|
Shinya.Core
Shinya.Framework |
GitHub repositories (17)
Showing the top 5 popular GitHub repositories that depend on AsyncAwaitBestPractices:
Repository | Stars |
---|---|
LykosAI/StabilityMatrix
Multi-Platform Package Manager for Stable Diffusion
|
|
dotnet/maui-samples
Samples for .NET Multi-Platform App UI (.NET MAUI)
|
|
beeradmoore/dlss-swapper
|
|
yourtablecloth/TableCloth
식탁보 프로젝트
|
|
mehdihadeli/food-delivery-microservices
🍔 A practical and imaginary food delivery microservices, built with .Net 8, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
|
Version | Downloads | Last updated |
---|---|---|
8.0.0 | 74,288 | 7/9/2024 |
7.0.0 | 271,818 | 11/14/2023 |
6.0.6 | 336,650 | 11/12/2022 |
6.0.5 | 248,436 | 7/3/2022 |
6.0.4 | 803,144 | 11/23/2021 |
6.0.3 | 7,405 | 11/11/2021 |
6.0.2 | 18,888 | 10/12/2021 |
6.0.1 | 15,546 | 9/27/2021 |
6.0.0 | 56,665 | 7/3/2021 |
6.0.0-pre1 | 1,349 | 6/7/2021 |
5.1.0 | 111,861 | 3/13/2021 |
5.0.2 | 136,376 | 11/2/2020 |
5.0.0-pre2 | 2,235 | 9/17/2020 |
5.0.0-pre1 | 994 | 9/17/2020 |
4.3.0 | 30,113 | 9/15/2020 |
4.3.0-pre1 | 2,255 | 7/29/2020 |
4.2.0 | 45,093 | 7/13/2020 |
4.1.1 | 49,530 | 5/15/2020 |
4.1.1-pre1 | 2,894 | 4/1/2020 |
4.1.0 | 88,641 | 1/30/2020 |
4.1.0-pre2 | 1,702 | 1/7/2020 |
4.1.0-pre1 | 1,587 | 12/19/2019 |
4.0.1 | 92,151 | 12/13/2019 |
4.0.0-pre3 | 1,316 | 11/29/2019 |
4.0.0-pre1 | 1,085 | 11/7/2019 |
3.1.0 | 30,793 | 8/28/2019 |
3.1.0-pre5 | 1,322 | 8/20/2019 |
3.1.0-pre4 | 1,062 | 8/20/2019 |
3.1.0-pre3 | 1,205 | 8/14/2019 |
3.1.0-pre2 | 1,306 | 7/31/2019 |
3.1.0-pre1 | 1,091 | 7/31/2019 |
3.0.0 | 6,467 | 7/30/2019 |
3.0.0-pre4 | 1,199 | 7/14/2019 |
3.0.0-pre3 | 1,128 | 7/7/2019 |
3.0.0-pre2 | 1,200 | 7/2/2019 |
3.0.0-pre1 | 1,241 | 6/9/2019 |
2.1.1 | 19,670 | 4/17/2019 |
2.1.0 | 5,140 | 1/12/2019 |
2.1.0-pre1 | 1,492 | 12/27/2018 |
2.0.0 | 1,717 | 12/19/2018 |
1.2.1 | 1,582 | 12/17/2018 |
1.2.0 | 835 | 12/17/2018 |
1.1.0 | 1,561 | 12/16/2018 |
1.0.1 | 1,602 | 12/15/2018 |
1.0.0 | 933 | 11/30/2018 |
0.9.0 | 2,888 | 11/22/2018 |
New In This Release:
- Add Support for ValueTask<T>