MinApiLib.OperationCanceled
11.0.0
dotnet add package MinApiLib.OperationCanceled --version 11.0.0
NuGet\Install-Package MinApiLib.OperationCanceled -Version 11.0.0
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="MinApiLib.OperationCanceled" Version="11.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MinApiLib.OperationCanceled" Version="11.0.0" />
<PackageReference Include="MinApiLib.OperationCanceled" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MinApiLib.OperationCanceled --version 11.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MinApiLib.OperationCanceled, 11.0.0"
#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.
#:package MinApiLib.OperationCanceled@11.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MinApiLib.OperationCanceled&version=11.0.0
#tool nuget:?package=MinApiLib.OperationCanceled&version=11.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MinApiLib.OperationCanceled
Middleware that answers with a 499 status code (Client Closed Request) when the client cancels a request, instead of letting the OperationCanceledException surface as an unhandled error.
Installation
dotnet add package MinApiLib.OperationCanceled
Usage
global using MinApiLib.OperationCanceled;
// ...
app.CatchOperationCanceled();
Add it before any middleware whose cancellations it should catch. Then pass the CancellationToken to your async calls, or throw when it's canceled:
protected override async Task<IResult> HandleAsync(Request request, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var thing = await db.Things.FindAsync(new object[] { request.Id }, cancellationToken);
// ...
}
To use another status code:
app.CatchOperationCanceled(options => options.StatusCode = 444);
Behavior
- It only handles cancellations of aborted requests, when
HttpContext.RequestAbortedis canceled. Any otherOperationCanceledException, such as a timeout in an outgoing call, is a server problem: it isn't caught, and it surfaces as usual. - The cancellation is logged at
Informationlevel, and the response body isClient Closed Request. - If the response has already started, its status can't change, so the middleware only logs the cancellation.
Upgrading
The middleware used to answer 499 to every OperationCanceledException, even with the client still connected.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. net11.0 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- No dependencies.
-
net11.0
- No dependencies.
-
net8.0
- No dependencies.
-
net9.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.