// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Threading;
using Microsoft.Extensions.Logging;
namespace Microsoft.AspNetCore.Hosting.Internal
{
///
/// Allows consumers to perform cleanup during a graceful shutdown.
///
public class ApplicationLifetime : IApplicationLifetime
{
private readonly CancellationTokenSource _startedSource = new CancellationTokenSource();
private readonly CancellationTokenSource _stoppingSource = new CancellationTokenSource();
private readonly CancellationTokenSource _stoppedSource = new CancellationTokenSource();
private readonly ILogger _logger;
public ApplicationLifetime(ILogger logger)
{
_logger = logger;
}
///
/// Triggered when the application host has fully started and is about to wait
/// for a graceful shutdown.
///
public CancellationToken ApplicationStarted => _startedSource.Token;
///
/// Triggered when the application host is performing a graceful shutdown.
/// Request may still be in flight. Shutdown will block until this event completes.
///
public CancellationToken ApplicationStopping => _stoppingSource.Token;
///
/// Triggered when the application host is performing a graceful shutdown.
/// All requests should be complete at this point. Shutdown will block
/// until this event completes.
///
public CancellationToken ApplicationStopped => _stoppedSource.Token;
///
/// Signals the ApplicationStopping event and blocks until it completes.
///
public void StopApplication()
{
// Lock on CTS to synchronize multiple calls to StopApplication. This guarantees that the first call
// to StopApplication and its callbacks run to completion before subsequent calls to StopApplication,
// which will no-op since the first call already requested cancellation, get a chance to execute.
lock (_stoppingSource)
{
try
{
ExecuteHandlers(_stoppingSource);
}
catch (Exception ex)
{
_logger.ApplicationError(LoggerEventIds.ApplicationStoppingException,
"An error occurred stopping the application",
ex);
}
}
}
///
/// Signals the ApplicationStarted event and blocks until it completes.
///
public void NotifyStarted()
{
try
{
ExecuteHandlers(_startedSource);
}
catch (Exception ex)
{
_logger.ApplicationError(LoggerEventIds.ApplicationStartupException,
"An error occurred starting the application",
ex);
}
}
///
/// Signals the ApplicationStopped event and blocks until it completes.
///
public void NotifyStopped()
{
try
{
ExecuteHandlers(_stoppedSource);
}
catch (Exception ex)
{
_logger.ApplicationError(LoggerEventIds.ApplicationStoppedException,
"An error occurred stopping the application",
ex);
}
}
private void ExecuteHandlers(CancellationTokenSource cancel)
{
// Noop if this is already cancelled
if (cancel.IsCancellationRequested)
{
return;
}
// Run the cancellation token callbacks
cancel.Cancel(throwOnFirstException: false);
}
}
}