Add a named timeout policy example

dodyg · dodyg · commit 788fcb883324 · 2023-04-23T16:07:41.000+02:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Samples for ASP.NET Core 6.0 (471)
+# Samples for ASP.NET Core 6.0 (472)
 
-Samples for ASP.NET Core **8.0 Preview 4** is available [here](/projects/.net8) (9).
+Samples for ASP.NET Core **8.0 Preview 4** is available [here](/projects/.net8) (10).
 
 Samples for ASP.NET Core **7.0** is available [here](/projects/.net7) (45).
 
diff --git a/projects/.net8/README.md b/projects/.net8/README.md
@@ -1,4 +1,4 @@
-# ASP.NET 8.0 Preview 4 (9)
+# ASP.NET 8.0 Preview 4 (10)
 
 These samples require [.NET 8.0 Preview 4](https://github.com/dotnet/installer#table). 
 
@@ -35,6 +35,10 @@ These samples require [.NET 8.0 Preview 4](https://github.com/dotnet/installer#t
 
   This sample demonstrates how to configure a request timeout.
 
+* [Request Timeout Policy](request-timeout-2)
+
+  Trigger exception on a timeout using `HttpContext.RequestAborted.ThrowIfCancellationRequested()` on a timeout that was specified using a named policy.
+
 * [Short Circuit](map-short-circuit)
 
   Use `MapShortCircuit` or `.ShortCircuit()` to efficiently respond to a request without going through a middleware pipeline run. 
diff --git a/projects/.net8/request-timeout-2/Program.cs b/projects/.net8/request-timeout-2/Program.cs
@@ -0,0 +1,33 @@
+var builder = WebApplication.CreateBuilder();
+builder.Services.AddRequestTimeouts(options =>
+{
+    options.AddPolicy("quick", new Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutPolicy
+    {
+        Timeout = TimeSpan.FromSeconds(1),
+        TimeoutStatusCode = 200,
+        WriteTimeoutResponse = async (HttpContext context) => 
+        {
+            context.Response.ContentType = "text/plain";
+            await context.Response.WriteAsync("timeout is triggered");
+        }
+    });
+});
+
+var app = builder.Build();
+app.UseRequestTimeouts();
+
+app.MapGet("/", async (HttpContext context) => {
+    await Task.Delay(TimeSpan.FromSeconds(2));
+
+    context.RequestAborted.ThrowIfCancellationRequested();
+
+    return Results.Content("""
+    <html>
+    <body>
+        hello world
+    </body>
+    </html>
+    """, "text/html");
+}).WithRequestTimeout("quick");
+
+app.Run();
diff --git a/projects/.net8/request-timeout-2/README.md b/projects/.net8/request-timeout-2/README.md
@@ -0,0 +1,3 @@
+# Name timeout policy
+
+Trigger exception on a timeout using `HttpContext.RequestAborted.ThrowIfCancellationRequested()` on a timeout that was specified using a named policy.
diff --git a/projects/.net8/request-timeout-2/request-timeout-2.csproj b/projects/.net8/request-timeout-2/request-timeout-2.csproj
@@ -0,0 +1,8 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>true</ImplicitUsings>
+    <LangVersion>preview</LangVersion>
+    <PreviewFeatures>true</PreviewFeatures>
+  </PropertyGroup>
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Name timeout policy`
	`2`	`+`
	`3`	+Trigger exception on a timeout using `HttpContext.RequestAborted.ThrowIfCancellationRequested()` on a timeout that was specified using a named policy.