|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
#nullable enable
using Microsoft.AspNetCore.Hosting.Server.Features;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
namespace Microsoft.AspNetCore.Hosting;
/// <summary>
/// Contains extensions for managing the lifecycle of an <see cref="IWebHost"/>.
/// </summary>
public static class WebHostExtensions
{
/// <summary>
/// Attempts to gracefully stop the host with the given timeout.
/// </summary>
/// <param name="host"></param>
/// <param name="timeout">The timeout for stopping gracefully. Once expired the
/// server may terminate any remaining active connections.</param>
/// <returns>A <see cref="Task"/> that completes when the <see cref="IWebHost"/> stops.</returns>
public static async Task StopAsync(this IWebHost host, TimeSpan timeout)
{
using var cts = new CancellationTokenSource(timeout);
await host.StopAsync(cts.Token);
}
/// <summary>
/// Block the calling thread until shutdown is triggered via Ctrl+C or SIGTERM.
/// </summary>
/// <param name="host">The running <see cref="IWebHost"/>.</param>
public static void WaitForShutdown(this IWebHost host)
{
host.WaitForShutdownAsync().GetAwaiter().GetResult();
}
/// <summary>
/// Returns a Task that completes when shutdown is triggered via the given token, Ctrl+C or SIGTERM.
/// </summary>
/// <param name="host">The running <see cref="IWebHost"/>.</param>
/// <param name="token">The token to trigger shutdown.</param>
/// <returns>A <see cref="Task"/> that completes when shutdown is triggered via Ctrl+C or SIGTERM.</returns>
public static async Task WaitForShutdownAsync(this IWebHost host, CancellationToken token = default)
{
var done = new ManualResetEventSlim(false);
using (var cts = CancellationTokenSource.CreateLinkedTokenSource(token))
{
using (var lifetime = new WebHostLifetime(cts, done, shutdownMessage: string.Empty))
{
try
{
await host.WaitForTokenShutdownAsync(cts.Token);
lifetime.SetExitedGracefully();
}
finally
{
done.Set();
}
}
}
}
/// <summary>
/// Runs a web application and block the calling thread until host shutdown.
/// </summary>
/// <param name="host">The <see cref="IWebHost"/> to run.</param>
public static void Run(this IWebHost host)
{
host.RunAsync().GetAwaiter().GetResult();
}
/// <summary>
/// Runs a web application and returns a Task that only completes when the token is triggered or shutdown is triggered.
/// </summary>
/// <param name="host">The <see cref="IWebHost"/> to run.</param>
/// <param name="token">The token to trigger shutdown.</param>
public static async Task RunAsync(this IWebHost host, CancellationToken token = default)
{
// Wait for token shutdown if it can be canceled
if (token.CanBeCanceled)
{
await host.RunAsync(token, startupMessage: null);
return;
}
// If token cannot be canceled, attach Ctrl+C and SIGTERM shutdown
var done = new ManualResetEventSlim(false);
using (var cts = new CancellationTokenSource())
{
var shutdownMessage = host.Services.GetRequiredService<WebHostOptions>().SuppressStatusMessages ? string.Empty : "Application is shutting down...";
using (var lifetime = new WebHostLifetime(cts, done, shutdownMessage: shutdownMessage))
{
try
{
await host.RunAsync(cts.Token, "Application started. Press Ctrl+C to shut down.");
lifetime.SetExitedGracefully();
}
finally
{
done.Set();
}
}
}
}
private static async Task RunAsync(this IWebHost host, CancellationToken token, string? startupMessage)
{
try
{
await host.StartAsync(token);
var hostingEnvironment = host.Services.GetService<IHostEnvironment>();
var options = host.Services.GetRequiredService<WebHostOptions>();
if (!options.SuppressStatusMessages)
{
Console.WriteLine($"Hosting environment: {hostingEnvironment?.EnvironmentName}");
Console.WriteLine($"Content root path: {hostingEnvironment?.ContentRootPath}");
var serverAddresses = host.ServerFeatures.Get<IServerAddressesFeature>()?.Addresses;
if (serverAddresses != null)
{
foreach (var address in serverAddresses)
{
Console.WriteLine($"Now listening on: {address}");
}
}
if (!string.IsNullOrEmpty(startupMessage))
{
Console.WriteLine(startupMessage);
}
}
await host.WaitForTokenShutdownAsync(token);
}
finally
{
if (host is IAsyncDisposable asyncDisposable)
{
await asyncDisposable.DisposeAsync().ConfigureAwait(false);
}
else
{
host.Dispose();
}
}
}
private static async Task WaitForTokenShutdownAsync(this IWebHost host, CancellationToken cancellationToken)
{
var applicationLifetime = host.Services.GetRequiredService<IHostApplicationLifetime>();
cancellationToken.Register(state =>
{
((IHostApplicationLifetime)state!).StopApplication();
},
applicationLifetime);
await Task.Delay(Timeout.Infinite, applicationLifetime.ApplicationStopping)
.ConfigureAwait(ConfigureAwaitOptions.SuppressThrowing | ConfigureAwaitOptions.ContinueOnCapturedContext);
// WebHost will use its default ShutdownTimeout if none is specified.
#pragma warning disable CA2016 // Forward the 'CancellationToken' parameter to methods. StopAsync should not be canceled by the token to RunAsync.
await host.StopAsync();
#pragma warning restore CA2016
}
}
|