Merge pull request #147 from dotnet-campus/t/lindexi/IpcClientService

修复在注册过程中对方断开导致异常但缺乏具体是连接哪一端的信息
dotnet-campus · Jan 9, 2024 · a59e964 · a59e964
2 parents c78cd40 + 0354f80
commit a59e964
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 15 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -11,7 +11,7 @@
     <Description>本机内多进程通讯库，稳定 IPC 通讯库</Description>
 
     <RepositoryType>git</RepositoryType>
-    <Copyright>Copyright © 2020-2023 dotnet campus, All Rights Reserved.</Copyright>
+    <Copyright>Copyright © 2020-2024 dotnet campus, All Rights Reserved.</Copyright>
 
     <NoWarn>$(NoWarn);NU1803</NoWarn>
   </PropertyGroup>

diff --git a/src/dotnetCampus.Ipc/Pipes/IpcClientService.cs b/src/dotnetCampus.Ipc/Pipes/IpcClientService.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
 using System.IO.Pipes;
 using System.Runtime.CompilerServices;
 using System.Runtime.ExceptionServices;
@@ -269,7 +270,7 @@ internal async Task WriteMessageAsync(IpcMessageTracker<IpcBufferMessageContext>
                 // 这里的 InvalidOperationException 对应 DoubleBufferTask.AddTask 里抛出的异常。
                 // 在逻辑上确实是使用错误，抛出 InvalidOperationException 是合适的；
                 // 但因为 IPC 的断开发生在任何时刻，根本无法提前规避，所以实际上这里指的是 IPC 远端异常。
-                throw new IpcRemoteException($"因为已无法连接对方，所以 IPC 消息发送失败。Tag={tracker.Tag}", ex);
+                throw new IpcRemoteException($"因为已无法连接对方，所以 IPC 消息发送失败。Tag={tracker.Tag} LocalClient:'{IpcContext.PipeName}';RemoteServer:'{PeerName}'", ex);
                 // @lindexi，这里违背了异常处理原则里的“不应捕获使用异常”的原则，所以 DoubleBufferTask 的设计需要修改，加一个 TryAddTaskAsync 以应对并发场景。
             }
 
@@ -307,19 +308,29 @@ async Task WriteMessageAsyncInner()
 
                 IpcContext.LogSendMessage(tracker.Message, PeerName);
 
-                // 发送消息。
-                await IpcMessageConverter.WriteAsync
-                (
-                    stream,
-                    IpcConfiguration.MessageHeader,
-                    ack,
-                    tracker.Message,
-                    IpcConfiguration.SharedArrayPool
-                ).ConfigureAwait(false);
-                await stream.FlushAsync().ConfigureAwait(false);
-
-                // 追踪消息。
-                tracker.Debug("IPC finish writing.");
+                try
+                {
+                    // 发送消息。
+                    await IpcMessageConverter.WriteAsync
+                    (
+                        stream,
+                        IpcConfiguration.MessageHeader,
+                        ack,
+                        tracker.Message,
+                        IpcConfiguration.SharedArrayPool
+                    ).ConfigureAwait(false);
+                    await stream.FlushAsync().ConfigureAwait(false);
+
+                    // 追踪消息。
+                    tracker.Debug("IPC finish writing.");
+                }
+                catch (IOException e)
+                {
+                    // 比如 Pipe is broken. 等异常
+                    tracker.Debug("IPC write fail.");
+                    // 重新封装异常，让上层可以获取到更多信息，且可以使用 IPC 的异常类型进行判断
+                    throw new IpcRemoteException($"IPC write fail. Tag={tracker.Tag} LocalClient:'{IpcContext.PipeName}';RemoteServer:'{PeerName}'", e);
+                }
             }
         }