test additions/tweaks

Author: Rob-Hague

src/Renci.SshNet/ISubsystemSession.cs

@@ -58,57 +58,11 @@ internal interface ISubsystemSession : IDisposable
         /// <exception cref="SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
         void WaitOnHandle(WaitHandle waitHandle, int millisecondsTimeout);
 
-        /// <summary>
-        /// Blocks the current thread until the specified <see cref="WaitHandle"/> gets signaled, using a
-        /// 32-bit signed integer to specify the time interval in milliseconds.
-        /// </summary>
-        /// <param name="waitHandle">The handle to wait for.</param>
-        /// <param name="millisecondsTimeout">To number of milliseconds to wait for <paramref name="waitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
-        /// <returns>
-        /// <see langword="true"/> if <paramref name="waitHandle"/> received a signal within the specified timeout;
-        /// otherwise, <see langword="false"/>.
-        /// </returns>
-        /// <exception cref="SshException">The connection was closed by the server.</exception>
-        /// <exception cref="SshException">The channel was closed.</exception>
-        /// <remarks>
-        /// The blocking wait is also interrupted when either the established channel is closed, the current
-        /// session is disconnected or an unexpected <see cref="Exception"/> occurred while processing a channel
-        /// or session event.
-        /// </remarks>
-        bool WaitOne(WaitHandle waitHandle, int millisecondsTimeout);
-
-        /// <summary>
-        /// Blocks the current thread until the specified <see cref="WaitHandle"/> gets signaled, using a
-        /// 32-bit signed integer to specify the time interval in milliseconds.
-        /// </summary>
-        /// <param name="waitHandleA">The first handle to wait for.</param>
-        /// <param name="waitHandleB">The second handle to wait for.</param>
-        /// <param name="millisecondsTimeout">To number of milliseconds to wait for a <see cref="WaitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
-        /// <returns>
-        /// <c>0</c> if <paramref name="waitHandleA"/> received a signal within the specified timeout and <c>1</c>
-        /// if <paramref name="waitHandleB"/> received a signal within the specified timeout, or <see cref="WaitHandle.WaitTimeout"/>
-        /// if no object satisfied the wait.
-        /// </returns>
-        /// <exception cref="SshException">The connection was closed by the server.</exception>
-        /// <exception cref="SshException">The channel was closed.</exception>
-        /// <remarks>
-        /// <para>
-        /// The blocking wait is also interrupted when either the established channel is closed, the current
-        /// session is disconnected or an unexpected <see cref="Exception"/> occurred while processing a channel
-        /// or session event.
-        /// </para>
-        /// <para>
-        /// When both <paramref name="waitHandleA"/> and <paramref name="waitHandleB"/> are signaled during the call,
-        /// then <c>0</c> is returned.
-        /// </para>
-        /// </remarks>
-        int WaitAny(WaitHandle waitHandleA, WaitHandle waitHandleB, int millisecondsTimeout);
-
         /// <summary>
         /// Waits for any of the elements in the specified array to receive a signal, using a 32-bit signed
         /// integer to specify the time interval.
         /// </summary>
-        /// <param name="waitHandles">A <see cref="WaitHandle"/> array - constructed using <see cref="CreateWaitHandleArray(WaitHandle[])"/> - containing the objects to wait for.</param>
+        /// <param name="waitHandles">A <see cref="WaitHandle"/> array - constructed using <see cref="CreateWaitHandleArray"/> - containing the objects to wait for.</param>
         /// <param name="millisecondsTimeout">To number of milliseconds to wait for a <see cref="WaitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
         /// <returns>
         /// The array index of the first non-system object that satisfied the wait.
@@ -121,16 +75,6 @@ internal interface ISubsystemSession : IDisposable
         /// </remarks>
         int WaitAny(WaitHandle[] waitHandles, int millisecondsTimeout);
 
