From 99df9c8fcd337ff0d3b237e9ee505d5a1008700b Mon Sep 17 00:00:00 2001
From: luke92brown <luke92brown@gmail.com>
Date: Mon, 9 May 2022 22:00:30 -0500
Subject: [PATCH] Replace redundant xml comments with inheritdoc. Make async
 changes to CloseSocket.

---
 Emby.Dlna/PlayTo/PlayToController.cs                     | 4 ++--
 .../HttpServer/WebSocketConnection.cs                    | 9 +++------
 Emby.Server.Implementations/Session/SessionManager.cs    | 6 +++---
 .../Session/WebSocketController.cs                       | 9 +++------
 MediaBrowser.Controller/Net/IWebSocketConnection.cs      | 3 ++-
 MediaBrowser.Controller/Session/ISessionController.cs    | 3 ++-
 6 files changed, 15 insertions(+), 19 deletions(-)

diff --git a/Emby.Dlna/PlayTo/PlayToController.cs b/Emby.Dlna/PlayTo/PlayToController.cs
index 3d36a50454..bb2eedfb4f 100644
--- a/Emby.Dlna/PlayTo/PlayToController.cs
+++ b/Emby.Dlna/PlayTo/PlayToController.cs
@@ -889,9 +889,9 @@ namespace Emby.Dlna.PlayTo
             return Task.CompletedTask;
         }
 
-        public void CloseAllWebSockets(CancellationToken cancellationToken)
+        /// <inheritdoc />
+        public async Task CloseAllWebSockets(CancellationToken cancellationToken)
         {
-            throw new NotImplementedException();
         }
 
         private class StreamParams
diff --git a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
index 2c5ec81ada..331b5aa37a 100644
--- a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
+++ b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
@@ -231,13 +231,10 @@ namespace Emby.Server.Implementations.HttpServer
                 CancellationToken.None);
         }
 
-        /// <summary>
-        /// Gracefully closes the socket.
-        /// </summary>
-        /// <param name="cancellationToken">The cancellation token.</param>
-        public void CloseSocket(CancellationToken cancellationToken)
+        /// <inheritdoc />
+        public async Task CloseSocket(CancellationToken cancellationToken)
         {
-            _socket.CloseOutputAsync(WebSocketCloseStatus.NormalClosure, "System Shutdown", cancellationToken);
+            await _socket.CloseOutputAsync(WebSocketCloseStatus.NormalClosure, "System Shutdown", cancellationToken).ConfigureAwait(false);
         }
 
         /// <inheritdoc />
diff --git a/Emby.Server.Implementations/Session/SessionManager.cs b/Emby.Server.Implementations/Session/SessionManager.cs
index 0d2d0e5176..be0d14ea2c 100644
--- a/Emby.Server.Implementations/Session/SessionManager.cs
+++ b/Emby.Server.Implementations/Session/SessionManager.cs
@@ -1363,7 +1363,7 @@ namespace Emby.Server.Implementations.Session
         {
             CheckDisposed();
 
-            CloseAllWebSockets(cancellationToken);
+            CloseAllWebSockets(cancellationToken).ConfigureAwait(false);
 
             return SendMessageToSessions(Sessions, SessionMessageType.ServerShuttingDown, string.Empty, cancellationToken);
         }
@@ -1372,13 +1372,13 @@ namespace Emby.Server.Implementations.Session
         /// Gracefully closes all web sockets in all sessions.
         /// </summary>
         /// <param name="cancellationToken">The cancellation token.</param>
-        private void CloseAllWebSockets(CancellationToken cancellationToken)
+        private async Task CloseAllWebSockets(CancellationToken cancellationToken)
         {
             foreach (var session in Sessions)
             {
                 foreach (var sessionController in session.SessionControllers)
                 {
-                    sessionController.CloseAllWebSockets(cancellationToken);
+                    await sessionController.CloseAllWebSockets(cancellationToken).ConfigureAwait(false);
                 }
             }
         }
diff --git a/Emby.Server.Implementations/Session/WebSocketController.cs b/Emby.Server.Implementations/Session/WebSocketController.cs
index 16312ffb81..f9757a0af5 100644
--- a/Emby.Server.Implementations/Session/WebSocketController.cs
+++ b/Emby.Server.Implementations/Session/WebSocketController.cs
@@ -88,15 +88,12 @@ namespace Emby.Server.Implementations.Session
                 cancellationToken);
         }
 
-        /// <summary>
-        /// Gracefully closes all web sockets.
-        /// </summary>
-        /// <param name="cancellationToken">The cancellation token.</param>
-        public void CloseAllWebSockets(CancellationToken cancellationToken)
+        /// <inheritdoc />
+        public async Task CloseAllWebSockets(CancellationToken cancellationToken)
         {
             foreach (var socket in _sockets)
             {
-                socket.CloseSocket(cancellationToken);
+                await socket.CloseSocket(cancellationToken).ConfigureAwait(false);
             }
         }
 
diff --git a/MediaBrowser.Controller/Net/IWebSocketConnection.cs b/MediaBrowser.Controller/Net/IWebSocketConnection.cs
index c53199de6b..cea2049fd7 100644
--- a/MediaBrowser.Controller/Net/IWebSocketConnection.cs
+++ b/MediaBrowser.Controller/Net/IWebSocketConnection.cs
@@ -62,7 +62,8 @@ namespace MediaBrowser.Controller.Net
         /// <summary>
         /// Gracefully closes the socket.
         /// </summary>
+        /// <returns>Task.</returns>
         /// <param name="cancellationToken">The cancellation token.</param>
-        void CloseSocket(CancellationToken cancellationToken);
+        Task CloseSocket(CancellationToken cancellationToken);
     }
 }
diff --git a/MediaBrowser.Controller/Session/ISessionController.cs b/MediaBrowser.Controller/Session/ISessionController.cs
index 3db79076da..3acfe19a27 100644
--- a/MediaBrowser.Controller/Session/ISessionController.cs
+++ b/MediaBrowser.Controller/Session/ISessionController.cs
@@ -38,6 +38,7 @@ namespace MediaBrowser.Controller.Session
         /// Gracefully closes all web sockets.
         /// </summary>
         /// <param name="cancellationToken">The cancellation token.</param>
-        void CloseAllWebSockets(CancellationToken cancellationToken);
+        /// <returns>A task.</returns>
+        Task CloseAllWebSockets(CancellationToken cancellationToken);
     }
 }