Merge pull request #33 from atc-net/feature/Handling-SocketException-…

…on-send-data Feature/handling socket exception on send data
atc-net · Jan 26, 2024 · 5343be2 · 5343be2
2 parents f5e1116 + 021ecba
commit 5343be2
Show file tree

Hide file tree

Showing 12 changed files with 138 additions and 25 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -43,10 +43,10 @@
   <ItemGroup Label="Code Analyzers">
     <PackageReference Include="AsyncFixer" Version="1.6.0" PrivateAssets="All" />
     <PackageReference Include="Asyncify" Version="0.9.7" PrivateAssets="All" />
-    <PackageReference Include="Meziantou.Analyzer" Version="2.0.118" PrivateAssets="All" />
+    <PackageReference Include="Meziantou.Analyzer" Version="2.0.138" PrivateAssets="All" />
     <PackageReference Include="SecurityCodeScan.VS2019" Version="5.6.7" PrivateAssets="All" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435" PrivateAssets="All" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="9.14.0.81108" PrivateAssets="All" />
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="9.17.0.82934" PrivateAssets="All" />
   </ItemGroup>
 
 </Project>
diff --git a/sample/Atc.Network.Console.Tcp/Atc.Network.Console.Tcp.csproj b/sample/Atc.Network.Console.Tcp/Atc.Network.Console.Tcp.csproj
@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Atc" Version="2.0.395" />
+    <PackageReference Include="Atc" Version="2.0.422" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="8.0.0" />
   </ItemGroup>

diff --git a/sample/Atc.Network.Console.Udp/Atc.Network.Console.Udp.csproj b/sample/Atc.Network.Console.Udp/Atc.Network.Console.Udp.csproj
@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Atc" Version="2.0.395" />
+    <PackageReference Include="Atc" Version="2.0.422" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="8.0.0" />
   </ItemGroup>

diff --git a/src/Atc.Network/Atc.Network.csproj b/src/Atc.Network/Atc.Network.csproj
@@ -13,7 +13,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Atc" Version="2.0.395" />
+    <PackageReference Include="Atc" Version="2.0.422" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
   </ItemGroup>
 

diff --git a/src/Atc.Network/LoggingEventIdConstants.cs b/src/Atc.Network/LoggingEventIdConstants.cs
@@ -16,10 +16,12 @@ internal static class TcpClient
         public const int Disconnected = 10009;
 
         public const int DataSendingByteLength = 10010;
-        public const int DataReceivedByteLength = 10011;
-        public const int DataReceiveTimeout = 10012;
-        public const int DataReceiveNoData = 10013;
-        public const int DataReceiveError = 10014;
+        public const int DataSendingSocketError = 10011;
+        public const int DataSendingError = 10012;
+        public const int DataReceivedByteLength = 10013;
+        public const int DataReceiveTimeout = 10014;
+        public const int DataReceiveNoData = 10015;
+        public const int DataReceiveError = 10016;
     }
 
     internal static class TcpServer
@@ -41,11 +43,15 @@ internal static class UdpClient
         public const int ClientNotConnected = 10207;
         public const int Disconnecting = 10208;
         public const int Disconnected = 10209;
+        public const int DataSendingSocketError = 10210;
+        public const int DataSendingError = 10211;
     }
 
     internal static class UdpServer
     {
         public const int DataReceivedByteLength = 10311;
         public const int NotRunning = 10320;
+        public const int DataSendingSocketError = 10321;
+        public const int DataSendingError = 10322;
     }
 }
