From 42ffddc26932bcf2da762bf4fe1ec4bdc42e8166 Mon Sep 17 00:00:00 2001
From: Bond_009 <bond.009@outlook.com>
Date: Fri, 1 Nov 2019 18:38:54 +0100
Subject: Fix more warnings

---
 .../HttpServer/WebSocketConnection.cs              | 110 +++++++++++----------
 1 file changed, 57 insertions(+), 53 deletions(-)

(limited to 'Emby.Server.Implementations/HttpServer/WebSocketConnection.cs')

diff --git a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
index 54a16040f..5d657b8a7 100644
--- a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
+++ b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
@@ -7,7 +7,6 @@ using Emby.Server.Implementations.Net;
 using MediaBrowser.Controller.Net;
 using MediaBrowser.Model.Net;
 using MediaBrowser.Model.Serialization;
-using MediaBrowser.Model.Services;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Logging;
 using UtfUnknown;
@@ -15,60 +14,24 @@ using UtfUnknown;
 namespace Emby.Server.Implementations.HttpServer
 {
     /// <summary>
-    /// Class WebSocketConnection
+    /// Class WebSocketConnection.
     /// </summary>
     public class WebSocketConnection : IWebSocketConnection
     {
-        public event EventHandler<EventArgs> Closed;
-
-        /// <summary>
-        /// The _socket
-        /// </summary>
-        private readonly IWebSocket _socket;
-
         /// <summary>
-        /// The _remote end point
-        /// </summary>
-        public string RemoteEndPoint { get; private set; }
-
-        /// <summary>
-        /// The logger
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
 
         /// <summary>
-        /// The _json serializer
+        /// The _json serializer.
         /// </summary>
         private readonly IJsonSerializer _jsonSerializer;
 
         /// <summary>
-        /// Gets or sets the receive action.
-        /// </summary>
-        /// <value>The receive action.</value>
-        public Func<WebSocketMessageInfo, Task> OnReceive { get; set; }
-
-        /// <summary>
-        /// Gets the last activity date.
-        /// </summary>
-        /// <value>The last activity date.</value>
-        public DateTime LastActivityDate { get; private set; }
-
-        /// <summary>
-        /// Gets the id.
+        /// The _socket.
         /// </summary>
-        /// <value>The id.</value>
-        public Guid Id { get; private set; }
-
-        /// <summary>
-        /// Gets or sets the URL.
-        /// </summary>
-        /// <value>The URL.</value>
-        public string Url { get; set; }
-        /// <summary>
-        /// Gets or sets the query string.
-        /// </summary>
-        /// <value>The query string.</value>
-        public IQueryCollection QueryString { get; set; }
+        private readonly IWebSocket _socket;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="WebSocketConnection" /> class.
@@ -84,14 +47,17 @@ namespace Emby.Server.Implementations.HttpServer
             {
                 throw new ArgumentNullException(nameof(socket));
             }
+
             if (string.IsNullOrEmpty(remoteEndPoint))
             {
                 throw new ArgumentNullException(nameof(remoteEndPoint));
             }
+
             if (jsonSerializer == null)
             {
                 throw new ArgumentNullException(nameof(jsonSerializer));
             }
+
             if (logger == null)
             {
                 throw new ArgumentNullException(nameof(logger));
@@ -105,10 +71,54 @@ namespace Emby.Server.Implementations.HttpServer
             RemoteEndPoint = remoteEndPoint;
             _logger = logger;
 
-            socket.Closed += socket_Closed;
+            socket.Closed += OnSocketClosed;
         }
 
-        void socket_Closed(object sender, EventArgs e)
+        /// <inheritdoc />
+        public event EventHandler<EventArgs> Closed;
+
+        /// <summary>
+        /// Gets or sets the _remote end point.
+        /// </summary>
+        public string RemoteEndPoint { get; private set; }
+
+        /// <summary>
+        /// Gets or sets the receive action.
+        /// </summary>
+        /// <value>The receive action.</value>
+        public Func<WebSocketMessageInfo, Task> OnReceive { get; set; }
+
+        /// <summary>
+        /// Gets the last activity date.
+        /// </summary>
+        /// <value>The last activity date.</value>
+        public DateTime LastActivityDate { get; private set; }
+
+        /// <summary>
+        /// Gets the id.
+        /// </summary>
+        /// <value>The id.</value>
+        public Guid Id { get; private set; }
+
+        /// <summary>
+        /// Gets or sets the URL.
+        /// </summary>
+        /// <value>The URL.</value>
+        public string Url { get; set; }
+
+        /// <summary>
+        /// Gets or sets the query string.
+        /// </summary>
+        /// <value>The query string.</value>
+        public IQueryCollection QueryString { get; set; }
+
+        /// <summary>
+        /// Gets the state.
+        /// </summary>
+        /// <value>The state.</value>
+        public WebSocketState State => _socket.State;
+
+        void OnSocketClosed(object sender, EventArgs e)
         {
             Closed?.Invoke(this, EventArgs.Empty);
         }
@@ -210,6 +220,7 @@ namespace Emby.Server.Implementations.HttpServer
             return _socket.SendAsync(buffer, true, cancellationToken);
         }
 
+        /// <inheritdoc />
         public Task SendAsync(string text, CancellationToken cancellationToken)
         {
             if (string.IsNullOrEmpty(text))
@@ -222,18 +233,11 @@ namespace Emby.Server.Implementations.HttpServer
             return _socket.SendAsync(text, true, cancellationToken);
         }
 
-        /// <summary>
-        /// Gets the state.
-        /// </summary>
-        /// <value>The state.</value>
-        public WebSocketState State => _socket.State;
-
-        /// <summary>
-        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
-        /// </summary>
+        /// <inheritdoc />
         public void Dispose()
         {
             Dispose(true);
+            GC.SuppressFinalize(this);
         }
 
         /// <summary>
-- 
cgit v1.2.3


From affb58ef9e11f7f14192c76074b1199604f6bd67 Mon Sep 17 00:00:00 2001
From: Bond-009 <bond.009@outlook.com>
Date: Tue, 10 Dec 2019 16:22:03 +0100
Subject: Apply suggestions from code review

Co-Authored-By: dkanada <dkanada@users.noreply.github.com>
---
 Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs   | 2 +-
 .../Configuration/ServerConfigurationManager.cs                   | 2 +-
 Emby.Server.Implementations/Data/BaseSqliteRepository.cs          | 2 +-
 Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs   | 2 +-
 Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs    | 8 ++++----
 Emby.Server.Implementations/EntryPoints/StartupWizard.cs          | 4 ++--
 Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs    | 2 +-
 Emby.Server.Implementations/HttpServer/HttpResultFactory.cs       | 2 +-
 Emby.Server.Implementations/HttpServer/StreamWriter.cs            | 2 +-
 Emby.Server.Implementations/HttpServer/WebSocketConnection.cs     | 6 +++---
 Emby.Server.Implementations/Library/UserManager.cs                | 2 +-
 .../Library/Validators/ArtistsValidator.cs                        | 4 ++--
 Emby.Server.Implementations/Library/Validators/GenresValidator.cs | 4 ++--
 .../Library/Validators/MusicGenresPostScanTask.cs                 | 2 +-
 .../Library/Validators/MusicGenresValidator.cs                    | 4 ++--
 .../Library/Validators/StudiosValidator.cs                        | 4 ++--
 16 files changed, 26 insertions(+), 26 deletions(-)

(limited to 'Emby.Server.Implementations/HttpServer/WebSocketConnection.cs')

diff --git a/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs b/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
index f5ca8e144..edf68cf7c 100644
--- a/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
+++ b/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
@@ -351,7 +351,7 @@ namespace Emby.Server.Implementations.AppBase
         }
 
         /// <summary>