-        /// <summary>
-        /// Creates a <see cref="WaitHandle"/> array that is composed of system objects and the specified
-        /// elements.
-        /// </summary>
-        /// <param name="waitHandles">A <see cref="WaitHandle"/> array containing the objects to wait for.</param>
-        /// <returns>
-        /// A <see cref="WaitHandle"/> array that is composed of system objects and the specified elements.
-        /// </returns>
-        WaitHandle[] CreateWaitHandleArray(params WaitHandle[] waitHandles);
-
         /// <summary>
         /// Creates a <see cref="WaitHandle"/> array that is composed of system objects and the specified
         /// elements.

src/Renci.SshNet/Sftp/ISftpSession.cs

@@ -40,7 +40,7 @@ internal interface ISftpSession : ISubsystemSession
         /// <param name="path">The new working directory.</param>
         /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
         /// <returns>A <see cref="Task"/> that tracks the asynchronous change working directory request.</returns>
-        Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default);
+        Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken);
 
         /// <summary>
         /// Resolves a given path into an absolute path on the server.
@@ -168,7 +168,7 @@ internal interface ISftpSession : ISubsystemSession
         /// <param name="path">The path.</param>
         /// <param name="cancellationToken">The <see cref="CancellationToken"/> to observe.</param>
         /// <returns>A <see cref="Task"/> that represents the asynchronous <c>SSH_FXP_MKDIR</c> operation.</returns>
-        Task RequestMkDirAsync(string path, CancellationToken cancellationToken = default);
+        Task RequestMkDirAsync(string path, CancellationToken cancellationToken);
 
         /// <summary>
         /// Performs a <c>SSH_FXP_OPEN</c> request.
@@ -389,7 +389,7 @@ internal interface ISftpSession : ISubsystemSession
         /// <returns>
         /// A task that represents the asynchronous <c>SSH_FXP_RMDIR</c> request.
         /// </returns>
-        Task RequestRmDirAsync(string path, CancellationToken cancellationToken = default);
+        Task RequestRmDirAsync(string path, CancellationToken cancellationToken);
 
         /// <summary>
         /// Performs SSH_FXP_SETSTAT request.

src/Renci.SshNet/Sftp/SftpSession.cs

@@ -90,7 +90,7 @@ public void ChangeDirectory(string path)
         /// <param name="path">The new working directory.</param>
         /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
         /// <returns>A <see cref="Task"/> that tracks the asynchronous change working directory request.</returns>
