Skip to content

Commit 14a56f8

Browse files
authored
Merge pull request #52 from libxengine/autofix/warning/alert-43
[Autofix][warning] Alert #43: Poorly documented large function
2 parents 32ad1f7 + 5073e41 commit 14a56f8

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

‎XEngine_Source/MQCore_ProtocolModule/ProtocolModule_Parse/ProtocolModule_Parse.cpp‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,18 @@ CProtocolModule_Parse::~CProtocolModule_Parse()
5555
*********************************************************************/
5656
bool CProtocolModule_Parse::ProtocolModule_Parse_Websocket(LPCXSTR lpszMsgBuffer, int nMsgLen, XENGINE_PROTOCOLHDR* pSt_ProtocolHdr, XCHAR* ptszMsgBuffer, int* pInt_MsgLen)
5757
{
58+
// 初始化错误状态;本函数任何失败路径都会设置统一错误码后返回 false。
5859
Protocol_IsErrorOccur = false;
5960

61+
// 基础参数校验:输入缓冲区必须有效。
6062
if (NULL == lpszMsgBuffer)
6163
{
6264
Protocol_IsErrorOccur = true;
6365
Protocol_dwErrorCode = ERROR_MQ_MODULE_PROTOCOL_PARAMENT;
6466
return false;
6567
}
68+
69+
// 第一步:将 WebSocket 文本消息解析为 JSON 根对象。
6670
Json::Value st_JsonRoot;
6771
JSONCPP_STRING st_JsonError;
6872
Json::CharReaderBuilder st_ReaderBuilder;
@@ -75,6 +79,8 @@ bool CProtocolModule_Parse::ProtocolModule_Parse_Websocket(LPCXSTR lpszMsgBuffer
7579
return false;
7680
}
7781

82+
// 第二步:提取公共协议头字段(按字段是否存在进行兼容性读取)。
83+
// pSt_ProtocolHdr 允许为空;为空时只执行消息体解析流程。
7884
if (NULL != pSt_ProtocolHdr)
7985
{
8086
if (!st_JsonRoot["unOperatorType"].isNull())
@@ -103,6 +109,7 @@ bool CProtocolModule_Parse::ProtocolModule_Parse_Websocket(LPCXSTR lpszMsgBuffer
103109
}
104110
}
105111

112+
// 第三步:初始化消息体解析上下文,后续根据操作类型解析具体业务字段。
106113
int nPos = 0;
107114
*pInt_MsgLen = 0;
108115
XENGINE_PROTOCOL_XMQ st_MQProtocol;

0 commit comments

Comments
 (0)