-        /// Event handler for when a named configuration got updates.
+        /// Event handler for when a named configuration has been updated.
         /// </summary>
         /// <param name="key">The key of the configuration.</param>
         /// <param name="configuration">The old configuration.</param>
diff --git a/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs b/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs
index 4def7ca40..3d8d15d19 100644
--- a/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs
+++ b/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs
@@ -150,7 +150,7 @@ namespace Emby.Server.Implementations.Configuration
         }
 
         /// <summary>
-        /// Sets all config values to the optimal value.
+        /// Sets all configuration values to their optimal values.
         /// </summary>
         /// <returns>If the configuration changed.</returns>
         public bool SetOptimalValues()
diff --git a/Emby.Server.Implementations/Data/BaseSqliteRepository.cs b/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
index 30f29beee..0654132f4 100644
--- a/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
+++ b/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
@@ -16,7 +16,7 @@ namespace Emby.Server.Implementations.Data
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseSqliteRepository"/> class.
         /// </summary>
-        /// <param name="logger">The ogger.</param>
+        /// <param name="logger">The logger.</param>
         protected BaseSqliteRepository(ILogger logger)
         {
             Logger = logger;
diff --git a/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs b/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs
index 1ca25ba6f..f00996b5f 100644
--- a/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs
+++ b/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs
@@ -18,7 +18,7 @@ namespace Emby.Server.Implementations.EntryPoints
         private readonly ILogger _logger;
 
         /// <summary>
-        /// The _user manager.
+        /// The user manager.
         /// </summary>
         private readonly IUserManager _userManager;
 
diff --git a/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs b/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs
index 9ccbf7535..e1dbb663b 100644
--- a/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs
+++ b/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs
@@ -21,22 +21,22 @@ namespace Emby.Server.Implementations.EntryPoints
     public class ServerEventNotifier : IServerEntryPoint
     {
         /// <summary>
-        /// The _user manager.
+        /// The user manager.
         /// </summary>
         private readonly IUserManager _userManager;
 
         /// <summary>
-        /// The _installation manager.
+        /// The installation manager.
         /// </summary>
         private readonly IInstallationManager _installationManager;
 
         /// <summary>
-        /// The _kernel.
+        /// The kernel.
         /// </summary>
         private readonly IServerApplicationHost _appHost;
 
         /// <summary>
-        /// The _task manager.
+        /// The task manager.
         /// </summary>
         private readonly ITaskManager _taskManager;
 
diff --git a/Emby.Server.Implementations/EntryPoints/StartupWizard.cs b/Emby.Server.Implementations/EntryPoints/StartupWizard.cs
index 9cef77dc8..161788c63 100644
--- a/Emby.Server.Implementations/EntryPoints/StartupWizard.cs
+++ b/Emby.Server.Implementations/EntryPoints/StartupWizard.cs
@@ -13,12 +13,12 @@ namespace Emby.Server.Implementations.EntryPoints
     public class StartupWizard : IServerEntryPoint
     {
         /// <summary>
-        /// The _app host.
+        /// The app host.
         /// </summary>
         private readonly IServerApplicationHost _appHost;
 
         /// <summary>
-        /// The _user manager.
+        /// The user manager.
         /// </summary>
         private readonly ILogger _logger;
 
diff --git a/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs b/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs
index 24ac6d1fd..9ee219854 100644
--- a/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs
+++ b/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs
@@ -20,7 +20,7 @@ namespace Emby.Server.Implementations.EntryPoints
         public const int PortNumber = 7359;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly ISocketFactory _socketFactory;
diff --git a/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs b/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
index f9eb3a897..a62b4e7af 100644
--- a/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
+++ b/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
@@ -29,7 +29,7 @@ namespace Emby.Server.Implementations.HttpServer
     public class HttpResultFactory : IHttpResultFactory
     {
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly IFileSystem _fileSystem;
diff --git a/Emby.Server.Implementations/HttpServer/StreamWriter.cs b/Emby.Server.Implementations/HttpServer/StreamWriter.cs
index eda236028..5afc51dbc 100644
--- a/Emby.Server.Implementations/HttpServer/StreamWriter.cs
+++ b/Emby.Server.Implementations/HttpServer/StreamWriter.cs
@@ -15,7 +15,7 @@ namespace Emby.Server.Implementations.HttpServer
     public class StreamWriter : IAsyncStreamWriter, IHasHeaders
     {
         /// <summary>
-        /// The _options.
+        /// The options.
         /// </summary>
         private readonly IDictionary<string, string> _options = new Dictionary<string, string>();
 
diff --git a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
index 5d657b8a7..2292d86a4 100644
--- a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
+++ b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
@@ -24,12 +24,12 @@ namespace Emby.Server.Implementations.HttpServer
         private readonly ILogger _logger;
 
         /// <summary>
-        /// The _json serializer.
+        /// The json serializer.
         /// </summary>
         private readonly IJsonSerializer _jsonSerializer;
 
         /// <summary>
-        /// The _socket.
+        /// The socket.
         /// </summary>
         private readonly IWebSocket _socket;
 
@@ -78,7 +78,7 @@ namespace Emby.Server.Implementations.HttpServer
         public event EventHandler<EventArgs> Closed;
 
         /// <summary>
-        /// Gets or sets the _remote end point.
+        /// Gets or sets the remote end point.
         /// </summary>
         public string RemoteEndPoint { get; private set; }
 
diff --git a/Emby.Server.Implementations/Library/UserManager.cs b/Emby.Server.Implementations/Library/UserManager.cs
index 1233dcc43..eaad05f92 100644
--- a/Emby.Server.Implementations/Library/UserManager.cs
+++ b/Emby.Server.Implementations/Library/UserManager.cs
@@ -43,7 +43,7 @@ namespace Emby.Server.Implementations.Library
     public class UserManager : IUserManager
     {
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
 
diff --git a/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs b/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs
index dbadaeefb..1497f4a3a 100644
--- a/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs
@@ -17,12 +17,12 @@ namespace Emby.Server.Implementations.Library.Validators
     public class ArtistsValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly IItemRepository _itemRepo;
diff --git a/Emby.Server.Implementations/Library/Validators/GenresValidator.cs b/Emby.Server.Implementations/Library/Validators/GenresValidator.cs
index 6478f1873..b0cd5f87a 100644
--- a/Emby.Server.Implementations/Library/Validators/GenresValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/GenresValidator.cs
@@ -13,13 +13,13 @@ namespace Emby.Server.Implementations.Library.Validators
     public class GenresValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
         private readonly IItemRepository _itemRepo;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
 
diff --git a/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs b/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs
index 1b5c83f1e..58549e9d7 100644
--- a/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs
+++ b/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs
@@ -13,7 +13,7 @@ namespace Emby.Server.Implementations.Library.Validators
     public class MusicGenresPostScanTask : ILibraryPostScanTask
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
         private readonly ILogger _logger;
diff --git a/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs b/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs
index 23a28e936..5ee4ca72e 100644
--- a/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs
@@ -13,12 +13,12 @@ namespace Emby.Server.Implementations.Library.Validators
     public class MusicGenresValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly IItemRepository _itemRepo;
diff --git a/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs b/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs
index 887eef5c3..15e7a0dbb 100644
--- a/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs
@@ -15,14 +15,14 @@ namespace Emby.Server.Implementations.Library.Validators
     public class StudiosValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
 
         private readonly IItemRepository _itemRepo;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
 
-- 
cgit v1.2.3