Adding SendEventAsync overload which takes a predicate against IServerSentEventsClient as a parameter (#23)

Author: tpeczek

Lib.AspNetCore.ServerSentEvents/IServerSentEventsService.cs

@@ -80,6 +80,14 @@ public interface IServerSentEventsService
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(string text);
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(string text, Func<IServerSentEventsClient, bool> clientPredicate);
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -88,6 +96,15 @@ public interface IServerSentEventsService
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(string groupName, string text);
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(string groupName, string text, Func<IServerSentEventsClient, bool> clientPredicate);
+
         /// <summary>
         /// Sends event to all clients.
         /// </summary>
@@ -96,6 +113,15 @@ public interface IServerSentEventsService
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(string text, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(string text, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken);
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -105,13 +131,31 @@ public interface IServerSentEventsService
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(string groupName, string text, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(string groupName, string text, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken);
+
         /// <summary>
         /// Sends event to all clients.
         /// </summary>
         /// <param name="serverSentEvent">The event.</param>
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(ServerSentEvent serverSentEvent);
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate);
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -120,6 +164,15 @@ public interface IServerSentEventsService
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent);
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate);
+
         /// <summary>
         /// Sends event to all clients.
         /// </summary>
@@ -128,6 +181,15 @@ public interface IServerSentEventsService
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(ServerSentEvent serverSentEvent, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken);
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -137,6 +199,16 @@ public interface IServerSentEventsService
         /// <returns>The task object representing the asynchronous operation.</returns>
         Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken);
+
         /// <summary>
         /// Method which is called when client is establishing the connection. The base implementation raises the <see cref="ClientConnected"/> event.
         /// </summary>

Lib.AspNetCore.ServerSentEvents/ServerSentEventsService.cs

@@ -160,6 +160,17 @@ public Task SendEventAsync(string text)
             return SendAsync(ServerSentEventsHelper.GetEventBytes(text), CancellationToken.None);
         }
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(string text, Func<IServerSentEventsClient, bool> clientPredicate)
+        {
+            return SendAsync(ServerSentEventsHelper.GetEventBytes(text), clientPredicate, CancellationToken.None);
+        }
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -171,6 +182,18 @@ public Task SendEventAsync(string groupName, string text)
             return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(text), CancellationToken.None);
         }
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(string groupName, string text, Func<IServerSentEventsClient, bool> clientPredicate)
+        {
+            return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(text), clientPredicate, CancellationToken.None);
+        }
+
         /// <summary>
         /// Sends event to all clients.
         /// </summary>
@@ -182,6 +205,18 @@ public Task SendEventAsync(string text, CancellationToken cancellationToken)
             return SendAsync(ServerSentEventsHelper.GetEventBytes(text), cancellationToken);
         }
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(string text, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken)
+        {
+            return SendAsync(ServerSentEventsHelper.GetEventBytes(text), clientPredicate, cancellationToken);
+        }
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -194,6 +229,19 @@ public Task SendEventAsync(string groupName, string text, CancellationToken canc
             return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(text), cancellationToken);
         }
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="text">The simple text event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(string groupName, string text, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken)
+        {
+            return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(text), clientPredicate, cancellationToken);
+        }
+
         /// <summary>
         /// Sends event to all clients.
         /// </summary>
@@ -204,6 +252,17 @@ public Task SendEventAsync(ServerSentEvent serverSentEvent)
             return SendAsync(ServerSentEventsHelper.GetEventBytes(serverSentEvent), CancellationToken.None);
         }
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate)
+        {
+            return SendAsync(ServerSentEventsHelper.GetEventBytes(serverSentEvent), clientPredicate, CancellationToken.None);
+        }
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -215,6 +274,18 @@ public Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent)
             return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(serverSentEvent), CancellationToken.None);
         }
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate)
+        {
+            return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(serverSentEvent), clientPredicate, CancellationToken.None);
+        }
+
         /// <summary>
         /// Sends event to all clients.
         /// </summary>
@@ -226,6 +297,18 @@ public Task SendEventAsync(ServerSentEvent serverSentEvent, CancellationToken ca
             return SendAsync(ServerSentEventsHelper.GetEventBytes(serverSentEvent), cancellationToken);
         }
 
+        /// <summary>
+        /// Sends event to all clients.
+        /// </summary>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken)
+        {
+            return SendAsync(ServerSentEventsHelper.GetEventBytes(serverSentEvent), clientPredicate, cancellationToken);
+        }
+
         /// <summary>
         /// Sends event to clients in group.
         /// </summary>
@@ -238,6 +321,19 @@ public Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent, Ca
             return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(serverSentEvent), cancellationToken);
         }
 
+        /// <summary>
+        /// Sends event to clients in group.
+        /// </summary>
+        /// <param name="groupName">The group name.</param>
+        /// <param name="serverSentEvent">The event.</param>
+        /// <param name="clientPredicate">The function to test each client for a condition.</param>
+        /// <param name="cancellationToken">The cancellation token to cancel operation.</param>
+        /// <returns>The task object representing the asynchronous operation.</returns>
+        public Task SendEventAsync(string groupName, ServerSentEvent serverSentEvent, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken)
+        {
+            return SendAsync(groupName, ServerSentEventsHelper.GetEventBytes(serverSentEvent), clientPredicate, cancellationToken);
+        }
+
         /// <summary>
         /// Method which is called when client is establishing the connection. The base implementation raises the <see cref="ClientConnected"/> event.
         /// </summary>
@@ -316,6 +412,11 @@ internal Task SendAsync(ServerSentEventBytes serverSentEventBytes, CancellationT
             return SendAsync(_clients.Values, serverSentEventBytes, cancellationToken);
         }
 
+        internal Task SendAsync(ServerSentEventBytes serverSentEventBytes, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken)
+        {
+            return SendAsync(_clients.Values.Where(clientPredicate), serverSentEventBytes, cancellationToken);
+        }
+
         internal Task SendAsync(string groupName, ServerSentEventBytes serverSentEventBytes, CancellationToken cancellationToken)
         {
             if (_groups.ContainsKey(groupName))
@@ -326,7 +427,17 @@ internal Task SendAsync(string groupName, ServerSentEventBytes serverSentEventBy
             return Task.CompletedTask;
         }
 
-        internal Task SendAsync(ICollection<IServerSentEventsClient> clients, ServerSentEventBytes serverSentEventBytes, CancellationToken cancellationToken)
+        internal Task SendAsync(string groupName, ServerSentEventBytes serverSentEventBytes, Func<IServerSentEventsClient, bool> clientPredicate, CancellationToken cancellationToken)
+        {
+            if (_groups.ContainsKey(groupName))
+            {
+                return SendAsync(_groups[groupName].Values.Where(clientPredicate), serverSentEventBytes, cancellationToken);
+            }
+
+            return Task.CompletedTask;
+        }
+
+        internal Task SendAsync(IEnumerable<IServerSentEventsClient> clients, ServerSentEventBytes serverSentEventBytes, CancellationToken cancellationToken)
         {
             List<Task> clientsTasks = null;