[v3.0.0] Lib.AspNetCore.ServerSentEvents

Author: tpeczek

CHANGELOG.md

@@ -1,3 +1,9 @@
+## Lib.AspNetCore.ServerSentEvents 3.0.0
+### Additions and Changes
+- Added support for client connected and disconnected events.
+- Improved support for CancellationToken in asynchronous operations.
+- Hot synchronous path performance improvements.
+
 ## Lib.AspNetCore.ServerSentEvents 2.0.0
 ### Additions and Changes
 - Upgraded to .NET Standard 2.0 and ASP.NET Core 2.0.

DocFx.AspNetCore.ServerSentEvents/DocFx.AspNetCore.ServerSentEvents.csproj

@@ -1,6 +1,6 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFramework>netcoreapp2.0</TargetFramework>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
     <None Remove="log.txt" />
@@ -10,6 +10,6 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="docfx.console" Version="2.36.2" />
-    <PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.8" />
+    <PackageReference Include="Microsoft.AspNetCore.All" />
   </ItemGroup>
 </Project>

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

@@ -88,7 +88,11 @@ The `IServerSentEventsService.GetClients()` method returns list of all currently
 
 ## Handling Auto Reconnect
 
-Server-Sent Events provide auto reconnect and tracking of the last seen message functionality. If the connection is dropped, client will automatically reconnect to the server and optionally advertise the identifier of the last seen message. This allows for retransmission of lost messages. In order to use this mechanism the `OnReconnectAsync` method must be overridden when delivering from `Server​Sent​Events​Service`. When client reconnects the method will be called with `IServerSentEventsClient` representing the client and the identifier of last message which client has received.
+Server-Sent Events provide auto reconnect and tracking of the last seen message functionality. If the connection is dropped, client will automatically reconnect to the server and optionally advertise the identifier of the last seen message. This allows for retransmission of lost messages.
+
+In order to use this mechanism one can subscribe to `IServerSentEventsService.ClientConnected` event. When client reconnects the event will be raised and `ServerSentEventsClientConnectedArgs.LastEventId` will provide an identifier of last message which client has received. At this point `ServerSentEventsClientConnectedArgs.Client` can be used to send any missed messages.
+
+Alternative approach is to override `OnReconnectAsync` method when delivering from `Server​Sent​Events​Service`. When client reconnects the method will be called with `IServerSentEventsClient` representing the client and an identifier of last message which client has received. When overriding `OnReconnectAsync` the base implementation should be called as it's responsible for triggering `ClientConnected` event.
 
 ### Changing Reconnect Interval
 

DocFx.AspNetCore.ServerSentEvents/index.md

@@ -22,6 +22,7 @@ There are some blog posts available which describe implementation details and so
 
 - [Server-Sent Events (SSE) support for ASP.NET Core](https://www.tpeczek.com/2017/02/server-sent-events-sse-support-for.html)
 - [Server-Sent Events (or WebSockets) broadcasting in load balancing scenario with Redis](https://www.tpeczek.com/2017/09/server-sent-events-or-websockets.html)
+- [Server-Sent Events and ASP.NET Core - You may need keep alives](https://www.tpeczek.com/2018/08/server-sent-events-and-aspnet-core-you_9.html)
 
 ## Donating
 

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

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <Description>Lib.AspNetCore.ServerSentEvents is a library which provides Server-Sent Events (SSE) support for ASP.NET Core</Description>
     <Copyright>Copyright © 2017 - 2018 Tomasz Pęczek</Copyright>
-    <VersionPrefix>2.0.0</VersionPrefix>
+    <VersionPrefix>3.0.0</VersionPrefix>
     <Authors>Tomasz Pęczek</Authors>
     <TargetFramework>netstandard2.0</TargetFramework>
     <AssemblyTitle>Lib.AspNetCore.ServerSentEvents</AssemblyTitle>

README.md

@@ -25,6 +25,7 @@ There are some blog posts available which describe implementation details and so
 
 - [Server-Sent Events (SSE) support for ASP.NET Core](https://www.tpeczek.com/2017/02/server-sent-events-sse-support-for.html)
 - [Server-Sent Events (or WebSockets) broadcasting in load balancing scenario with Redis](https://www.tpeczek.com/2017/09/server-sent-events-or-websockets.html)
+- [Server-Sent Events and ASP.NET Core - You may need keep alives](https://www.tpeczek.com/2018/08/server-sent-events-and-aspnet-core-you_9.html)
 
 ## Donating