Clean up code (the bool from bool OnPowerEvent is ignored anyway), add comments.

Author: CodeCasterNL

src/CodeCaster.WindowsServiceExtensions/IPowerEventAwareHostedService.cs

@@ -3,8 +3,14 @@
 
 namespace CodeCaster.WindowsServiceExtensions
 {
+    /// <summary>
+    /// An <see cref="IHostedService"/> that runs as a Windows Service that can react to power state changes.
+    /// </summary>
     public interface IPowerEventAwareHostedService : IHostedService
     {
-        bool OnPowerEvent(PowerBroadcastStatus powerStatus);
+        /// <summary>
+        /// Called when a power event is sent by the OS.
+        /// </summary>
+        void OnPowerEvent(PowerBroadcastStatus powerStatus);
     }
 }

src/CodeCaster.WindowsServiceExtensions/PowerEventAwareBackgroundService.cs

@@ -3,15 +3,16 @@
 
 namespace CodeCaster.WindowsServiceExtensions
 {
+    /// <summary>
+    /// Base class for implementing a long running <see cref="IHostedService"/> as a Windows Service that can react to power state changes.
+    /// </summary>
     public abstract class PowerEventAwareBackgroundService : BackgroundService, IPowerEventAwareHostedService
     {
         /// <summary>
         /// Override this method to react to power state changes.
         /// </summary>
-        /// <returns>Return false to deny the power change status request.</returns>
-        public virtual bool OnPowerEvent(PowerBroadcastStatus powerStatus)
+        public virtual void OnPowerEvent(PowerBroadcastStatus powerStatus)
         {
-            return true;
         }
     }
 }

src/CodeCaster.WindowsServiceExtensions/PowerEventAwareWindowsServiceLifetime.cs

@@ -13,7 +13,7 @@
 namespace CodeCaster.WindowsServiceExtensions
 {
     /// <summary>
-    /// Basically the same as <see cref="WindowsServiceLifetime"/>, but responds to 
+    /// Basically the same as <see cref="WindowsServiceLifetime"/>, but states it can handle power events, and forwards those to the IHostedServices that claim to be capable of the same.
     /// </summary>
     public class PowerEventAwareWindowsServiceLifetime : WindowsServiceLifetime, IHostLifetime
     {
@@ -67,6 +67,7 @@ public PowerEventAwareWindowsServiceLifetime(IServiceProvider serviceProvider, I
             }
         }
 
+        /// <inheritdoc />
         protected override bool OnPowerEvent(PowerBroadcastStatus powerStatus)
         {
             _logger.LogInformation($"Windows Service power event: {powerStatus}");
@@ -77,18 +78,14 @@ protected override bool OnPowerEvent(PowerBroadcastStatus powerStatus)
                 return true;
             }
 
-            var acceptEvent = true;
-
+            // Forward the event to all registered I(PowerEventAware)HostedServices.
             foreach (var service in _hostedServices)
             {
-                if (!service.OnPowerEvent(powerStatus))
-                {
-                    // If any of the hosted services returns false, we deny the power status change request by returning false from this method (does that even work?)
-                    acceptEvent = false;
-                }
+                service.OnPowerEvent(powerStatus);
             }
 
-            return acceptEvent;
+            // Ignored anyway.
+            return true;
         }
 
         protected override void OnStart(string[] args)
@@ -104,6 +101,7 @@ protected override void OnStart(string[] args)
             if (!_applicationLifetime.ApplicationStarted.IsCancellationRequested)
             {
                 // Usually very early in the startup process, so this may not be logged nor reported at all.
+                // But it's here to prevent the service from happily reporting successful startup, while the .NET Core ApplicationHost isn't started at all.
                 const string errorString = "Windows Service failed to start";
                 _logger.LogError(errorString);
                 throw new Exception(errorString);

src/CodeCaster.WindowsServiceExtensions/WindowsServiceLifetimeHostBuilderExtensionsAdapter.cs

@@ -12,7 +12,7 @@ namespace CodeCaster.WindowsServiceExtensions
     public static class WindowsServiceLifetimeHostBuilderExtensionsAdapter
     {
         /// <summary>
-        /// Sets the host lifetime to <see cref="PowerEventAwareWindowsServiceLifetime"/> and does whatever <see cref="WindowsServiceLifetimeHostBuilderExtensions.UseWindowsService(Microsoft.Extensions.Hosting.IHostBuilder)"/> does.
+        /// Sets the host lifetime to <see cref="PowerEventAwareWindowsServiceLifetime"/> and does whatever <see cref="WindowsServiceLifetimeHostBuilderExtensions.UseWindowsService(IHostBuilder)"/> does.
         /// </summary>
         /// <param name="hostBuilder">The Microsoft.Extensions.Hosting.IHostBuilder to operate on.</param>
         /// <returns>The same instance of the Microsoft.Extensions.Hosting.IHostBuilder for chaining.</returns>
@@ -23,7 +23,7 @@ public static IHostBuilder UsePowerEventAwareWindowsService(this IHostBuilder ho
         }
 
         /// <summary>
-        /// Sets the host lifetime to <see cref="PowerEventAwareWindowsServiceLifetime"/> and does whatever <see cref="WindowsServiceLifetimeHostBuilderExtensions.UseWindowsService(Microsoft.Extensions.Hosting.IHostBuilder)"/> does.
+        /// Sets the host lifetime to <see cref="PowerEventAwareWindowsServiceLifetime"/> and does whatever <see cref="WindowsServiceLifetimeHostBuilderExtensions.UseWindowsService(IHostBuilder)"/> does.
         /// </summary>
         /// <param name="hostBuilder">The Microsoft.Extensions.Hosting.IHostBuilder to operate on.</param>
         /// <param name="configure">An action to configure the lifetime's options.</param>