Merge partial classes and complete IForwardedPort interface (#1223)

* Merge partial classes.
Complete IForwardedPort interface.
Expoe Closing event publicly on ForwardedPort.
Disable CA1030 (use events where appropriate).

* Merge partial classes.
Complete IForwardedPort interface.
Expoe Closing event publicly on ForwardedPort.
Disable CA1030 (use events where appropriate).

* Use local function and remove suppression.

* Compile regular expressions.

* Fix build, pfff.

---------

Co-authored-by: Wojciech Nagórski <wojtpl2@gmail.com>

Author: drieseng

src/Renci.SshNet/.editorconfig

@@ -21,6 +21,10 @@ MA0053.public_class_should_be_sealed = false
 
 #### .NET Compiler Platform analysers rules ####
 
+# CA1030: Use events where appropriate
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1030
+dotnet_diagnostic.CA10310.severity = none
+
 # CA1031: Do not catch general exception types
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1031
 dotnet_diagnostic.CA1031.severity = none

src/Renci.SshNet/ForwardedPort.cs

@@ -1,4 +1,5 @@
 using System;
+
 using Renci.SshNet.Common;
 
 namespace Renci.SshNet
@@ -16,28 +17,19 @@ public abstract class ForwardedPort : IForwardedPort
         /// </value>
         internal ISession Session { get; set; }
 
-        /// <summary>
-        /// The <see cref="Closing"/> event occurs as the forwarded port is being stopped.
-        /// </summary>
-        internal event EventHandler Closing;
-
-        /// <summary>
-        /// The <see cref="IForwardedPort.Closing"/> event occurs as the forwarded port is being stopped.
-        /// </summary>
-        event EventHandler IForwardedPort.Closing
-        {
-            add { Closing += value; }
-            remove { Closing -= value; }
-        }
-
         /// <summary>
         /// Gets a value indicating whether port forwarding is started.
         /// </summary>
         /// <value>
-        /// <c>true</c> if port forwarding is started; otherwise, <c>false</c>.
+        /// <see langword="true"/> if port forwarding is started; otherwise, <see langword="false"/>.
         /// </value>
         public abstract bool IsStarted { get; }
 
+        /// <summary>
+        /// The <see cref="Closing"/> event occurs as the forwarded port is being stopped.
+        /// </summary>
+        public event EventHandler Closing;
+
         /// <summary>
         /// Occurs when an exception is thrown.
         /// </summary>
@@ -51,6 +43,8 @@ event EventHandler IForwardedPort.Closing
         /// <summary>
         /// Starts port forwarding.
         /// </summary>
+        /// <exception cref="InvalidOperationException">The current <see cref="ForwardedPort"/> is already started -or- is not linked to a SSH session.</exception>
+        /// <exception cref="SshConnectionException">The client is not connected.</exception>
         public virtual void Start()
         {
             CheckDisposed();
@@ -77,14 +71,25 @@ public virtual void Start()
         /// <summary>
         /// Stops port forwarding.
         /// </summary>
+#pragma warning disable CA1716 // Identifiers should not match keywords
         public virtual void Stop()
+#pragma warning restore CA1716 // Identifiers should not match keywords
         {
             if (IsStarted)
             {
                 StopPort(Session.ConnectionInfo.Timeout);
             }
         }
 
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        public void Dispose()
+        {
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
+        }
+
         /// <summary>
         /// Starts port forwarding.
         /// </summary>
@@ -100,22 +105,22 @@ protected virtual void StopPort(TimeSpan timeout)
             RaiseClosing();
 
             var session = Session;
-            if (session != null)
+            if (session is not null)
             {
                 session.ErrorOccured -= Session_ErrorOccured;
             }
         }
 
         /// <summary>
-        /// Releases unmanaged and - optionally - managed resources
+        /// Releases unmanaged and - optionally - managed resources.
         /// </summary>
-        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
+        /// <param name="disposing"><see langowrd="true"/> to release both managed and unmanaged resources; <see langowrd="false"/> to release only unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)
             {
                 var session = Session;
-                if (session != null)
+                if (session is not null)
                 {
                     StopPort(session.ConnectionInfo.Timeout);
                     Session = null;