Enforcing options based constructor for derived ServerSentEventService. Resolves #33

Author: tpeczek

Benchmark.AspNetCore.ServerSentEvents/Benchmarks/ServerSentEventsServiceBenchmarks.cs

@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using System.Security.Claims;
 using System.Collections.Generic;
+using Microsoft.Extensions.Options;
 using BenchmarkDotNet.Attributes;
 using Lib.AspNetCore.ServerSentEvents;
 using Lib.AspNetCore.ServerSentEvents.Internals;
@@ -34,7 +35,7 @@ public ServerSentEventsServiceBenchmarks()
         {
             _serverSentEventsClient = new ServerSentEventsClient(Guid.NewGuid(), new ClaimsPrincipal(), new NoOpHttpResponse());
 
-            _serverSentEventsService = new ServerSentEventsService();
+            _serverSentEventsService = new ServerSentEventsService(Options.Create<ServerSentEventsServiceOptions<ServerSentEventsService>>(null));
             for (int i = 0; i < MULTIPLE_CLIENTS_COUNT; i++)
             {
                 _serverSentEventsService.AddClient(new ServerSentEventsClient(Guid.NewGuid(), new ClaimsPrincipal(), new NoOpHttpResponse()));

DocFx.AspNetCore.ServerSentEvents/articles/getting-started.md

@@ -27,14 +27,18 @@ public class Startup
 }
 ```
 
-The `AddServerSendEvents()` method registers default service which provides operations over Server-Sent Events protocol, while `MapServerSentEvents()` maps this service to a specific endpoint. The `MapServerSentEvents()` method can be called multiple times for different endpoints but all of them will be mapped to same service which will make them indistinguishable from application perspective. In order to create distinguishable endpoints a delivered version of [`Server​Sent​Events​Service`](../api/Lib.AspNetCore.ServerSentEvents.ServerSentEventsService.html) should be registered (it doesn't need to override any of the default service functionality). Below is an example of such configuration.
+The `AddServerSendEvents()` method registers default service which provides operations over Server-Sent Events protocol, while `MapServerSentEvents()` maps this service to a specific endpoint. The `MapServerSentEvents()` method can be called multiple times for different endpoints but all of them will be mapped to same service which will make them indistinguishable from application perspective. In order to create distinguishable endpoints a delivered version of [`Server​Sent​Events​Service`](../api/Lib.AspNetCore.ServerSentEvents.ServerSentEventsService.html) should be registered. It doesn't need to override any of the default service functionality, just provide a constructor which can take a service specific options. Below is an example of such configuration.
 
 ```cs
 internal interface INotificationsServerSentEventsService : IServerSentEventsService
 { }
 
 internal class NotificationsServerSentEventsService : ServerSentEventsService, INotificationsServerSentEventsService
-{ }
+{
+    public NotificationsServerSentEventsService(IOptions<ServerSentEventsServiceOptions<NotificationsServerSentEventsService>> options)
+        : base(options.ToBaseServerSentEventsServiceOptions())
+    { }
+}
 
 public class Startup
 {

Lib.AspNetCore.ServerSentEvents/Extensions/OptionsExtensions.cs

@@ -0,0 +1,37 @@
+using Microsoft.Extensions.Options;
+
+namespace Lib.AspNetCore.ServerSentEvents
+{
+    /// <summary>
+    /// The <see cref="ServerSentEventsServiceOptions{TServerSentEventsService}"/> options related extensions.
+    /// </summary>
+    public static class OptionsExtensions
+    {
+        /// <summary>
+        /// Converts an instace of <see cref="ServerSentEventsServiceOptions{TServerSentEventsService}"/> to <see cref="ServerSentEventsServiceOptions{ServerSentEventsService}"/>.
+        /// </summary>
+        /// <typeparam name="TServerSentEventsService">The type of <see cref="ServerSentEventsService"/> for the options instance.</typeparam>
+        /// <param name="options">The options instance.</param>
+        /// <returns>The option instance</returns>
+        public static IOptions<ServerSentEventsServiceOptions<ServerSentEventsService>> ToBaseServerSentEventsServiceOptions<TServerSentEventsService>(this IOptions<ServerSentEventsServiceOptions<TServerSentEventsService>> options) where TServerSentEventsService : ServerSentEventsService
+        {
+            if (options is null)
+            {
+                return null;
+            }
+
+            if (options.Value is null)
+            {
+                return Options.Create<ServerSentEventsServiceOptions<ServerSentEventsService>>(null);
+            }
+
+            return Options.Create(new ServerSentEventsServiceOptions<ServerSentEventsService>
+            {
+                KeepaliveInterval = options.Value.KeepaliveInterval,
+                KeepaliveMode = options.Value.KeepaliveMode,
+                OnClientConnected = options.Value.OnClientConnected,
+                OnClientDisconnected = options.Value.OnClientDisconnected
+            });
+        }
+    }
+}

Lib.AspNetCore.ServerSentEvents/Lib.AspNetCore.ServerSentEvents.csproj

@@ -2,8 +2,8 @@
   <PropertyGroup>
     <Description>Lib.AspNetCore.ServerSentEvents is a library which provides Server-Sent Events (SSE) support for ASP.NET Core</Description>
     <Copyright>Copyright © 2017 - 2020 Tomasz Pęczek</Copyright>
-    <VersionPrefix>4.1.0</VersionPrefix>
-    <VersionSuffix></VersionSuffix>
+    <VersionPrefix>5.0.0</VersionPrefix>
+    <VersionSuffix>alpha1</VersionSuffix>
     <Authors>Tomasz Pęczek</Authors>
     <TargetFrameworks>netcoreapp2.1;netcoreapp3.0;net461</TargetFrameworks>
     <AssemblyTitle>Lib.AspNetCore.ServerSentEvents</AssemblyTitle>

Lib.AspNetCore.ServerSentEvents/ServerSentEventsService.cs

@@ -36,12 +36,6 @@ public class ServerSentEventsService : IServerSentEventsService
         #endregion
 
         #region Constructors
-        /// <summary>
-        /// Initializes new instance of <see cref="ServerSentEventsService"/>.
-        /// </summary>
-        public ServerSentEventsService()
-        { }
-
         /// <summary>
         /// Initializes new instance of <see cref="ServerSentEventsService"/>.
         /// </summary>