Adjust CommandSignals to be strings

Author: Levi--G

src/Renci.SshNet/CommandSignal.cs src/Renci.SshNet/CommandSignals.cssrc/Renci.SshNet/CommandSignal.cs renamed to src/Renci.SshNet/CommandSignals.cs

@@ -1,74 +1,73 @@
 namespace Renci.SshNet
 {
     /// <summary>
-    /// The ssh compatible POSIX/ANSI signals with their libc compatible values.
+    /// The ssh compatible standard POSIX/ANSI signals.
     /// </summary>
-#pragma warning disable CA1720 // Identifier contains type name
-    public enum CommandSignal
+    public static class CommandSignals
     {
         /// <summary>
         /// Hangup (POSIX).
         /// </summary>
-        HUP = 1,
+        public const string SIGHUP = "HUP";
 
         /// <summary>
         /// Interrupt (ANSI).
         /// </summary>
-        INT = 2,
+        public const string SIGINT = "INT";
 
         /// <summary>
         /// Quit (POSIX).
         /// </summary>
-        QUIT = 3,
+        public const string SIGQUIT = "QUIT";
 
         /// <summary>
         /// Illegal instruction (ANSI).
         /// </summary>
-        ILL = 4,
+        public const string SIGILL = "ILL";
 
         /// <summary>
         /// Abort (ANSI).
         /// </summary>
-        ABRT = 6,
+        public const string SIGABRT = "ABRT";
 
         /// <summary>
         /// Floating-point exception (ANSI).
         /// </summary>
-        FPE = 8,
+        public const string SIGFPE = "FPE";
 
         /// <summary>
         /// Kill, unblockable (POSIX).
         /// </summary>
-        KILL = 9,
+        public const string SIGKILL = "KILL";
 
         /// <summary>
         /// User-defined signal 1 (POSIX).
         /// </summary>
-        USR1 = 10,
+        public const string SIGUSR1 = "USR1";
 
         /// <summary>
         /// Segmentation violation (ANSI).
         /// </summary>
-        SEGV = 11,
+        public const string SIGSEGV = "SEGV";
 
         /// <summary>
         /// User-defined signal 2 (POSIX).
         /// </summary>
-        USR2 = 12,
+        public const string SIGUSR2 = "USR2";
 
         /// <summary>
         /// Broken pipe (POSIX).
         /// </summary>
-        PIPE = 13,
+        public const string SIGPIPE = "PIPE";
 
         /// <summary>
         /// Alarm clock (POSIX).
         /// </summary>
-        ALRM = 14,
+        public const string SIGALRM = "ALRM";
 
         /// <summary>
         /// Termination (ANSI).
         /// </summary>
-        TERM = 15,
+        public const string SIGTERM = "TERM";
     }
 }

src/Renci.SshNet/SshCommand.cs

@@ -478,26 +478,14 @@ public void CancelAsync(bool forceKill = false, int millisecondsTimeout = 500)
             }
         }
 
-        private static string? GetSignalName(CommandSignal signal)
-        {
-#if NETCOREAPP
-            return Enum.GetName(signal);
-#else
-
-            // Boxes signal, but Enum.GetName does not have a non-boxing overload prior to .NET Core.
-            return Enum.GetName(typeof(CommandSignal), signal);
-#endif
-        }
-
         /// <summary>
-        /// Tries to send a POSIX/ANSI signal to the remote process executing the command, such as SIGINT or SIGTERM.
+        /// Tries to send a POSIX/ANSI signal to the remote process executing the command, such as SIGTERM or any of the <see cref="CommandSignals"/>.
         /// </summary>
-        /// <param name="signal">The signal to send.</param>
+        /// <param name="signal">The signal to send. See <see cref="CommandSignals"/> for a standard list of signals.</param>
         /// <returns>If the signal was sent.</returns>
-        public bool TrySendSignal(CommandSignal signal)
+        public bool TrySendSignal(string signal)
         {
-            var signalName = GetSignalName(signal);
-            if (signalName is null)
+            if (signal is null)
             {
                 return false;
             }
@@ -510,7 +498,7 @@ public bool TrySendSignal(CommandSignal signal)
             try
             {
                 // Try to send the cancellation signal.
-                return _channel.SendSignalRequest(signalName);
+                return _channel.SendSignalRequest(signal);
             }
             catch (Exception)
             {
@@ -522,18 +510,17 @@ public bool TrySendSignal(CommandSignal signal)
         }
 
         /// <summary>
-        /// Tries to send a POSIX/ANSI signal to the remote process executing the command, such as SIGINT or SIGTERM.
+        /// Tries to send a POSIX/ANSI signal to the remote process executing the command, such as SIGTERM or any of the <see cref="CommandSignals"/>.
         /// </summary>
-        /// <param name="signal">The signal to send.</param>
+        /// <param name="signal">The signal to send. See <see cref="CommandSignals"/> for a standard list of signals.</param>
         /// <exception cref="ArgumentException">Signal was not a valid CommandSignal.</exception>
         /// <exception cref="SshConnectionException">The client is not connected.</exception>
         /// <exception cref="SshOperationTimeoutException">The operation timed out.</exception>
         /// <exception cref="InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
         /// <exception cref="InvalidOperationException">Command has not been started.</exception>
-        public void SendSignal(CommandSignal signal)
+        public void SendSignal(string signal)
         {
-            var signalName = GetSignalName(signal);
-            if (signalName is null)
+            if (signal is null)
             {
                 throw new ArgumentException("Signal was not a valid CommandSignal.");
             }
@@ -543,7 +530,7 @@ public void SendSignal(CommandSignal signal)
                 throw new InvalidOperationException("Command has not been started.");
             }
 
-            _ = _channel.SendSignalRequest(signalName);
+            _ = _channel.SendSignalRequest(signal);
         }
 
         /// <summary>