diff --git a/src/Atc.Network/Tcp/TcpClient.cs b/src/Atc.Network/Tcp/TcpClient.cs
@@ -280,8 +280,33 @@ public async Task Send(
 
         LogDataSendingByteLength(data.Length);
 
-        await networkStream!.WriteAsync(data.AsMemory(0, data.Length), cancellationToken);
-        await networkStream.FlushAsync(cancellationToken);
+        await SyncLock.WaitAsync(cancellationToken);
+        var disconnectedDueToException = false;
+
+        try
+        {
+            await networkStream!.WriteAsync(data.AsMemory(0, data.Length), cancellationToken);
+            await networkStream.FlushAsync(cancellationToken);
+        }
+        catch (SocketException ex)
+        {
+            LogDataSendingSocketError(ex.SocketErrorCode.ToString(), ex.Message);
+            disconnectedDueToException = true;
+        }
+        catch (Exception ex)
+        {
+            LogDataSendingError(ex.Message);
+            disconnectedDueToException = true;
+        }
+        finally
+        {
+            SyncLock.Release();
+        }
+
+        if (disconnectedDueToException)
+        {
+            await DoDisconnect(raiseEventsAndLog: true, dispose: true);
+        }
     }
 
     /// <summary>
@@ -497,10 +522,10 @@ private async Task SetConnected(
         bool raiseEvents,
         CancellationToken cancellationToken = default)
     {
+        await SyncLock.WaitAsync(cancellationToken);
+
         try
         {
-            await SyncLock.WaitAsync(cancellationToken);
-
             if (IsConnected)
             {
                 return;
@@ -523,10 +548,10 @@ private async Task SetDisconnected(
         bool dispose,
         CancellationToken cancellationToken = default)
     {
+        await SyncLock.WaitAsync(cancellationToken);
+
         try
         {
-            await SyncLock.WaitAsync(cancellationToken);
-
             if (!IsConnected)
             {
                 return;

diff --git a/src/Atc.Network/Tcp/TcpClientLoggerMessages.cs b/src/Atc.Network/Tcp/TcpClientLoggerMessages.cs
@@ -99,6 +99,21 @@ private partial void LogDisconnected(
     private partial void LogDataSendingByteLength(
         int byteLength);
 
+    [LoggerMessage(
+        EventId = LoggingEventIdConstants.TcpClient.DataSendingSocketError,
+        Level = LogLevel.Error,
+        Message = "Received error when sending data - {socketError}: {errorMessage}.")]
+    private partial void LogDataSendingSocketError(
+        string socketError,
+        string errorMessage);
+
+    [LoggerMessage(
+        EventId = LoggingEventIdConstants.TcpClient.DataSendingError,
+        Level = LogLevel.Error,
+        Message = "Received error when sending data: {errorMessage}.")]
+    private partial void LogDataSendingError(
+        string errorMessage);
+
     [LoggerMessage(
         EventId = LoggingEventIdConstants.TcpClient.DataReceivedByteLength,
         Level = LogLevel.Trace,

diff --git a/src/Atc.Network/Udp/UdpClient.cs b/src/Atc.Network/Udp/UdpClient.cs
@@ -181,8 +181,33 @@ public async Task Send(
         TerminationHelper.AppendTerminationBytesIfNeeded(ref data, terminationType);
 
         var buffer = new ArraySegment<byte>(data);
-        await socket!.SendToAsync(buffer, SocketFlags.None, RemoteEndPoint, cancellationToken);
-        await Task.Delay(TimeSpan.FromMilliseconds(1), cancellationToken);
+        await SyncLock.WaitAsync(cancellationToken);
+        var disconnectedDueToException = false;
+
+        try
+        {
+            await socket!.SendToAsync(buffer, SocketFlags.None, RemoteEndPoint, cancellationToken);
+            await Task.Delay(TimeSpan.FromMilliseconds(1), cancellationToken);
+        }
+        catch (SocketException ex)
+        {
+            LogDataSendingSocketError(ex.SocketErrorCode.ToString(), ex.Message);
+            disconnectedDueToException = true;
+        }
+        catch (Exception ex)
+        {
+            LogDataSendingError(ex.Message);
+            disconnectedDueToException = true;
+        }
+        finally
+        {
+            SyncLock.Release();
+        }
+
+        if (disconnectedDueToException)
+        {
+            await DoDisconnect(raiseEventsAndLog: true);
+        }
     }
 
     /// <summary>
@@ -351,10 +376,10 @@ private async Task SetConnected(
         bool raiseEvents,
         CancellationToken cancellationToken = default)
     {
+        await SyncLock.WaitAsync(cancellationToken);
+
         try
         {
-            await SyncLock.WaitAsync(cancellationToken);
-
             if (IsConnected)
             {
                 return;
@@ -376,10 +401,10 @@ private async Task SetDisconnected(
         bool raiseEvents = true,
         CancellationToken cancellationToken = default)
     {
+        await SyncLock.WaitAsync(cancellationToken);
+
         try
         {
-            await SyncLock.WaitAsync(cancellationToken);
-
             if (!IsConnected)
             {
                 return;

diff --git a/src/Atc.Network/Udp/UdpClientLoggerMessages.cs b/src/Atc.Network/Udp/UdpClientLoggerMessages.cs
@@ -57,4 +57,19 @@ private partial void LogDisconnecting(
     private partial void LogDisconnected(
         string ipAddressOrHostName,
         int port);
+
+    [LoggerMessage(
+        EventId = LoggingEventIdConstants.UdpClient.DataSendingSocketError,
+        Level = LogLevel.Error,
+        Message = "Received error when sending data - {socketError}: {errorMessage}.")]
+    private partial void LogDataSendingSocketError(
+        string socketError,
+        string errorMessage);
+
+    [LoggerMessage(
+        EventId = LoggingEventIdConstants.UdpClient.DataSendingError,
+        Level = LogLevel.Error,
+        Message = "Received error when sending data: {errorMessage}.")]
+    private partial void LogDataSendingError(
+        string errorMessage);
 }
diff --git a/src/Atc.Network/Udp/UdpServer.cs b/src/Atc.Network/Udp/UdpServer.cs
@@ -204,7 +204,19 @@ public async Task Send(
         AppendTerminationBytesIfNeeded(ref data, terminationType);
 
         var buffer = new ArraySegment<byte>(data);
-        await socket!.SendToAsync(buffer, SocketFlags.None, recipient, cancellationToken);
+
+        try
+        {
+            await socket!.SendToAsync(buffer, SocketFlags.None, recipient, cancellationToken);
+        }
+        catch (SocketException ex)
+        {
+            LogDataSendingSocketError(ex.SocketErrorCode.ToString(), ex.Message);
+        }
+        catch (Exception ex)
+        {
+            LogDataSendingError(ex.Message);
+        }
     }
 
     /// <summary>

diff --git a/src/Atc.Network/Udp/UdpServerLoggerMessages.cs b/src/Atc.Network/Udp/UdpServerLoggerMessages.cs
@@ -21,4 +21,19 @@ public partial class UdpServer
         Message = "Received '{byteLength}' bytes.")]
     private partial void LogDataReceived(
         int byteLength);
+
+    [LoggerMessage(
+        EventId = LoggingEventIdConstants.UdpServer.DataSendingSocketError,
+        Level = LogLevel.Error,
+        Message = "Received error when sending data - {socketError}: {errorMessage}.")]
+    private partial void LogDataSendingSocketError(
+        string socketError,
+        string errorMessage);
+
+    [LoggerMessage(
+        EventId = LoggingEventIdConstants.UdpServer.DataSendingError,
+        Level = LogLevel.Error,
+        Message = "Received error when sending data: {errorMessage}.")]
+    private partial void LogDataSendingError(
+        string errorMessage);
 }
diff --git a/test/Atc.Network.Test/Atc.Network.Test.csproj b/test/Atc.Network.Test/Atc.Network.Test.csproj
@@ -9,11 +9,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Atc.XUnit" Version="2.0.395" />
+    <PackageReference Include="Atc.XUnit" Version="2.0.422" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-    <PackageReference Include="xunit" Version="2.6.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.4">
+    <PackageReference Include="xunit" Version="2.6.6" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>