-        public async Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default)
+        public async Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken)
         {
             cancellationToken.ThrowIfCancellationRequested();
 
@@ -1469,7 +1469,7 @@ public void RequestMkDir(string path)
         /// <param name="path">The path.</param>
         /// <param name="cancellationToken">The <see cref="CancellationToken"/> to observe.</param>
         /// <returns>A <see cref="Task"/> that represents the asynchronous <c>SSH_FXP_MKDIR</c> operation.</returns>
-        public Task RequestMkDirAsync(string path, CancellationToken cancellationToken = default)
+        public Task RequestMkDirAsync(string path, CancellationToken cancellationToken)
         {
             if (cancellationToken.IsCancellationRequested)
             {
@@ -1529,7 +1529,7 @@ public void RequestRmDir(string path)
         }
 
         /// <inheritdoc />
-        public Task RequestRmDirAsync(string path, CancellationToken cancellationToken = default)
+        public Task RequestRmDirAsync(string path, CancellationToken cancellationToken)
         {
             if (cancellationToken.IsCancellationRequested)
             {

src/Renci.SshNet/SubsystemSession.cs

@@ -18,7 +18,7 @@ internal abstract class SubsystemSession : ISubsystemSession
     {
         /// <summary>
         /// Holds the number of system wait handles that are returned as the leading entries in the array returned
-        /// in <see cref="CreateWaitHandleArray(WaitHandle[])"/>.
+        /// in <see cref="CreateWaitHandleArray"/>.
         /// </summary>
         private const int SystemWaitHandleCount = 3;
 
@@ -310,124 +310,7 @@ protected async Task<T> WaitOnHandleAsync<T>(TaskCompletionSource<T> tcs, int mi
             }
         }
 
-        /// <summary>
-        /// Blocks the current thread until the specified <see cref="WaitHandle"/> gets signaled, using a
-        /// 32-bit signed integer to specify the time interval in milliseconds.
-        /// </summary>
-        /// <param name="waitHandle">The handle to wait for.</param>
-        /// <param name="millisecondsTimeout">To number of milliseconds to wait for <paramref name="waitHandle"/> to get signaled, or -1 to wait indefinitely.</param>
-        /// <returns>
-        /// <see langword="true"/> if <paramref name="waitHandle"/> received a signal within the specified timeout;
-        /// otherwise, <see langword="false"/>.
-        /// </returns>
-        /// <exception cref="SshException">The connection was closed by the server.</exception>
-        /// <exception cref="SshException">The channel was closed.</exception>
-        /// <remarks>
-        /// The blocking wait is also interrupted when either the established channel is closed, the current
-        /// session is disconnected or an unexpected <see cref="Exception"/> occurred while processing a channel
-        /// or session event.
-        /// </remarks>
-        public bool WaitOne(WaitHandle waitHandle, int millisecondsTimeout)
-        {
-            var waitHandles = new[]
-                {
-                    _errorOccurredWaitHandle,
-                    _sessionDisconnectedWaitHandle,
-                    _channelClosedWaitHandle,
-                    waitHandle
-                };
-
-            var result = WaitHandle.WaitAny(waitHandles, millisecondsTimeout);
-            switch (result)
-            {
-                case 0:
-                    ExceptionDispatchInfo.Capture(_exception).Throw();
-                    return false; // unreached
-                case 1:
-                    throw new SshException("Connection was closed by the server.");
-                case 2:
-                    throw new SshException("Channel was closed.");
-                case 3:
-                    return true;
-                case WaitHandle.WaitTimeout:
-                    return false;
-                default:
-                    throw new NotImplementedException(string.Format(CultureInfo.InvariantCulture, "WaitAny return value '{0}' is not implemented.", result));
-            }
-        }
-
-        /// <summary>
-        /// Blocks the current thread until the specified <see cref="WaitHandle"/> gets signaled, using a
-        /// 32-bit signed integer to specify the time interval in milliseconds.
-        /// </summary>
-        /// <param name="waitHandleA">The first handle to wait for.</param>
-        /// <param name="waitHandleB">The second handle to wait for.</param>
-        /// <param name="millisecondsTimeout">To number of milliseconds to wait for a <see cref="WaitHandle"/> to get signaled, or -1 to wait indefinitely.</param>
-        /// <returns>
-        /// <c>0</c> if <paramref name="waitHandleA"/> received a signal within the specified timeout, and <c>1</c>
-        /// if <paramref name="waitHandleB"/> received a signal within the specified timeout.
-        /// </returns>
-        /// <exception cref="SshException">The connection was closed by the server.</exception>
-        /// <exception cref="SshException">The channel was closed.</exception>
-        /// <exception cref="SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
-        /// <remarks>
-        /// <para>
-        /// The blocking wait is also interrupted when either the established channel is closed, the current
-        /// session is disconnected or an unexpected <see cref="Exception"/> occurred while processing a channel
-        /// or session event.
-        /// </para>
-        /// <para>
-        /// When both <paramref name="waitHandleA"/> and <paramref name="waitHandleB"/> are signaled during the call,
-        /// then <c>0</c> is returned.
-        /// </para>
-        /// </remarks>
-        public int WaitAny(WaitHandle waitHandleA, WaitHandle waitHandleB, int millisecondsTimeout)
-        {
-            var waitHandles = new[]
-                {
-                    _errorOccurredWaitHandle,
-                    _sessionDisconnectedWaitHandle,
-                    _channelClosedWaitHandle,
-                    waitHandleA,
-                    waitHandleB
-                };
-
-            var result = WaitHandle.WaitAny(waitHandles, millisecondsTimeout);
-            switch (result)
-            {
-                case 0:
-                    ExceptionDispatchInfo.Capture(_exception).Throw();
-                    return -1; // unreached
-                case 1:
-                    throw new SshException("Connection was closed by the server.");
-                case 2:
-                    throw new SshException("Channel was closed.");
-                case 3:
-                    return 0;
-                case 4:
-                    return 1;
-                case WaitHandle.WaitTimeout:
-                    throw new SshOperationTimeoutException("Operation has timed out.");
-                default:
-                    throw new NotImplementedException(string.Format(CultureInfo.InvariantCulture, "WaitAny return value '{0}' is not implemented.", result));
-            }
-        }
-
-        /// <summary>
-        /// Waits for any of the elements in the specified array to receive a signal, using a 32-bit signed
-        /// integer to specify the time interval.
-        /// </summary>
-        /// <param name="waitHandles">A <see cref="WaitHandle"/> array - constructed using <see cref="CreateWaitHandleArray(WaitHandle[])"/> - containing the objects to wait for.</param>
-        /// <param name="millisecondsTimeout">To number of milliseconds to wait for a <see cref="WaitHandle"/> to get signaled, or -1 to wait indefinitely.</param>
-        /// <returns>
-        /// The array index of the first non-system object that satisfied the wait.
-        /// </returns>
-        /// <exception cref="SshException">The connection was closed by the server.</exception>
-        /// <exception cref="SshException">The channel was closed.</exception>
-        /// <exception cref="SshOperationTimeoutException">No object satisfied the wait and a time interval equivalent to <paramref name="millisecondsTimeout"/> has passed.</exception>
-        /// <remarks>
-        /// For the return value, the index of the first non-system object is considered to be zero.
-        /// </remarks>
+        /// <inheritdoc/>
         public int WaitAny(WaitHandle[] waitHandles, int millisecondsTimeout)
         {
             var result = WaitHandle.WaitAny(waitHandles, millisecondsTimeout);
@@ -447,15 +330,7 @@ public int WaitAny(WaitHandle[] waitHandles, int millisecondsTimeout)
             }
         }
 
-        /// <summary>
-        /// Creates a <see cref="WaitHandle"/> array that is composed of system objects and the specified
-        /// elements.
-        /// </summary>
-        /// <param name="waitHandle1">The first <see cref="WaitHandle"/> to wait for.</param>
-        /// <param name="waitHandle2">The second <see cref="WaitHandle"/> to wait for.</param>
-        /// <returns>
-        /// A <see cref="WaitHandle"/> array that is composed of system objects and the specified elements.
-        /// </returns>
+        /// <inheritdoc/>
         public WaitHandle[] CreateWaitHandleArray(WaitHandle waitHandle1, WaitHandle waitHandle2)
         {
             return new WaitHandle[]
@@ -468,29 +343,6 @@ public WaitHandle[] CreateWaitHandleArray(WaitHandle waitHandle1, WaitHandle wai
                 };
         }
 
-        /// <summary>
-        /// Creates a <see cref="WaitHandle"/> array that is composed of system objects and the specified
-        /// elements.
-        /// </summary>
-        /// <param name="waitHandles">A <see cref="WaitHandle"/> array containing the objects to wait for.</param>
-        /// <returns>
-        /// A <see cref="WaitHandle"/> array that is composed of system objects and the specified elements.
-        /// </returns>
-        public WaitHandle[] CreateWaitHandleArray(params WaitHandle[] waitHandles)
-        {
-            var array = new WaitHandle[waitHandles.Length + SystemWaitHandleCount];
-            array[0] = _errorOccurredWaitHandle;
-            array[1] = _sessionDisconnectedWaitHandle;
-            array[2] = _channelClosedWaitHandle;
-
-            for (var i = 0; i < waitHandles.Length; i++)
-            {
-                array[i + SystemWaitHandleCount] = waitHandles[i];
-            }
-
-            return array;
-        }
-
         private void Session_Disconnected(object sender, EventArgs e)
         {
             _ = _sessionDisconnectedWaitHandle?.Set();