GithubStar/SSH.NET
1
0
Fork 0
mirror of https://github.com/sshnet/SSH.NET.git synced 2026-10-21 08:20:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove AwaitableSocketAsyncEventArgs (#1850)

Browse Source
This commit is contained in:
Rob Hague
2026-10-19 19:53:08 +02:00
committed by GitHub
parent 6ef5c3ef2e
commit 967cbfe970
4 changed files with 40 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Renci.SshNet/Abstractions/SocketAbstraction.cs
-13
View File
@@ -3,7 +3,6 @@ using System.Globalization;
using System.Net;
using System.Net.Sockets;
using System.Threading;
using System.Threading.Tasks;
using Renci.SshNet.Common;
using Renci.SshNet.Messages.Transport;
@@ -26,11 +25,6 @@ namespace Renci.SshNet.Abstractions
ConnectCore(socket, remoteEndpoint, connectTimeout, ownsSocket: false);
}
public static async Task ConnectAsync(Socket socket, EndPoint remoteEndpoint, CancellationToken cancellationToken)
{
await socket.ConnectAsync(remoteEndpoint, cancellationToken).ConfigureAwait(false);
}
private static void ConnectCore(Socket socket, EndPoint remoteEndpoint, TimeSpan connectTimeout, bool ownsSocket)
{
var connectCompleted = new ManualResetEvent(initialState: false);
@@ -251,13 +245,6 @@ namespace Renci.SshNet.Abstractions
return totalBytesRead;
}
#if !NET
public static Task<int> ReadAsync(Socket socket, byte[] buffer, CancellationToken cancellationToken)
{
return socket.ReceiveAsync(buffer, 0, buffer.Length, cancellationToken);
}
#endif
public static void Send(Socket socket, byte[] data)
{
Send(socket, data, 0, data.Length);
src/Renci.SshNet/Abstractions/SocketExtensions.cs
+38 -87
View File
@@ -2,118 +2,69 @@
using System;
using System.Net;
using System.Net.Sockets;
using System.Runtime.CompilerServices;
using System.Threading;
using System.Threading.Tasks;
namespace Renci.SshNet.Abstractions
{
// Async helpers based on https://devblogs.microsoft.com/pfxteam/awaiting-socket-operations/
internal static class SocketExtensions
{
private sealed class AwaitableSocketAsyncEventArgs : SocketAsyncEventArgs, INotifyCompletion
public static Task ConnectAsync(this Socket socket, EndPoint remoteEndpoint, CancellationToken cancellationToken)
{
private static readonly Action SENTINEL = () => { };
private bool _isCancelled;
private Action _continuationAction;
public AwaitableSocketAsyncEventArgs()
if (cancellationToken.IsCancellationRequested)
{
Completed += (sender, e) => SetCompleted();
return Task.FromCanceled(cancellationToken);
}
public AwaitableSocketAsyncEventArgs ExecuteAsync(Func<SocketAsyncEventArgs, bool> func)
var connectTask = Task.Factory.FromAsync(
static (s, remoteEndpoint, callback, state) => s.BeginConnect(remoteEndpoint, callback, state),
static result => ((Socket)result.AsyncState).EndConnect(result),
socket,
remoteEndpoint,
state: socket);
return connectTask.IsCompleted || !cancellationToken.CanBeCanceled
? connectTask
: WaitWithCancellation(connectTask, socket, cancellationToken);
static async Task WaitWithCancellation(Task connectTask, Socket socket, CancellationToken cancellationToken)
{
if (!func(this))
using (cancellationToken.Register(static s => ((Socket)s).Dispose(), socket, useSynchronizationContext: false))
{
SetCompleted();
}
return this;
}
private void SetCompleted()
{
IsCompleted = true;
var continuation = Interlocked.Exchange(ref _continuationAction, SENTINEL);
if (continuation is not null)
{
continuation();
}
}
public void SetCancelled()
{
_isCancelled = true;
SetCompleted();
}
public AwaitableSocketAsyncEventArgs GetAwaiter()
{
return this;
}
public bool IsCompleted { get; private set; }
void INotifyCompletion.OnCompleted(Action continuation)
{
if (_continuationAction == SENTINEL || Interlocked.CompareExchange(ref _continuationAction, continuation, comparand: null) == SENTINEL)
{
// We have already completed; run continuation asynchronously
_ = Task.Run(continuation);
}
}
public void GetResult()
{
if (_isCancelled)
{
throw new TaskCanceledException();
}
if (!IsCompleted)
{
// We don't support sync/async
throw new InvalidOperationException("The asynchronous operation has not yet completed.");
}
if (SocketError != SocketError.Success)
{
throw new SocketException((int)SocketError);
await connectTask.ConfigureAwait(false);
}
}
}
public static async Task ConnectAsync(this Socket socket, EndPoint remoteEndpoint, CancellationToken cancellationToken)
public static Task<int> ReceiveAsync(this Socket socket, byte[] buffer, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
using (var args = new AwaitableSocketAsyncEventArgs())
{
args.RemoteEndPoint = remoteEndpoint;
using (cancellationToken.Register(o => ((AwaitableSocketAsyncEventArgs)o).SetCancelled(), args, useSynchronizationContext: false))
{
await args.ExecuteAsync(socket.ConnectAsync);
}
}
return ReceiveAsync(socket, buffer, 0, buffer.Length, cancellationToken);
}
public static async Task<int> ReceiveAsync(this Socket socket, byte[] buffer, int offset, int length, CancellationToken cancellationToken)
public static Task<int> ReceiveAsync(this Socket socket, byte[] buffer, int offset, int length, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
using (var args = new AwaitableSocketAsyncEventArgs())
if (cancellationToken.IsCancellationRequested)
{
args.SetBuffer(buffer, offset, length);
return Task.FromCanceled<int>(cancellationToken);
}
using (cancellationToken.Register(o => ((AwaitableSocketAsyncEventArgs)o).SetCancelled(), args, useSynchronizationContext: false))
var receiveTask = Task.Factory.FromAsync(
static (s, buffer, callback, state) => s.BeginReceive(buffer.Array, buffer.Offset, buffer.Count, SocketFlags.None, callback, state),
static result => ((Socket)result.AsyncState).EndReceive(result),
socket,
new ArraySegment<byte>(buffer, offset, length),
state: socket);
return receiveTask.IsCompleted || !cancellationToken.CanBeCanceled
? receiveTask
: WaitWithCancellation(receiveTask, socket, cancellationToken);
static async Task<int> WaitWithCancellation(Task<int> receiveTask, Socket socket, CancellationToken cancellationToken)
{
using (cancellationToken.Register(static s => ((Socket)s).Dispose(), socket, useSynchronizationContext: false))
{
await args.ExecuteAsync(socket.ReceiveAsync);
return await receiveTask.ConfigureAwait(false);
}
return args.BytesTransferred;
}
}
}
src/Renci.SshNet/Connection/ConnectorBase.cs
+1 -25
View File
@@ -72,7 +72,7 @@ namespace Renci.SshNet.Connection
var socket = SocketFactory.Create(SocketType.Stream, ProtocolType.Tcp);
try
{
await SocketAbstraction.ConnectAsync(socket, endPoint, cancellationToken).ConfigureAwait(false);
await socket.ConnectAsync(endPoint, cancellationToken).ConfigureAwait(false);
return socket;
}
@@ -83,13 +83,6 @@ namespace Renci.SshNet.Connection
}
}
protected static byte SocketReadByte(Socket socket)
{
var buffer = new byte[1];
_ = SocketRead(socket, buffer, 0, 1, Timeout.InfiniteTimeSpan);
return buffer[0];
}
protected static byte SocketReadByte(Socket socket, TimeSpan readTimeout)
{
var buffer = new byte[1];
@@ -97,23 +90,6 @@ namespace Renci.SshNet.Connection
return buffer[0];
}
/// <summary>
/// Performs a blocking read on the socket until <paramref name="length"/> bytes are received.
/// </summary>
/// <param name="socket">The <see cref="Socket"/> to read from.</param>
/// <param name="buffer">An array of type <see cref="byte"/> that is the storage location for the received data.</param>
/// <param name="offset">The position in <paramref name="buffer"/> parameter to store the received data.</param>
/// <param name="length">The number of bytes to read.</param>
/// <returns>
/// The number of bytes read.
/// </returns>
/// <exception cref="SshConnectionException">The socket is closed.</exception>
/// <exception cref="SocketException">The read failed.</exception>
protected static int SocketRead(Socket socket, byte[] buffer, int offset, int length)
{
return SocketRead(socket, buffer, offset, length, Timeout.InfiniteTimeSpan);
}
/// <summary>
/// Performs a blocking read on the socket until <paramref name="length"/> bytes are received.
/// </summary>
src/Renci.SshNet/Connection/ProtocolVersionExchange.cs
+1 -1
View File
@@ -181,7 +181,7 @@ namespace Renci.SshNet.Connection
while (buffer.Count < MaximumBannerLineLength)
{
var bytesRead = await SocketAbstraction.ReadAsync(socket, data, cancellationToken).ConfigureAwait(false);
var bytesRead = await socket.ReceiveAsync(data, cancellationToken).ConfigureAwait(false);
if (bytesRead == 0)
{
throw CreateConnectionLostException();