From 8e42d0c1b7ae36cff2e7c69999117911a4b6f300 Mon Sep 17 00:00:00 2001
From: wanshenmean <cathay_xy@163.com>
Date: 星期四, 26 三月 2026 17:31:06 +0800
Subject: [PATCH] feat(WCS): 完善 WIDESEAWCS_Tasks 模块代码注释
---
Code/WCS/WIDESEAWCS_Server/WIDESEAWCS_Tasks/RobotJob/Abstractions/ISocketClientGateway.cs | 38 ++++++++++++++++++++++++++++++++++++--
1 files changed, 36 insertions(+), 2 deletions(-)
diff --git a/Code/WCS/WIDESEAWCS_Server/WIDESEAWCS_Tasks/RobotJob/Abstractions/ISocketClientGateway.cs b/Code/WCS/WIDESEAWCS_Server/WIDESEAWCS_Tasks/RobotJob/Abstractions/ISocketClientGateway.cs
index 68e4edc..b238bb0 100644
--- a/Code/WCS/WIDESEAWCS_Server/WIDESEAWCS_Tasks/RobotJob/Abstractions/ISocketClientGateway.cs
+++ b/Code/WCS/WIDESEAWCS_Server/WIDESEAWCS_Tasks/RobotJob/Abstractions/ISocketClientGateway.cs
@@ -4,17 +4,51 @@
namespace WIDESEAWCS_Tasks.Workflow.Abstractions
{
/// <summary>
- /// Socket 客户端网关。用于隔离 Robot 业务对 TcpSocketServer 的直接依赖。
+ /// Socket 瀹㈡埛绔綉鍏虫帴鍙� - 灏佽 TcpSocketServer 鐨勮闂紝浣夸笟鍔″眰涓嶇洿鎺ヤ緷璧栧簳灞傞�氫俊瀹炵幇
/// </summary>
+ /// <remarks>
+ /// 璇ユ帴鍙f槸涓氬姟灞備笌搴曞眰 TCP 閫氫俊涔嬮棿鐨勬娊璞″眰銆�
+ /// 閫氳繃渚濊禆娉ㄥ叆鍜屼娇鐢ㄦ帴鍙o紝浣夸笂灞備唬鐮佷笉鐩存帴渚濊禆 TcpSocketServer锛�
+ /// 渚夸簬鍚庣画鏇挎崲閫氫俊瀹炵幇鎴栬繘琛屽崟鍏冩祴璇曘��
+ /// </remarks>
public interface ISocketClientGateway
{
+ /// <summary>
+ /// 寮傛鍙戦�佹秷鎭埌鎸囧畾瀹㈡埛绔�
+ /// </summary>
+ /// <param name="clientId">鐩爣瀹㈡埛绔殑 IP 鍦板潃</param>
+ /// <param name="message">瑕佸彂閫佺殑娑堟伅鍐呭</param>
+ /// <returns>鍙戦�佹槸鍚︽垚鍔�</returns>
Task<bool> SendToClientAsync(string clientId, string message);
+ /// <summary>
+ /// 閫氳繃 TcpClient 瀵硅薄鍙戦�佹秷鎭�
+ /// </summary>
+ /// <remarks>
+ /// 涓� SendToClientAsync 鐨勫尯鍒細姝ゆ柟娉曠洿鎺ヤ娇鐢� TcpClient 瀵硅薄锛�
+ /// 閫傜敤浜庨渶瑕佸洖鍐欏搷搴旂粰鍙戦�佹柟鐨勫満鏅��
+ /// </remarks>
+ /// <param name="client">TCP 瀹㈡埛绔繛鎺ュ璞�</param>
+ /// <param name="message">瑕佸彂閫佺殑娑堟伅鍐呭</param>
Task SendMessageAsync(TcpClient client, string message);
+ /// <summary>
+ /// 鑾峰彇鎵�鏈夊凡杩炴帴瀹㈡埛绔殑 ID 鍒楄〃
+ /// </summary>
+ /// <returns>瀹㈡埛绔� IP 鍦板潃鍒楄〃</returns>
IReadOnlyList<string> GetClientIds();
+ /// <summary>
+ /// 寮傛澶勭悊瀹㈡埛绔繛鎺ョ殑娑堟伅寰幆
+ /// </summary>
+ /// <remarks>
+ /// 鍚姩鍚庝細鎸佺画鎺ユ敹瀹㈡埛绔秷鎭紝鐩村埌杩炴帴鏂紑鎴栧彇娑堜护鐗岃瑙﹀彂銆�
+ /// 鐢ㄤ簬绠$悊鍗曚釜瀹㈡埛绔殑鐢熷懡鍛ㄦ湡銆�
+ /// </remarks>
+ /// <param name="client">TCP 瀹㈡埛绔繛鎺�</param>
+ /// <param name="clientId">瀹㈡埛绔爣璇嗭紙閫氬父鏄� IP 鍦板潃锛�</param>
+ /// <param name="cancellationToken">鍙栨秷浠ょ墝</param>
+ /// <param name="robotCrane">鏈哄櫒浜虹姸鎬佸璞�</param>
Task HandleClientAsync(TcpClient client, string clientId, CancellationToken cancellationToken, RobotSocketState robotCrane);
}
}
-
--
Gitblit v1.9.3