Metalama.Community.AutoCancellationToken
2024.2.22
Prefix Reserved
dotnet add package Metalama.Community.AutoCancellationToken --version 2024.2.22
NuGet\Install-Package Metalama.Community.AutoCancellationToken -Version 2024.2.22
<PackageReference Include="Metalama.Community.AutoCancellationToken" Version="2024.2.22" />
paket add Metalama.Community.AutoCancellationToken --version 2024.2.22
#r "nuget: Metalama.Community.AutoCancellationToken, 2024.2.22"
// Install Metalama.Community.AutoCancellationToken as a Cake Addin #addin nuget:?package=Metalama.Community.AutoCancellationToken&version=2024.2.22 // Install Metalama.Community.AutoCancellationToken as a Cake Tool #tool nuget:?package=Metalama.Community.AutoCancellationToken&version=2024.2.22
Metalama.Community.AutoCancellationToken
Automatically propagates CancellationToken
parameter to async
methods and method calls within them.
This is a Metalama aspect. It modifies your code during compilation by using source weaving.
Example
Your code:
[AutoCancellationToken]
class C
{
async Task MakeRequests(CancellationToken ct)
{
using var client = new HttpClient();
await MakeRequest(client);
}
private static async Task MakeRequest(HttpClient client) => await client.GetAsync("https://example.org");
}
What gets compiled:
class C
{
async Task MakeRequests(CancellationToken ct)
{
using var client = new HttpClient();
await MakeRequest(client, ct);
}
private static async Task MakeRequest(HttpClient client, CancellationToken cancellationToken = default) => await client.GetAsync("https://example.org", cancellationToken);
}
Notice that CancellationToken
parameter was added to the declaration of MakeRequest
and that CancellationToken
argument was added to the calls of MakeRequest
and HttpClient.GetAsync
.
Installation
Install the NuGet package: dotnet add package Metalama.Community.AutoCancellationToken
.
How to use
Add [AutoCancellationToken]
to the types where you want it to apply.
By annotating a type with [AutoCancellationToken]
, you add cancellation to all its async
methods. Specifically:
- A
CancellationToken
parameter is added to allasync
methods that don't have it. - A
CancelltionToken
argument is added to calls withinasync
methods where:CancellationToken
can be added as a last argument and the added argument corresponds to aCancellationToken
parameter (e.g. it's not aparams object[]
parameter or a generic parameter). The added argument can result in calling a different overload of the method, or specifying a value for an optional parameter.- The call is not in a
static
local function. - The containing method doesn't have two or more
CancellationToken
parameters, since it wouldn't be clear which one to use.
Product | Versions 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. |
-
.NETStandard 2.0
- Metalama.Framework (>= 2024.2.22)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Metalama.Community.AutoCancellationToken:
Package | Downloads |
---|---|
Shinya.Core
Shinya.Framework |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2024.2.22 | 65 | 8/29/2024 |
2024.2.21 | 66 | 8/28/2024 |
2024.2.20 | 81 | 8/15/2024 |
2024.2.19 | 635 | 8/1/2024 |
2024.2.18 | 57 | 7/29/2024 |
2024.2.17-rc | 70 | 7/22/2024 |
2024.2.16-rc | 57 | 7/18/2024 |
2024.2.15-rc | 44 | 7/12/2024 |
2024.2.14-rc | 1,134 | 7/8/2024 |
2024.2.13-rc | 64 | 7/2/2024 |
2024.2.12-preview | 60 | 6/28/2024 |
2024.2.11-preview | 58 | 6/26/2024 |
2024.2.10-preview | 74 | 6/20/2024 |
2024.2.9-preview | 56 | 6/11/2024 |
2024.2.8-preview | 56 | 6/6/2024 |
2024.2.7-preview | 75 | 5/30/2024 |
2024.2.6-preview | 69 | 5/25/2024 |
2024.2.5-preview | 79 | 5/6/2024 |
2024.2.4-preview | 85 | 5/4/2024 |
2024.2.3-preview | 73 | 4/30/2024 |
2024.2.2-preview | 74 | 4/23/2024 |
2024.2.1-preview | 63 | 4/11/2024 |
2024.1.28 | 0 | 9/9/2024 |
2024.1.27 | 59 | 8/28/2024 |
2024.1.26 | 67 | 8/15/2024 |
2024.1.25 | 74 | 7/22/2024 |
2024.1.24 | 53 | 7/12/2024 |
2024.1.23 | 1,806 | 6/26/2024 |
2024.1.22 | 76 | 6/15/2024 |
2024.1.21 | 78 | 6/6/2024 |
2024.1.20 | 80 | 5/30/2024 |
2024.1.19 | 77 | 5/24/2024 |
2024.1.18 | 120 | 5/6/2024 |
2024.1.17 | 50 | 5/3/2024 |
2024.1.16 | 95 | 4/30/2024 |
2024.1.15 | 81 | 4/29/2024 |
2024.1.14 | 78 | 4/23/2024 |
2024.1.13 | 87 | 4/23/2024 |
2024.1.12 | 96 | 4/17/2024 |
2024.1.11-rc | 72 | 4/11/2024 |
2024.1.10-rc | 89 | 4/4/2024 |
2024.1.9-rc | 70 | 3/27/2024 |
2024.1.8-preview | 66 | 3/25/2024 |
2024.1.7-preview | 77 | 3/19/2024 |
2024.1.6-preview | 75 | 3/6/2024 |
2024.1.5-preview | 71 | 2/29/2024 |
2024.1.4-preview | 77 | 2/27/2024 |
2024.1.3-preview | 77 | 2/23/2024 |
2024.1.2-preview | 80 | 2/7/2024 |
2024.1.1-preview | 71 | 1/30/2024 |
2024.0.16 | 69 | 6/15/2024 |
2024.0.15 | 87 | 6/6/2024 |
2024.0.14 | 73 | 5/30/2024 |
2024.0.13 | 75 | 5/24/2024 |
2024.0.12 | 96 | 4/17/2024 |
2024.0.11 | 104 | 3/21/2024 |
2024.0.10 | 83 | 3/19/2024 |
2024.0.9 | 117 | 2/29/2024 |
2024.0.8 | 136 | 2/23/2024 |
2024.0.7 | 111 | 2/7/2024 |
2024.0.6 | 185 | 1/3/2024 |
2024.0.5-rc | 104 | 12/21/2023 |
2024.0.4-rc | 125 | 12/12/2023 |
2024.0.3-preview | 121 | 12/6/2023 |
2024.0.2-preview | 125 | 11/14/2023 |
2024.0.1-preview | 107 | 11/6/2023 |
2023.4.9 | 84 | 2/7/2024 |
2023.4.8 | 119 | 12/21/2023 |
2023.4.7 | 142 | 12/12/2023 |
2023.4.6 | 155 | 11/7/2023 |
2023.4.5-rc | 117 | 10/26/2023 |
2023.4.4-preview | 116 | 10/18/2023 |
2023.4.3-preview | 114 | 10/4/2023 |
2023.4.2-preview | 114 | 9/26/2023 |
2023.4.1-preview | 108 | 9/13/2023 |
2023.3.10 | 102 | 12/21/2023 |
2023.3.9 | 127 | 12/12/2023 |
2023.3.8 | 141 | 10/17/2023 |
2023.3.7-rc | 121 | 9/29/2023 |
2023.3.6-rc | 130 | 9/26/2023 |
2023.3.5-rc | 125 | 9/13/2023 |
2023.3.4-preview | 133 | 8/30/2023 |
2023.3.3-preview | 143 | 8/29/2023 |
2023.3.2-preview | 342 | 8/1/2023 |
2023.3.1-preview | 248 | 7/28/2023 |
2023.2.5 | 337 | 9/12/2023 |
2023.2.4 | 305 | 8/7/2023 |
2023.2.3-rc | 279 | 8/3/2023 |
2023.2.2-rc | 283 | 7/21/2023 |
2023.2.1-preview | 318 | 6/27/2023 |
2023.1.7 | 295 | 9/12/2023 |
2023.1.6 | 326 | 8/7/2023 |
2023.1.5 | 172 | 7/17/2023 |
2023.1.4 | 196 | 6/27/2023 |