工具项目

SocketInterface.h 81KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117
  1. /*
  2. * Copyright: JessMA Open Source (ldcsaa@gmail.com)
  3. *
  4. * Author : Bruce Liang
  5. * Website : http://www.jessma.org
  6. * Project : https://github.com/ldcsaa
  7. * Blog : http://www.cnblogs.com/ldcsaa
  8. * Wiki : http://www.oschina.net/p/hp-socket
  9. * QQ Group : 75375912, 44636872
  10. *
  11. * Licensed under the Apache License, Version 2.0 (the "License");
  12. * you may not use this file except in compliance with the License.
  13. * You may obtain a copy of the License at
  14. *
  15. * http://www.apache.org/licenses/LICENSE-2.0
  16. *
  17. * Unless required by applicable law or agreed to in writing, software
  18. * distributed under the License is distributed on an "AS IS" BASIS,
  19. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20. * See the License for the specific language governing permissions and
  21. * limitations under the License.
  22. */
  23. #pragma once
  24. #include <winsock2.h>
  25. #include "HPTypeDef.h"
  26. /*****************************************************************************************************************************************************/
  27. /***************************************************************** TCP/UDP Interfaces ****************************************************************/
  28. /*****************************************************************************************************************************************************/
  29. /************************************************************************
  30. 名称:复合 Socket 组件接口
  31. 描述:定义复合 Socket 组件的所有操作方法和属性访问方法,复合 Socket 组件同时管理多个 Socket 连接
  32. ************************************************************************/
  33. class IComplexSocket
  34. {
  35. public:
  36. /***********************************************************************/
  37. /***************************** 组件操作方法 *****************************/
  38. /*
  39. * 名称:关闭通信组件
  40. * 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源
  41. *
  42. * 参数:
  43. * 返回值: TRUE -- 成功
  44. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  45. */
  46. virtual BOOL Stop () = 0;
  47. /*
  48. * 名称:发送数据
  49. * 描述:向指定连接发送数据
  50. *
  51. * 参数: dwConnID -- 连接 ID
  52. * pBuffer -- 发送缓冲区
  53. * iLength -- 发送缓冲区长度
  54. * iOffset -- 发送缓冲区指针偏移量
  55. * 返回值: TRUE -- 成功
  56. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  57. */
  58. virtual BOOL Send (CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  59. /*
  60. * 名称:发送多组数据
  61. * 描述:向指定连接发送多组数据
  62. * TCP - 顺序发送所有数据包
  63. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  64. *
  65. * 参数: dwConnID -- 连接 ID
  66. * pBuffers -- 发送缓冲区数组
  67. * iCount -- 发送缓冲区数目
  68. * 返回值: TRUE -- 成功
  69. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  70. */
  71. virtual BOOL SendPackets(CONNID dwConnID, const WSABUF pBuffers[], int iCount) = 0;
  72. /*
  73. * 名称:暂停/恢复接收
  74. * 描述:暂停/恢复某个连接的数据接收工作
  75. *
  76. * 参数: dwConnID -- 连接 ID
  77. * bPause -- TRUE - 暂停, FALSE - 恢复
  78. * 返回值: TRUE -- 成功
  79. * FALSE -- 失败
  80. */
  81. virtual BOOL PauseReceive(CONNID dwConnID, BOOL bPause = TRUE) = 0;
  82. /*
  83. * 名称:断开连接
  84. * 描述:断开某个连接
  85. *
  86. * 参数: dwConnID -- 连接 ID
  87. * bForce -- 是否强制断开连接
  88. * 返回值: TRUE -- 成功
  89. * FALSE -- 失败
  90. */
  91. virtual BOOL Disconnect(CONNID dwConnID, BOOL bForce = TRUE) = 0;
  92. /*
  93. * 名称:断开超时连接
  94. * 描述:断开超过指定时长的连接
  95. *
  96. * 参数: dwPeriod -- 时长(毫秒)
  97. * bForce -- 是否强制断开连接
  98. * 返回值: TRUE -- 成功
  99. * FALSE -- 失败
  100. */
  101. virtual BOOL DisconnectLongConnections(DWORD dwPeriod, BOOL bForce = TRUE) = 0;
  102. /*
  103. * 名称:断开静默连接
  104. * 描述:断开超过指定时长的静默连接
  105. *
  106. * 参数: dwPeriod -- 时长(毫秒)
  107. * bForce -- 是否强制断开连接
  108. * 返回值: TRUE -- 成功
  109. * FALSE -- 失败
  110. */
  111. virtual BOOL DisconnectSilenceConnections(DWORD dwPeriod, BOOL bForce = TRUE) = 0;
  112. public:
  113. /***********************************************************************/
  114. /***************************** 属性访问方法 *****************************/
  115. /*
  116. * 名称:设置连接的附加数据
  117. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序自身决定
  118. *
  119. * 参数: dwConnID -- 连接 ID
  120. * pv -- 数据
  121. * 返回值: TRUE -- 成功
  122. * FALSE -- 失败(无效的连接 ID)
  123. */
  124. virtual BOOL SetConnectionExtra (CONNID dwConnID, PVOID pExtra) = 0;
  125. /*
  126. * 名称:获取连接的附加数据
  127. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序自身决定
  128. *
  129. * 参数: dwConnID -- 连接 ID
  130. * ppv -- 数据指针
  131. * 返回值: TRUE -- 成功
  132. * FALSE -- 失败(无效的连接 ID)
  133. */
  134. virtual BOOL GetConnectionExtra (CONNID dwConnID, PVOID* ppExtra) = 0;
  135. /* 检测是否为安全连接(SSL/HTTPS) */
  136. virtual BOOL IsSecure () = 0;
  137. /* 检查通信组件是否已启动 */
  138. virtual BOOL HasStarted () = 0;
  139. /* 查看通信组件当前状态 */
  140. virtual EnServiceState GetState () = 0;
  141. /* 获取连接数 */
  142. virtual DWORD GetConnectionCount () = 0;
  143. /* 获取所有连接的 CONNID */
  144. virtual BOOL GetAllConnectionIDs (CONNID pIDs[], DWORD& dwCount) = 0;
  145. /* 获取某个连接时长(毫秒) */
  146. virtual BOOL GetConnectPeriod (CONNID dwConnID, DWORD& dwPeriod) = 0;
  147. /* 获取某个连接静默时间(毫秒) */
  148. virtual BOOL GetSilencePeriod (CONNID dwConnID, DWORD& dwPeriod) = 0;
  149. /* 获取某个连接的本地地址信息 */
  150. virtual BOOL GetLocalAddress (CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  151. /* 获取某个连接的远程地址信息 */
  152. virtual BOOL GetRemoteAddress (CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  153. /* 获取最近一次失败操作的错误代码 */
  154. virtual EnSocketError GetLastError () = 0;
  155. /* 获取最近一次失败操作的错误描述 */
  156. virtual LPCTSTR GetLastErrorDesc () = 0;
  157. /* 获取连接中未发出数据的长度 */
  158. virtual BOOL GetPendingDataLength (CONNID dwConnID, int& iPending) = 0;
  159. /* 获取连接的数据接收状态 */
  160. virtual BOOL IsPauseReceive (CONNID dwConnID, BOOL& bPaused) = 0;
  161. /* 设置数据发送策略 */
  162. virtual void SetSendPolicy (EnSendPolicy enSendPolicy) = 0;
  163. /* 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)*/
  164. virtual void SetMaxConnectionCount (DWORD dwMaxConnectionCount) = 0;
  165. /* 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) */
  166. virtual void SetFreeSocketObjLockTime (DWORD dwFreeSocketObjLockTime) = 0;
  167. /* 设置 Socket 缓存池大小(通常设置为平均并发连接数的 1/3 - 1/2) */
  168. virtual void SetFreeSocketObjPool (DWORD dwFreeSocketObjPool) = 0;
  169. /* 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) */
  170. virtual void SetFreeBufferObjPool (DWORD dwFreeBufferObjPool) = 0;
  171. /* 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍) */
  172. virtual void SetFreeSocketObjHold (DWORD dwFreeSocketObjHold) = 0;
  173. /* 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) */
  174. virtual void SetFreeBufferObjHold (DWORD dwFreeBufferObjHold) = 0;
  175. /* 设置工作线程数量(通常设置为 2 * CPU + 2) */
  176. virtual void SetWorkerThreadCount (DWORD dwWorkerThreadCount) = 0;
  177. /* 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE) */
  178. virtual void SetMarkSilence (BOOL bMarkSilence) = 0;
  179. /* 获取数据发送策略 */
  180. virtual EnSendPolicy GetSendPolicy () = 0;
  181. /* 获取最大连接数 */
  182. virtual DWORD GetMaxConnectionCount () = 0;
  183. /* 获取 Socket 缓存对象锁定时间 */
  184. virtual DWORD GetFreeSocketObjLockTime () = 0;
  185. /* 获取 Socket 缓存池大小 */
  186. virtual DWORD GetFreeSocketObjPool () = 0;
  187. /* 获取内存块缓存池大小 */
  188. virtual DWORD GetFreeBufferObjPool () = 0;
  189. /* 获取 Socket 缓存池回收阀值 */
  190. virtual DWORD GetFreeSocketObjHold () = 0;
  191. /* 获取内存块缓存池回收阀值 */
  192. virtual DWORD GetFreeBufferObjHold () = 0;
  193. /* 获取工作线程数量 */
  194. virtual DWORD GetWorkerThreadCount () = 0;
  195. /* 检测是否标记静默时间 */
  196. virtual BOOL IsMarkSilence () = 0;
  197. public:
  198. virtual ~IComplexSocket() {}
  199. };
  200. /************************************************************************
  201. 名称:通信服务端组件接口
  202. 描述:定义通信服务端组件的所有操作方法和属性访问方法
  203. ************************************************************************/
  204. class IServer : public IComplexSocket
  205. {
  206. public:
  207. /***********************************************************************/
  208. /***************************** 组件操作方法 *****************************/
  209. /*
  210. * 名称:启动通信组件
  211. * 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据
  212. *
  213. * 参数: lpszBindAddress -- 监听地址
  214. * usPort -- 监听端口
  215. * 返回值: TRUE -- 成功
  216. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  217. */
  218. virtual BOOL Start (LPCTSTR lpszBindAddress, USHORT usPort) = 0;
  219. public:
  220. /***********************************************************************/
  221. /***************************** 属性访问方法 *****************************/
  222. /* 获取监听 Socket 的地址信息 */
  223. virtual BOOL GetListenAddress(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  224. };
  225. /************************************************************************
  226. 名称:TCP 通信服务端组件接口
  227. 描述:定义 TCP 通信服务端组件的所有操作方法和属性访问方法
  228. ************************************************************************/
  229. class ITcpServer : public IServer
  230. {
  231. public:
  232. /***********************************************************************/
  233. /***************************** 组件操作方法 *****************************/
  234. /*
  235. * 名称:发送小文件
  236. * 描述:向指定连接发送 4096 KB 以下的小文件
  237. *
  238. * 参数: dwConnID -- 连接 ID
  239. * lpszFileName -- 文件路径
  240. * pHead -- 头部附加数据
  241. * pTail -- 尾部附加数据
  242. * 返回值: TRUE -- 成功
  243. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  244. */
  245. virtual BOOL SendSmallFile (CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0;
  246. #ifdef _SSL_SUPPORT
  247. /*
  248. * 名称:初始化通信组件 SSL 环境参数
  249. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  250. *
  251. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  252. * lpszPemCertFile -- 证书文件
  253. * lpszPemKeyFile -- 私钥文件
  254. * lpszKeyPasswod -- 私钥密码(没有密码则为空)
  255. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证或客户端可选)
  256. * fnServerNameCallback -- SNI 回调函数指针(可选)
  257. *
  258. * 返回值: TRUE -- 成功
  259. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  260. */
  261. virtual BOOL SetupSSLContext (int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPasswod = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr, Fn_SNI_ServerNameCallback fnServerNameCallback = nullptr) = 0;
  262. /*
  263. * 名称:增加 SNI 主机证书
  264. * 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书
  265. *
  266. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  267. * lpszPemCertFile -- 证书文件
  268. * lpszPemKeyFile -- 私钥文件
  269. * lpszKeyPasswod -- 私钥密码(没有密码则为空)
  270. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证可选)
  271. *
  272. * 返回值: 正数 -- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机
  273. * 负数 -- 失败,可通过 SYS_GetLastError() 获取失败原因
  274. */
  275. virtual BOOL AddSSLContext (int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPasswod = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr) = 0;
  276. /*
  277. * 名称:清理通信组件 SSL 运行环境
  278. * 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存
  279. * 1、通信组件析构时会自动调用本方法
  280. * 2、当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
  281. *
  282. * 参数: 无
  283. *
  284. * 返回值:无
  285. */
  286. virtual void CleanupSSLContext () = 0;
  287. #endif
  288. public:
  289. /***********************************************************************/
  290. /***************************** 属性访问方法 *****************************/
  291. /* 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多) */
  292. virtual void SetAcceptSocketCount (DWORD dwAcceptSocketCount) = 0;
  293. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) */
  294. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  295. /* 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置) */
  296. virtual void SetSocketListenQueue (DWORD dwSocketListenQueue) = 0;
  297. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:30 * 1000) */
  298. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  299. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:10 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  300. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  301. /* 获取 Accept 预投递数量 */
  302. virtual DWORD GetAcceptSocketCount () = 0;
  303. /* 获取通信数据缓冲区大小 */
  304. virtual DWORD GetSocketBufferSize () = 0;
  305. /* 获取监听 Socket 的等候队列大小 */
  306. virtual DWORD GetSocketListenQueue () = 0;
  307. /* 获取正常心跳包间隔 */
  308. virtual DWORD GetKeepAliveTime () = 0;
  309. /* 获取异常心跳包间隔 */
  310. virtual DWORD GetKeepAliveInterval () = 0;
  311. };
  312. /************************************************************************
  313. 名称:UDP 通信服务端组件接口
  314. 描述:定义 UDP 通信服务端组件的所有操作方法和属性访问方法
  315. ************************************************************************/
  316. class IUdpServer : public IServer
  317. {
  318. public:
  319. /***********************************************************************/
  320. /***************************** 组件操作方法 *****************************/
  321. public:
  322. /***********************************************************************/
  323. /***************************** 属性访问方法 *****************************/
  324. /* 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节) */
  325. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  326. /* 获取数据报文最大长度 */
  327. virtual DWORD GetMaxDatagramSize () = 0;
  328. /* 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小) */
  329. virtual void SetPostReceiveCount (DWORD dwPostReceiveCount) = 0;
  330. /* 获取 Receive 预投递数量 */
  331. virtual DWORD GetPostReceiveCount () = 0;
  332. /* 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) */
  333. virtual void SetDetectAttempts (DWORD dwDetectAttempts) = 0;
  334. /* 设置监测包发送间隔(秒,0 不发送监测包) */
  335. virtual void SetDetectInterval (DWORD dwDetectInterval) = 0;
  336. /* 获取心跳检查次数 */
  337. virtual DWORD GetDetectAttempts () = 0;
  338. /* 获取心跳检查间隔 */
  339. virtual DWORD GetDetectInterval () = 0;
  340. };
  341. /************************************************************************
  342. 名称:通信代理组件接口
  343. 描述:定义通信代理组件的所有操作方法和属性访问方法,代理组件本质是一个同时连接多个服务器的客户端组件
  344. ************************************************************************/
  345. class IAgent : public IComplexSocket
  346. {
  347. public:
  348. /***********************************************************************/
  349. /***************************** 组件操作方法 *****************************/
  350. /*
  351. * 名称:启动通信组件
  352. * 描述:启动通信代理组件,启动完成后可开始连接远程服务器
  353. *
  354. * 参数: lpszBindAddress -- 绑定地址(默认:nullptr,绑定任意地址)
  355. * bAsyncConnect -- 是否采用异步 Connect
  356. * 返回值: TRUE -- 成功
  357. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  358. */
  359. virtual BOOL Start (LPCTSTR lpszBindAddress = nullptr, BOOL bAsyncConnect = TRUE) = 0;
  360. /*
  361. * 名称:连接服务器
  362. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  363. *
  364. * 参数: lpszRemoteAddress -- 服务端地址
  365. * usPort -- 服务端端口
  366. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  367. * pExtra -- 连接附加数据(默认:nullptr)
  368. * 返回值: TRUE -- 成功
  369. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  370. */
  371. virtual BOOL Connect (LPCTSTR lpszRemoteAddress, USHORT usPort, CONNID* pdwConnID = nullptr, PVOID pExtra = nullptr) = 0;
  372. public:
  373. /***********************************************************************/
  374. /***************************** 属性访问方法 *****************************/
  375. /* 获取某个连接的远程主机信息 */
  376. virtual BOOL GetRemoteHost (CONNID dwConnID, TCHAR lpszHost[], int& iHostLen, USHORT& usPort) = 0;
  377. };
  378. /************************************************************************
  379. 名称:TCP 通信代理组件接口
  380. 描述:定义 TCP 通信代理组件的所有操作方法和属性访问方法
  381. ************************************************************************/
  382. class ITcpAgent : public IAgent
  383. {
  384. public:
  385. /***********************************************************************/
  386. /***************************** 组件操作方法 *****************************/
  387. /*
  388. * 名称:发送小文件
  389. * 描述:向指定连接发送 4096 KB 以下的小文件
  390. *
  391. * 参数: dwConnID -- 连接 ID
  392. * lpszFileName -- 文件路径
  393. * pHead -- 头部附加数据
  394. * pTail -- 尾部附加数据
  395. * 返回值: TRUE -- 成功
  396. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  397. */
  398. virtual BOOL SendSmallFile (CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0;
  399. #ifdef _SSL_SUPPORT
  400. /*
  401. * 名称:初始化通信组件 SSL 环境参数
  402. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  403. *
  404. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  405. * lpszPemCertFile -- 证书文件(客户端可选)
  406. * lpszPemKeyFile -- 私钥文件(客户端可选)
  407. * lpszKeyPasswod -- 私钥密码(没有密码则为空)
  408. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证或客户端可选)
  409. *
  410. * 返回值: TRUE -- 成功
  411. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  412. */
  413. virtual BOOL SetupSSLContext (int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPasswod = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr) = 0;
  414. /*
  415. * 名称:清理通信组件 SSL 运行环境
  416. * 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存
  417. * 1、通信组件析构时会自动调用本方法
  418. * 2、当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
  419. *
  420. * 参数: 无
  421. *
  422. * 返回值:无
  423. */
  424. virtual void CleanupSSLContext () = 0;
  425. #endif
  426. public:
  427. /***********************************************************************/
  428. /***************************** 属性访问方法 *****************************/
  429. /* 设置是否启用地址重用机制(默认:不启用) */
  430. virtual void SetReuseAddress (BOOL bReuseAddress) = 0;
  431. /* 检测是否启用地址重用机制 */
  432. virtual BOOL IsReuseAddress () = 0;
  433. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) */
  434. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  435. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:30 * 1000) */
  436. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  437. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:10 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  438. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  439. /* 获取通信数据缓冲区大小 */
  440. virtual DWORD GetSocketBufferSize () = 0;
  441. /* 获取正常心跳包间隔 */
  442. virtual DWORD GetKeepAliveTime () = 0;
  443. /* 获取异常心跳包间隔 */
  444. virtual DWORD GetKeepAliveInterval () = 0;
  445. };
  446. /************************************************************************
  447. 名称:通信客户端组件接口
  448. 描述:定义通信客户端组件的所有操作方法和属性访问方法
  449. ************************************************************************/
  450. class IClient
  451. {
  452. public:
  453. /***********************************************************************/
  454. /***************************** 组件操作方法 *****************************/
  455. /*
  456. * 名称:启动通信组件
  457. * 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据
  458. *
  459. * 参数: lpszRemoteAddress -- 服务端地址
  460. * usPort -- 服务端端口
  461. * bAsyncConnect -- 是否采用异步 Connect
  462. * lpszBindAddress -- 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 任意地址)
  463. * 返回值: TRUE -- 成功
  464. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  465. */
  466. virtual BOOL Start (LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect = TRUE, LPCTSTR lpszBindAddress = nullptr) = 0;
  467. /*
  468. * 名称:关闭通信组件
  469. * 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源
  470. *
  471. * 参数:
  472. * 返回值: TRUE -- 成功
  473. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  474. */
  475. virtual BOOL Stop () = 0;
  476. /*
  477. * 名称:发送数据
  478. * 描述:向服务端发送数据
  479. *
  480. * 参数: pBuffer -- 发送缓冲区
  481. * iLength -- 发送缓冲区长度
  482. * iOffset -- 发送缓冲区指针偏移量
  483. * 返回值: TRUE -- 成功
  484. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  485. */
  486. virtual BOOL Send (const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  487. /*
  488. * 名称:发送多组数据
  489. * 描述:向服务端发送多组数据
  490. * TCP - 顺序发送所有数据包
  491. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  492. *
  493. * 参数: pBuffers -- 发送缓冲区数组
  494. * iCount -- 发送缓冲区数目
  495. * 返回值: TRUE -- 成功
  496. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  497. */
  498. virtual BOOL SendPackets(const WSABUF pBuffers[], int iCount) = 0;
  499. /*
  500. * 名称:暂停/恢复接收
  501. * 描述:暂停/恢复某个连接的数据接收工作
  502. *
  503. * bPause -- TRUE - 暂停, FALSE - 恢复
  504. * 返回值: TRUE -- 成功
  505. * FALSE -- 失败
  506. */
  507. virtual BOOL PauseReceive(BOOL bPause = TRUE) = 0;
  508. public:
  509. /***********************************************************************/
  510. /***************************** 属性访问方法 *****************************/
  511. /* 设置连接的附加数据 */
  512. virtual void SetExtra (PVOID pExtra) = 0;
  513. /* 获取连接的附加数据 */
  514. virtual PVOID GetExtra () = 0;
  515. /* 检测是否为安全连接(SSL/HTTPS) */
  516. virtual BOOL IsSecure () = 0;
  517. /* 检查通信组件是否已启动 */
  518. virtual BOOL HasStarted () = 0;
  519. /* 查看通信组件当前状态 */
  520. virtual EnServiceState GetState () = 0;
  521. /* 获取最近一次失败操作的错误代码 */
  522. virtual EnSocketError GetLastError () = 0;
  523. /* 获取最近一次失败操作的错误描述 */
  524. virtual LPCTSTR GetLastErrorDesc() = 0;
  525. /* 获取该组件对象的连接 ID */
  526. virtual CONNID GetConnectionID () = 0;
  527. /* 获取 Client Socket 的地址信息 */
  528. virtual BOOL GetLocalAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  529. /* 获取连接的远程主机信息 */
  530. virtual BOOL GetRemoteHost (TCHAR lpszHost[], int& iHostLen, USHORT& usPort) = 0;
  531. /* 获取连接中未发出数据的长度 */
  532. virtual BOOL GetPendingDataLength (int& iPending) = 0;
  533. /* 获取连接的数据接收状态 */
  534. virtual BOOL IsPauseReceive (BOOL& bPaused) = 0;
  535. /* 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 ) */
  536. virtual void SetFreeBufferPoolSize (DWORD dwFreeBufferPoolSize) = 0;
  537. /* 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) */
  538. virtual void SetFreeBufferPoolHold (DWORD dwFreeBufferPoolHold) = 0;
  539. /* 获取内存块缓存池大小 */
  540. virtual DWORD GetFreeBufferPoolSize () = 0;
  541. /* 获取内存块缓存池回收阀值 */
  542. virtual DWORD GetFreeBufferPoolHold () = 0;
  543. public:
  544. virtual ~IClient() {}
  545. };
  546. /************************************************************************
  547. 名称:TCP 通信客户端组件接口
  548. 描述:定义 TCP 通信客户端组件的所有操作方法和属性访问方法
  549. ************************************************************************/
  550. class ITcpClient : public IClient
  551. {
  552. public:
  553. /***********************************************************************/
  554. /***************************** 组件操作方法 *****************************/
  555. /*
  556. * 名称:发送小文件
  557. * 描述:向服务端发送 4096 KB 以下的小文件
  558. *
  559. * 参数: lpszFileName -- 文件路径
  560. * pHead -- 头部附加数据
  561. * pTail -- 尾部附加数据
  562. * 返回值: TRUE -- 成功
  563. * FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
  564. */
  565. virtual BOOL SendSmallFile (LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0;
  566. #ifdef _SSL_SUPPORT
  567. /*
  568. * 名称:初始化通信组件 SSL 环境参数
  569. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  570. *
  571. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  572. * lpszPemCertFile -- 证书文件(客户端可选)
  573. * lpszPemKeyFile -- 私钥文件(客户端可选)
  574. * lpszKeyPasswod -- 私钥密码(没有密码则为空)
  575. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证或客户端可选)
  576. *
  577. * 返回值: TRUE -- 成功
  578. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  579. */
  580. virtual BOOL SetupSSLContext (int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPasswod = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr) = 0;
  581. /*
  582. * 名称:清理通信组件 SSL 运行环境
  583. * 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存
  584. * 1、通信组件析构时会自动调用本方法
  585. * 2、当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
  586. *
  587. * 参数: 无
  588. *
  589. * 返回值:无
  590. */
  591. virtual void CleanupSSLContext () = 0;
  592. #endif
  593. public:
  594. /***********************************************************************/
  595. /***************************** 属性访问方法 *****************************/
  596. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj)) */
  597. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  598. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:30 * 1000) */
  599. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  600. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:10 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  601. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  602. /* 获取通信数据缓冲区大小 */
  603. virtual DWORD GetSocketBufferSize () = 0;
  604. /* 获取正常心跳包间隔 */
  605. virtual DWORD GetKeepAliveTime () = 0;
  606. /* 获取异常心跳包间隔 */
  607. virtual DWORD GetKeepAliveInterval () = 0;
  608. };
  609. /************************************************************************
  610. 名称:UDP 通信客户端组件接口
  611. 描述:定义 UDP 通信客户端组件的所有操作方法和属性访问方法
  612. ************************************************************************/
  613. class IUdpClient : public IClient
  614. {
  615. public:
  616. /***********************************************************************/
  617. /***************************** 组件操作方法 *****************************/
  618. public:
  619. /***********************************************************************/
  620. /***************************** 属性访问方法 *****************************/
  621. /* 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节) */
  622. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  623. /* 获取数据报文最大长度 */
  624. virtual DWORD GetMaxDatagramSize() = 0;
  625. /* 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) */
  626. virtual void SetDetectAttempts (DWORD dwDetectAttempts) = 0;
  627. /* 设置监测包发送间隔(秒,0 不发送监测包) */
  628. virtual void SetDetectInterval (DWORD dwDetectInterval) = 0;
  629. /* 获取心跳检查次数 */
  630. virtual DWORD GetDetectAttempts () = 0;
  631. /* 获取心跳检查间隔 */
  632. virtual DWORD GetDetectInterval () = 0;
  633. };
  634. /************************************************************************
  635. 名称:UDP 传播组件接口
  636. 描述:定义 UDP 传播(组播或广播)组件的所有操作方法和属性访问方法
  637. ************************************************************************/
  638. class IUdpCast : public IClient
  639. {
  640. public:
  641. /***********************************************************************/
  642. /***************************** 组件操作方法 *****************************/
  643. public:
  644. /***********************************************************************/
  645. /***************************** 属性访问方法 *****************************/
  646. /* 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节) */
  647. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  648. /* 获取数据报文最大长度 */
  649. virtual DWORD GetMaxDatagramSize() = 0;
  650. /* 设置是否启用地址重用机制(默认:不启用) */
  651. virtual void SetReuseAddress (BOOL bReuseAddress) = 0;
  652. /* 检测是否启用地址重用机制 */
  653. virtual BOOL IsReuseAddress () = 0;
  654. /* 设置传播模式(组播或广播) */
  655. virtual void SetCastMode (EnCastMode enCastMode) = 0;
  656. /* 获取传播模式 */
  657. virtual EnCastMode GetCastMode () = 0;
  658. /* 设置组播报文的 TTL(0 - 255) */
  659. virtual void SetMultiCastTtl (int iMCTtl) = 0;
  660. /* 获取组播报文的 TTL */
  661. virtual int GetMultiCastTtl () = 0;
  662. /* 设置是否启用组播环路(TRUE or FALSE) */
  663. virtual void SetMultiCastLoop (BOOL bMCLoop) = 0;
  664. /* 检测是否启用组播环路 */
  665. virtual BOOL IsMultiCastLoop () = 0;
  666. /* 获取当前数据报的远程地址信息(通常在 OnReceive 事件中调用) */
  667. virtual BOOL GetRemoteAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  668. };
  669. /************************************************************************
  670. 名称:双接口模版类
  671. 描述:定义双接口转换方法
  672. ************************************************************************/
  673. template<class F, class S> class DualInterface : public F, public S
  674. {
  675. public:
  676. /* this 转换为 F* */
  677. inline static F* ToF(DualInterface* pThis)
  678. {
  679. return (F*)(pThis);
  680. }
  681. /* F* 转换为 this */
  682. inline static DualInterface* FromF(F* pF)
  683. {
  684. return (DualInterface*)(pF);
  685. }
  686. /* this 转换为 S* */
  687. inline static S* ToS(DualInterface* pThis)
  688. {
  689. return (S*)(F2S(ToF(pThis)));
  690. }
  691. /* S* 转换为 this */
  692. inline static DualInterface* FromS(S* pS)
  693. {
  694. return FromF(S2F(pS));
  695. }
  696. /* S* 转换为 F* */
  697. inline static F* S2F(S* pS)
  698. {
  699. return (F*)((char*)pS - sizeof(F));
  700. }
  701. /* F* 转换为 S* */
  702. inline static S* F2S(F* pF)
  703. {
  704. return (S*)((char*)pF + sizeof(F));
  705. }
  706. public:
  707. ~DualInterface() {}
  708. };
  709. /************************************************************************
  710. 名称:Server/Agent PULL 模型组件接口
  711. 描述:定义 Server/Agent 组件的 PULL 模型组件的所有操作方法
  712. ************************************************************************/
  713. class IPullSocket
  714. {
  715. public:
  716. /*
  717. * 名称:抓取数据
  718. * 描述:用户通过该方法从 Socket 组件中抓取数据
  719. *
  720. * 参数: dwConnID -- 连接 ID
  721. * pData -- 抓取缓冲区
  722. * iLength -- 抓取数据长度
  723. * 返回值: EnFetchResult
  724. */
  725. virtual EnFetchResult Fetch (CONNID dwConnID, BYTE* pData, int iLength) = 0;
  726. /*
  727. * 名称:窥探数据(不会移除缓冲区数据)
  728. * 描述:用户通过该方法从 Socket 组件中窥探数据
  729. *
  730. * 参数: dwConnID -- 连接 ID
  731. * pData -- 窥探缓冲区
  732. * iLength -- 窥探数据长度
  733. * 返回值: EnFetchResult
  734. */
  735. virtual EnFetchResult Peek (CONNID dwConnID, BYTE* pData, int iLength) = 0;
  736. public:
  737. virtual ~IPullSocket() {}
  738. };
  739. /************************************************************************
  740. 名称:Client PULL 模型组件接口
  741. 描述:定义 Client 组件的 PULL 模型组件的所有操作方法
  742. ************************************************************************/
  743. class IPullClient
  744. {
  745. public:
  746. /*
  747. * 名称:抓取数据
  748. * 描述:用户通过该方法从 Socket 组件中抓取数据
  749. *
  750. * 参数: pData -- 抓取缓冲区
  751. * iLength -- 抓取数据长度
  752. * 返回值: EnFetchResult
  753. */
  754. virtual EnFetchResult Fetch (BYTE* pData, int iLength) = 0;
  755. /*
  756. * 名称:窥探数据(不会移除缓冲区数据)
  757. * 描述:用户通过该方法从 Socket 组件中窥探数据
  758. *
  759. * 参数: pData -- 窥探缓冲区
  760. * iLength -- 窥探数据长度
  761. * 返回值: EnFetchResult
  762. */
  763. virtual EnFetchResult Peek (BYTE* pData, int iLength) = 0;
  764. public:
  765. virtual ~IPullClient() {}
  766. };
  767. /************************************************************************
  768. 名称:TCP PULL 模型组件接口
  769. 描述:继承了 PULL 和 Socket 接口
  770. ************************************************************************/
  771. typedef DualInterface<IPullSocket, ITcpServer> ITcpPullServer;
  772. typedef DualInterface<IPullSocket, ITcpAgent> ITcpPullAgent;
  773. typedef DualInterface<IPullClient, ITcpClient> ITcpPullClient;
  774. /************************************************************************
  775. 名称:Server/Agent PACK 模型组件接口
  776. 描述:定义 Server/Agent 组件的 PACK 模型组件的所有操作方法
  777. ************************************************************************/
  778. class IPackSocket
  779. {
  780. public:
  781. /***********************************************************************/
  782. /***************************** 属性访问方法 *****************************/
  783. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  784. virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0;
  785. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  786. virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0;
  787. /* 获取数据包最大长度 */
  788. virtual DWORD GetMaxPackSize () = 0;
  789. /* 获取包头标识 */
  790. virtual USHORT GetPackHeaderFlag() = 0;
  791. public:
  792. virtual ~IPackSocket() {}
  793. };
  794. /************************************************************************
  795. 名称:Client PACK 模型组件接口
  796. 描述:定义 Client 组件的 PACK 模型组件的所有操作方法
  797. ************************************************************************/
  798. class IPackClient
  799. {
  800. public:
  801. /***********************************************************************/
  802. /***************************** 属性访问方法 *****************************/
  803. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  804. virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0;
  805. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  806. virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0;
  807. /* 获取数据包最大长度 */
  808. virtual DWORD GetMaxPackSize () = 0;
  809. /* 获取包头标识 */
  810. virtual USHORT GetPackHeaderFlag() = 0;
  811. public:
  812. virtual ~IPackClient() {}
  813. };
  814. /************************************************************************
  815. 名称:TCP PACK 模型组件接口
  816. 描述:继承了 PACK 和 Socket 接口
  817. ************************************************************************/
  818. typedef DualInterface<IPackSocket, ITcpServer> ITcpPackServer;
  819. typedef DualInterface<IPackSocket, ITcpAgent> ITcpPackAgent;
  820. typedef DualInterface<IPackClient, ITcpClient> ITcpPackClient;
  821. /************************************************************************
  822. 名称:Socket 监听器基接口
  823. 描述:定义组件监听器的公共方法
  824. ************************************************************************/
  825. template<class T> class ISocketListenerT
  826. {
  827. public:
  828. /*
  829. * 名称:握手完成通知
  830. * 描述:连接完成握手时,Socket 监听器将收到该通知,监听器接收到该通知后才能开始
  831. * 数据收发操作
  832. *
  833. * 参数: pSender -- 事件源对象
  834. * dwConnID -- 连接 ID
  835. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  836. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  837. */
  838. virtual EnHandleResult OnHandShake(T* pSender, CONNID dwConnID) = 0;
  839. /*
  840. * 名称:已发送数据通知
  841. * 描述:成功发送数据后,Socket 监听器将收到该通知
  842. *
  843. * 参数: pSender -- 事件源对象
  844. * dwConnID -- 连接 ID
  845. * pData -- 已发送数据缓冲区
  846. * iLength -- 已发送数据长度
  847. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  848. * HR_ERROR -- 该通知不允许返回 HR_ERROR(调试模式下引发断言错误)
  849. */
  850. virtual EnHandleResult OnSend(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  851. /*
  852. * 名称:数据到达通知(PUSH 模型)
  853. * 描述:对于 PUSH 模型的 Socket 通信组件,成功接收数据后将向 Socket 监听器发送该通知
  854. *
  855. * 参数: pSender -- 事件源对象
  856. * dwConnID -- 连接 ID
  857. * pData -- 已接收数据缓冲区
  858. * iLength -- 已接收数据长度
  859. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  860. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  861. */
  862. virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  863. /*
  864. * 名称:数据到达通知(PULL 模型)
  865. * 描述:对于 PULL 模型的 Socket 通信组件,成功接收数据后将向 Socket 监听器发送该通知
  866. *
  867. * 参数: pSender -- 事件源对象
  868. * dwConnID -- 连接 ID
  869. * iLength -- 已接收数据长度
  870. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  871. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  872. */
  873. virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, int iLength) = 0;
  874. /*
  875. * 名称:通信错误通知
  876. * 描述:通信发生错误后,Socket 监听器将收到该通知,并关闭连接
  877. *
  878. * 参数: pSender -- 事件源对象
  879. * dwConnID -- 连接 ID
  880. * enOperation -- Socket 操作类型
  881. * iErrorCode -- 错误代码
  882. * 返回值: 忽略返回值
  883. */
  884. virtual EnHandleResult OnClose(T* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode) = 0;
  885. public:
  886. virtual ~ISocketListenerT() {}
  887. };
  888. template<class T> class IComplexSocketListenerT : public ISocketListenerT<T>
  889. {
  890. public:
  891. /*
  892. * 名称:关闭通信组件通知
  893. * 描述:通信组件关闭时,Socket 监听器将收到该通知
  894. *
  895. * 参数: pSender -- 事件源对象
  896. * 返回值:忽略返回值
  897. */
  898. virtual EnHandleResult OnShutdown(T* pSender) = 0;
  899. };
  900. /************************************************************************
  901. 名称:服务端 Socket 监听器接口
  902. 描述:定义服务端 Socket 监听器的所有事件
  903. ************************************************************************/
  904. template<class T> class IServerListenerT : public IComplexSocketListenerT<T>
  905. {
  906. public:
  907. /*
  908. * 名称:准备监听通知
  909. * 描述:通信服务端组件启动时,在监听 Socket 创建完成并开始执行监听前,Socket 监听
  910. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  911. *
  912. * 参数: pSender -- 事件源对象
  913. * soListen -- 监听 Socket
  914. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  915. * HR_ERROR -- 终止启动通信服务组件
  916. */
  917. virtual EnHandleResult OnPrepareListen(T* pSender, SOCKET soListen) = 0;
  918. /*
  919. * 名称:接收连接通知
  920. * 描述:接收到客户端连接请求时,Socket 监听器将收到该通知,监听器可以在通知处理方
  921. * 法中执行 Socket 选项设置或拒绝客户端连接等额外工作
  922. *
  923. * 参数: pSender -- 事件源对象
  924. * dwConnID -- 连接 ID
  925. * soClient -- TCP: 客户端 Socket 句柄,UDP: 客户端 Socket SOCKADDR 指针
  926. * 返回值: HR_OK / HR_IGNORE -- 接受连接
  927. * HR_ERROR -- 拒绝连接
  928. */
  929. virtual EnHandleResult OnAccept(T* pSender, CONNID dwConnID, UINT_PTR soClient) = 0;
  930. };
  931. /************************************************************************
  932. 名称:TCP 服务端 Socket 监听器接口
  933. 描述:定义 TCP 服务端 Socket 监听器的所有事件
  934. ************************************************************************/
  935. class ITcpServerListener : public IServerListenerT<ITcpServer>
  936. {
  937. public:
  938. };
  939. /************************************************************************
  940. 名称:PUSH 模型服务端 Socket 监听器抽象基类
  941. 描述:定义某些事件的默认处理方法(忽略事件)
  942. ************************************************************************/
  943. class CTcpServerListener : public ITcpServerListener
  944. {
  945. public:
  946. virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen) {return HR_IGNORE;}
  947. virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient) {return HR_IGNORE;}
  948. virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID) {return HR_IGNORE;}
  949. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  950. virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  951. virtual EnHandleResult OnShutdown(ITcpServer* pSender) {return HR_IGNORE;}
  952. };
  953. /************************************************************************
  954. 名称:PULL 模型服务端 Socket 监听器抽象基类
  955. 描述:定义某些事件的默认处理方法(忽略事件)
  956. ************************************************************************/
  957. class CTcpPullServerListener : public CTcpServerListener
  958. {
  959. public:
  960. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) = 0;
  961. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  962. };
  963. /************************************************************************
  964. 名称:UDP 服务端 Socket 监听器接口
  965. 描述:定义 UDP 服务端 Socket 监听器的所有事件
  966. ************************************************************************/
  967. class IUdpServerListener : public IServerListenerT<IUdpServer>
  968. {
  969. public:
  970. };
  971. /************************************************************************
  972. 名称:UDP 服务端 Socket 监听器抽象基类
  973. 描述:定义某些事件的默认处理方法(忽略事件)
  974. ************************************************************************/
  975. class CUdpServerListener : public IUdpServerListener
  976. {
  977. public:
  978. virtual EnHandleResult OnPrepareListen(IUdpServer* pSender, SOCKET soListen) {return HR_IGNORE;}
  979. virtual EnHandleResult OnAccept(IUdpServer* pSender, CONNID dwConnID, UINT_PTR pSockAddr) {return HR_IGNORE;}
  980. virtual EnHandleResult OnHandShake(IUdpServer* pSender, CONNID dwConnID) {return HR_IGNORE;}
  981. virtual EnHandleResult OnReceive(IUdpServer* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  982. virtual EnHandleResult OnSend(IUdpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  983. virtual EnHandleResult OnShutdown(IUdpServer* pSender) {return HR_IGNORE;}
  984. };
  985. /************************************************************************
  986. 名称:通信代理 Socket 监听器接口
  987. 描述:定义 通信代理 Socket 监听器的所有事件
  988. ************************************************************************/
  989. template<class T> class IAgentListenerT : public IComplexSocketListenerT<T>
  990. {
  991. public:
  992. /*
  993. * 名称:准备连接通知
  994. * 描述:通信客户端组件启动时,在客户端 Socket 创建完成并开始执行连接前,Socket 监听
  995. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  996. *
  997. * 参数: pSender -- 事件源对象
  998. * dwConnID -- 连接 ID
  999. * socket -- 客户端 Socket
  1000. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1001. * HR_ERROR -- 终止启动通信客户端组件
  1002. */
  1003. virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket) = 0;
  1004. /*
  1005. * 名称:连接完成通知
  1006. * 描述:与服务端成功建立连接时,Socket 监听器将收到该通知
  1007. *
  1008. * 参数: pSender -- 事件源对象
  1009. * dwConnID -- 连接 ID
  1010. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1011. * HR_ERROR -- 同步连接:终止启动通信客户端组件
  1012. * 异步连接:关闭连接
  1013. */
  1014. virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID) = 0;
  1015. };
  1016. /************************************************************************
  1017. 名称:TCP 通信代理 Socket 监听器接口
  1018. 描述:定义 TCP 通信代理 Socket 监听器的所有事件
  1019. ************************************************************************/
  1020. class ITcpAgentListener : public IAgentListenerT<ITcpAgent>
  1021. {
  1022. public:
  1023. };
  1024. /************************************************************************
  1025. 名称:PUSH 模型通信代理 Socket 监听器抽象基类
  1026. 描述:定义某些事件的默认处理方法(忽略事件)
  1027. ************************************************************************/
  1028. class CTcpAgentListener : public ITcpAgentListener
  1029. {
  1030. public:
  1031. virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket) {return HR_IGNORE;}
  1032. virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1033. virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1034. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  1035. virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1036. virtual EnHandleResult OnShutdown(ITcpAgent* pSender) {return HR_IGNORE;}
  1037. };
  1038. /************************************************************************
  1039. 名称:PULL 通信代理 Socket 监听器抽象基类
  1040. 描述:定义某些事件的默认处理方法(忽略事件)
  1041. ************************************************************************/
  1042. class CTcpPullAgentListener : public CTcpAgentListener
  1043. {
  1044. public:
  1045. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) = 0;
  1046. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1047. };
  1048. /************************************************************************
  1049. 名称:客户端 Socket 监听器接口
  1050. 描述:定义客户端 Socket 监听器的所有事件
  1051. ************************************************************************/
  1052. template<class T> class IClientListenerT : public ISocketListenerT<T>
  1053. {
  1054. public:
  1055. /*
  1056. * 名称:准备连接通知
  1057. * 描述:通信客户端组件启动时,在客户端 Socket 创建完成并开始执行连接前,Socket 监听
  1058. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1059. *
  1060. * 参数: pSender -- 事件源对象
  1061. * dwConnID -- 连接 ID
  1062. * socket -- 客户端 Socket
  1063. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1064. * HR_ERROR -- 终止启动通信客户端组件
  1065. */
  1066. virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket) = 0;
  1067. /*
  1068. * 名称:连接完成通知
  1069. * 描述:与服务端成功建立连接时,Socket 监听器将收到该通知
  1070. *
  1071. * 参数: pSender -- 事件源对象
  1072. * dwConnID -- 连接 ID
  1073. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1074. * HR_ERROR -- 同步连接:终止启动通信客户端组件
  1075. * 异步连接:关闭连接
  1076. */
  1077. virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID) = 0;
  1078. };
  1079. /************************************************************************
  1080. 名称:TCP 客户端 Socket 监听器接口
  1081. 描述:定义 TCP 客户端 Socket 监听器的所有事件
  1082. ************************************************************************/
  1083. class ITcpClientListener : public IClientListenerT<ITcpClient>
  1084. {
  1085. public:
  1086. };
  1087. /************************************************************************
  1088. 名称:PUSH 模型客户端 Socket 监听器抽象基类
  1089. 描述:定义某些事件的默认处理方法(忽略事件)
  1090. ************************************************************************/
  1091. class CTcpClientListener : public ITcpClientListener
  1092. {
  1093. public:
  1094. virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket) {return HR_IGNORE;}
  1095. virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1096. virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1097. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  1098. virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1099. };
  1100. /************************************************************************
  1101. 名称:PULL 客户端 Socket 监听器抽象基类
  1102. 描述:定义某些事件的默认处理方法(忽略事件)
  1103. ************************************************************************/
  1104. class CTcpPullClientListener : public CTcpClientListener
  1105. {
  1106. public:
  1107. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) = 0;
  1108. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1109. };
  1110. /************************************************************************
  1111. 名称:UDP 客户端 Socket 监听器接口
  1112. 描述:定义 UDP 客户端 Socket 监听器的所有事件
  1113. ************************************************************************/
  1114. class IUdpClientListener : public IClientListenerT<IUdpClient>
  1115. {
  1116. public:
  1117. };
  1118. /************************************************************************
  1119. 名称:UDP 户端 Socket 监听器抽象基类
  1120. 描述:定义某些事件的默认处理方法(忽略事件)
  1121. ************************************************************************/
  1122. class CUdpClientListener : public IUdpClientListener
  1123. {
  1124. public:
  1125. virtual EnHandleResult OnPrepareConnect(IUdpClient* pSender, CONNID dwConnID, SOCKET socket) {return HR_IGNORE;}
  1126. virtual EnHandleResult OnConnect(IUdpClient* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1127. virtual EnHandleResult OnHandShake(IUdpClient* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1128. virtual EnHandleResult OnReceive(IUdpClient* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  1129. virtual EnHandleResult OnSend(IUdpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1130. };
  1131. /************************************************************************
  1132. 名称:UDP 传播 Socket 监听器接口
  1133. 描述:定义 UDP 传播 Socket 监听器的所有事件
  1134. ************************************************************************/
  1135. class IUdpCastListener : public IClientListenerT<IUdpCast>
  1136. {
  1137. public:
  1138. };
  1139. /************************************************************************
  1140. 名称:UDP 传播 Socket 监听器抽象基类
  1141. 描述:定义某些事件的默认处理方法(忽略事件)
  1142. ************************************************************************/
  1143. class CUdpCastListener : public IUdpCastListener
  1144. {
  1145. public:
  1146. virtual EnHandleResult OnPrepareConnect(IUdpCast* pSender, CONNID dwConnID, SOCKET socket) {return HR_IGNORE;}
  1147. virtual EnHandleResult OnConnect(IUdpCast* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1148. virtual EnHandleResult OnHandShake(IUdpCast* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1149. virtual EnHandleResult OnReceive(IUdpCast* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  1150. virtual EnHandleResult OnSend(IUdpCast* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1151. };
  1152. /*****************************************************************************************************************************************************/
  1153. /****************************************************************** HTTP Interfaces ******************************************************************/
  1154. /*****************************************************************************************************************************************************/
  1155. #ifdef _HTTP_SUPPORT
  1156. /************************************************************************
  1157. 名称:复合 Http 组件接口
  1158. 描述:定义复合 Http 组件的所有操作方法和属性访问方法,复合 Http 组件同时管理多个 Http 连接
  1159. ************************************************************************/
  1160. class IComplexHttp
  1161. {
  1162. public:
  1163. /***********************************************************************/
  1164. /***************************** 组件操作方法 *****************************/
  1165. /*
  1166. * 名称:发送 WebSocket 消息
  1167. * 描述:向对端端发送 WebSocket 消息
  1168. *
  1169. * 参数: dwConnID -- 连接 ID
  1170. * bFinal -- 是否结束帧
  1171. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1172. * iOperationCode -- 操作码:0x0 - 0xF
  1173. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  1174. * pData -- 消息体数据缓冲区
  1175. * iLength -- 消息体数据长度
  1176. * ullBodyLen -- 消息总长度
  1177. * ullBodyLen = 0 -> 消息总长度为 iLength
  1178. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1179. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1180. * ullBodyLen < iLength -> 错误参数,发送失败
  1181. * 返回值: TRUE -- 成功
  1182. * FALSE -- 失败
  1183. */
  1184. virtual BOOL SendWSMessage(CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4] = nullptr, BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0) = 0;
  1185. public:
  1186. /***********************************************************************/
  1187. /***************************** 属性访问方法 *****************************/
  1188. /* 设置本地协议版本 */
  1189. virtual void SetLocalVersion(EnHttpVersion usVersion) = 0;
  1190. /* 获取本地协议版本 */
  1191. virtual EnHttpVersion GetLocalVersion() = 0;
  1192. /* 检查是否升级协议 */
  1193. virtual BOOL IsUpgrade(CONNID dwConnID) = 0;
  1194. /* 检查是否有 Keep-Alive 标识 */
  1195. virtual BOOL IsKeepAlive(CONNID dwConnID) = 0;
  1196. /* 获取协议版本 */
  1197. virtual USHORT GetVersion(CONNID dwConnID) = 0;
  1198. /* 获取内容长度 */
  1199. virtual ULONGLONG GetContentLength(CONNID dwConnID) = 0;
  1200. /* 获取内容类型 */
  1201. virtual LPCSTR GetContentType(CONNID dwConnID) = 0;
  1202. /* 获取内容编码 */
  1203. virtual LPCSTR GetContentEncoding(CONNID dwConnID) = 0;
  1204. /* 获取传输编码 */
  1205. virtual LPCSTR GetTransferEncoding(CONNID dwConnID) = 0;
  1206. /* 获取协议升级类型 */
  1207. virtual EnHttpUpgradeType GetUpgradeType(CONNID dwConnID) = 0;
  1208. /* 获取解析错误代码 */
  1209. virtual USHORT GetParseErrorCode(CONNID dwConnID, LPCSTR* lpszErrorDesc = nullptr) = 0;
  1210. /* 获取某个请求头(单值) */
  1211. virtual BOOL GetHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1212. /* 获取某个请求头(多值) */
  1213. virtual BOOL GetHeaders(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1214. /* 获取所有请求头 */
  1215. virtual BOOL GetAllHeaders(CONNID dwConnID, THeader lpHeaders[], DWORD& dwCount) = 0;
  1216. /* 获取所有请求头名称 */
  1217. virtual BOOL GetAllHeaderNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0;
  1218. /* 获取 Cookie */
  1219. virtual BOOL GetCookie(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1220. /* 获取所有 Cookie */
  1221. virtual BOOL GetAllCookies(CONNID dwConnID, TCookie lpCookies[], DWORD& dwCount) = 0;
  1222. /*
  1223. // !! maybe implemented in future !! //
  1224. virtual BOOL GetParam(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1225. virtual BOOL GetParams(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1226. virtual BOOL GetAllParams(CONNID dwConnID, LPPARAM lpszParam[], DWORD& dwCount) = 0;
  1227. virtual BOOL GetAllParamNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0;
  1228. */
  1229. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  1230. virtual BOOL GetWSMessageState(CONNID dwConnID, BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain) = 0;
  1231. public:
  1232. virtual ~IComplexHttp() {}
  1233. };
  1234. /************************************************************************
  1235. 名称:复合 Http 请求者组件接口
  1236. 描述:定义复合 Http 请求者组件的所有操作方法和属性访问方法
  1237. ************************************************************************/
  1238. class IComplexHttpRequester : public IComplexHttp
  1239. {
  1240. public:
  1241. /***********************************************************************/
  1242. /***************************** 组件操作方法 *****************************/
  1243. /*
  1244. * 名称:发送请求
  1245. * 描述:向服务端发送 HTTP 请求
  1246. *
  1247. * 参数: dwConnID -- 连接 ID
  1248. * lpszMethod -- 请求方法
  1249. * lpszPath -- 请求路径
  1250. * lpHeaders -- 请求头
  1251. * iHeaderCount -- 请求头数量
  1252. * pBody -- 请求体
  1253. * iLength -- 请求体长度
  1254. * 返回值: TRUE -- 成功
  1255. * FALSE -- 失败
  1256. */
  1257. virtual BOOL SendRequest(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0;
  1258. /*
  1259. * 名称:发送本地文件
  1260. * 描述:向指定连接发送 4096 KB 以下的小文件
  1261. *
  1262. * 参数: dwConnID -- 连接 ID
  1263. * lpszFileName -- 文件路径
  1264. * lpszMethod -- 请求方法
  1265. * lpszPath -- 请求路径
  1266. * lpHeaders -- 请求头
  1267. * iHeaderCount -- 请求头数量
  1268. * 返回值: TRUE -- 成功
  1269. * FALSE -- 失败
  1270. */
  1271. virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1272. /* 发送 POST 请求 */
  1273. virtual BOOL SendPost(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1274. /* 发送 PUT 请求 */
  1275. virtual BOOL SendPut(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1276. /* 发送 PATCH 请求 */
  1277. virtual BOOL SendPatch(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1278. /* 发送 GET 请求 */
  1279. virtual BOOL SendGet(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1280. /* 发送 DELETE 请求 */
  1281. virtual BOOL SendDelete(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1282. /* 发送 HEAD 请求 */
  1283. virtual BOOL SendHead(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1284. /* 发送 TRACE 请求 */
  1285. virtual BOOL SendTrace(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1286. /* 发送 OPTIONS 请求 */
  1287. virtual BOOL SendOptions(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1288. /* 发送 CONNECT 请求 */
  1289. virtual BOOL SendConnect(CONNID dwConnID, LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1290. public:
  1291. /***********************************************************************/
  1292. /***************************** 属性访问方法 *****************************/
  1293. /* 获取 HTTP 状态码 */
  1294. virtual USHORT GetStatusCode(CONNID dwConnID) = 0;
  1295. /* 设置是否使用 Cookie(默认:TRUE) */
  1296. virtual void SetUseCookie(BOOL bUseCookie) = 0;
  1297. /* 检查是否使用 Cookie */
  1298. virtual BOOL IsUseCookie() = 0;
  1299. };
  1300. /************************************************************************
  1301. 名称:复合 Http 响应者组件接口
  1302. 描述:定义复合 Http 响应者组件的所有操作方法和属性访问方法
  1303. ************************************************************************/
  1304. class IComplexHttpResponder : public IComplexHttp
  1305. {
  1306. public:
  1307. /***********************************************************************/
  1308. /***************************** 组件操作方法 *****************************/
  1309. /*
  1310. * 名称:回复请求
  1311. * 描述:向客户端回复 HTTP 请求
  1312. *
  1313. * 参数: dwConnID -- 连接 ID
  1314. * usStatusCode -- HTTP 状态码
  1315. * lpszDesc -- HTTP 状态描述
  1316. * lpHeaders -- 回复请求头
  1317. * iHeaderCount -- 回复请求头数量
  1318. * pData -- 回复请求体
  1319. * iLength -- 回复请求体长度
  1320. * 返回值: TRUE -- 成功
  1321. * FALSE -- 失败
  1322. */
  1323. virtual BOOL SendResponse(CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc = nullptr, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pData = nullptr, int iLength = 0) = 0;
  1324. /*
  1325. * 名称:发送本地文件
  1326. * 描述:向指定连接发送 4096 KB 以下的小文件
  1327. *
  1328. * 参数: dwConnID -- 连接 ID
  1329. * lpszFileName -- 文件路径
  1330. * usStatusCode -- HTTP 状态码
  1331. * lpszDesc -- HTTP 状态描述
  1332. * lpHeaders -- 回复请求头
  1333. * iHeaderCount -- 回复请求头数量
  1334. * 返回值: TRUE -- 成功
  1335. * FALSE -- 失败
  1336. */
  1337. virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, USHORT usStatusCode = HSC_OK, LPCSTR lpszDesc = nullptr, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1338. /*
  1339. * 名称:释放连接
  1340. * 描述:把连接放入释放队列,等待某个时间(通过 SetReleaseDelay() 设置)关闭连接
  1341. *
  1342. * 参数: dwConnID -- 连接 ID
  1343. * 返回值: TRUE -- 成功
  1344. * FALSE -- 失败
  1345. */
  1346. virtual BOOL Release(CONNID dwConnID) = 0;
  1347. public:
  1348. /***********************************************************************/
  1349. /***************************** 属性访问方法 *****************************/
  1350. /* 获取主机 */
  1351. virtual LPCSTR GetHost(CONNID dwConnID) = 0;
  1352. /* 设置连接释放延时(默认:3000 毫秒) */
  1353. virtual void SetReleaseDelay(DWORD dwReleaseDelay) = 0;
  1354. /* 获取连接释放延时 */
  1355. virtual DWORD GetReleaseDelay() = 0;
  1356. /* 获取请求行 URL 域掩码(URL 域参考:EnHttpUrlField) */
  1357. virtual USHORT GetUrlFieldSet(CONNID dwConnID) = 0;
  1358. /* 获取某个 URL 域值 */
  1359. virtual LPCSTR GetUrlField(CONNID dwConnID, EnHttpUrlField enField) = 0;
  1360. /* 获取请求方法 */
  1361. virtual LPCSTR GetMethod(CONNID dwConnID) = 0;
  1362. };
  1363. /************************************************************************
  1364. 名称:简单 HTTP 组件接口
  1365. 描述:定义 简单 HTTP 组件的所有操作方法和属性访问方法
  1366. ************************************************************************/
  1367. class IHttp
  1368. {
  1369. public:
  1370. /***********************************************************************/
  1371. /***************************** 组件操作方法 *****************************/
  1372. /*
  1373. * 名称:发送 WebSocket 消息
  1374. * 描述:向对端端发送 WebSocket 消息
  1375. *
  1376. * 参数: bFinal -- 是否结束帧
  1377. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1378. * iOperationCode -- 操作码:0x0 - 0xF
  1379. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  1380. * pData -- 消息体数据缓冲区
  1381. * iLength -- 消息体数据长度
  1382. * ullBodyLen -- 消息总长度
  1383. * ullBodyLen = 0 -> 消息总长度为 iLength
  1384. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1385. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1386. * ullBodyLen < iLength -> 错误参数,发送失败
  1387. * 返回值: TRUE -- 成功
  1388. * FALSE -- 失败
  1389. */
  1390. virtual BOOL SendWSMessage(BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4] = nullptr, BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0) = 0;
  1391. public:
  1392. /***********************************************************************/
  1393. /***************************** 属性访问方法 *****************************/
  1394. /* 设置本地协议版本 */
  1395. virtual void SetLocalVersion(EnHttpVersion usVersion) = 0;
  1396. /* 获取本地协议版本 */
  1397. virtual EnHttpVersion GetLocalVersion() = 0;
  1398. /* 检查是否升级协议 */
  1399. virtual BOOL IsUpgrade() = 0;
  1400. /* 检查是否有 Keep-Alive 标识 */
  1401. virtual BOOL IsKeepAlive() = 0;
  1402. /* 获取协议版本 */
  1403. virtual USHORT GetVersion() = 0;
  1404. /* 获取内容长度 */
  1405. virtual ULONGLONG GetContentLength() = 0;
  1406. /* 获取内容类型 */
  1407. virtual LPCSTR GetContentType() = 0;
  1408. /* 获取内容编码 */
  1409. virtual LPCSTR GetContentEncoding() = 0;
  1410. /* 获取传输编码 */
  1411. virtual LPCSTR GetTransferEncoding() = 0;
  1412. /* 获取协议升级类型 */
  1413. virtual EnHttpUpgradeType GetUpgradeType() = 0;
  1414. /* 获取解析错误代码 */
  1415. virtual USHORT GetParseErrorCode(LPCSTR* lpszErrorDesc = nullptr) = 0;
  1416. /* 获取 HTTP 状态码 */
  1417. virtual USHORT GetStatusCode() = 0;
  1418. /* 获取某个请求头(单值) */
  1419. virtual BOOL GetHeader(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1420. /* 获取某个请求头(多值) */
  1421. virtual BOOL GetHeaders(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1422. /* 获取所有请求头 */
  1423. virtual BOOL GetAllHeaders(THeader lpHeaders[], DWORD& dwCount) = 0;
  1424. /* 获取所有请求头名称 */
  1425. virtual BOOL GetAllHeaderNames(LPCSTR lpszName[], DWORD& dwCount) = 0;
  1426. /* 获取 Cookie */
  1427. virtual BOOL GetCookie(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1428. /* 获取所有 Cookie */
  1429. virtual BOOL GetAllCookies(TCookie lpCookies[], DWORD& dwCount) = 0;
  1430. /*
  1431. // !! maybe implemented in future !! //
  1432. virtual BOOL GetParam(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1433. virtual BOOL GetParams(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1434. virtual BOOL GetAllParams(LPPARAM lpszParam[], DWORD& dwCount) = 0;
  1435. virtual BOOL GetAllParamNames(LPCSTR lpszName[], DWORD& dwCount) = 0;
  1436. */
  1437. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  1438. virtual BOOL GetWSMessageState(BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain) = 0;
  1439. public:
  1440. virtual ~IHttp() {}
  1441. };
  1442. /************************************************************************
  1443. 名称:简单 Http 请求者组件接口
  1444. 描述:定义简单 Http 请求者组件的所有操作方法和属性访问方法
  1445. ************************************************************************/
  1446. class IHttpRequester : public IHttp
  1447. {
  1448. public:
  1449. /***********************************************************************/
  1450. /***************************** 组件操作方法 *****************************/
  1451. /*
  1452. * 名称:发送请求
  1453. * 描述:向服务端发送 HTTP 请求
  1454. *
  1455. * 参数: lpszMethod -- 请求方法
  1456. * lpszPath -- 请求路径
  1457. * lpHeaders -- 请求头
  1458. * iHeaderCount -- 请求头数量
  1459. * pBody -- 请求体
  1460. * iLength -- 请求体长度
  1461. * 返回值: TRUE -- 成功
  1462. * FALSE -- 失败
  1463. */
  1464. virtual BOOL SendRequest(LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0;
  1465. /*
  1466. * 名称:发送本地文件
  1467. * 描述:向指定连接发送 4096 KB 以下的小文件
  1468. *
  1469. * 参数: dwConnID -- 连接 ID
  1470. * lpszFileName -- 文件路径
  1471. * lpszMethod -- 请求方法
  1472. * lpszPath -- 请求路径
  1473. * lpHeaders -- 请求头
  1474. * iHeaderCount -- 请求头数量
  1475. * 返回值: TRUE -- 成功
  1476. * FALSE -- 失败
  1477. */
  1478. virtual BOOL SendLocalFile(LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1479. /* 发送 POST 请求 */
  1480. virtual BOOL SendPost(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1481. /* 发送 PUT 请求 */
  1482. virtual BOOL SendPut(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1483. /* 发送 PATCH 请求 */
  1484. virtual BOOL SendPatch(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1485. /* 发送 GET 请求 */
  1486. virtual BOOL SendGet(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1487. /* 发送 DELETE 请求 */
  1488. virtual BOOL SendDelete(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1489. /* 发送 HEAD 请求 */
  1490. virtual BOOL SendHead(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1491. /* 发送 TRACE 请求 */
  1492. virtual BOOL SendTrace(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1493. /* 发送 OPTIONS 请求 */
  1494. virtual BOOL SendOptions(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1495. /* 发送 CONNECT 请求 */
  1496. virtual BOOL SendConnect(LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1497. public:
  1498. /***********************************************************************/
  1499. /***************************** 属性访问方法 *****************************/
  1500. /* 设置是否使用 Cookie(默认:TRUE) */
  1501. virtual void SetUseCookie(BOOL bUseCookie) = 0;
  1502. /* 检查是否使用 Cookie */
  1503. virtual BOOL IsUseCookie() = 0;
  1504. };
  1505. /************************************************************************
  1506. 名称:简单 Http 同步请求者组件接口
  1507. 描述:定义简单 Http 同步请求者组件的所有操作方法和属性访问方法
  1508. ************************************************************************/
  1509. class IHttpSyncRequester : public IHttpRequester
  1510. {
  1511. public:
  1512. /*
  1513. * 名称:发送 URL 请求
  1514. * 描述:向服务端发送 HTTP URL 请求
  1515. *
  1516. * 参数: lpszMethod -- 请求方法
  1517. * lpszUrl -- 请求 URL
  1518. * lpHeaders -- 请求头
  1519. * iHeaderCount -- 请求头数量
  1520. * pBody -- 请求体
  1521. * iLength -- 请求体长度
  1522. * bForceReconnect -- 强制重新连接(默认:FALSE,当请求 URL 的主机和端口与现有连接一致时,重用现有连接)
  1523. * 返回值: TRUE -- 成功
  1524. * FALSE -- 失败
  1525. */
  1526. virtual BOOL OpenUrl(LPCSTR lpszMethod, LPCSTR lpszUrl, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0, BOOL bForceReconnect = FALSE) = 0;
  1527. /***********************************************************************/
  1528. /***************************** 组件操作方法 *****************************/
  1529. /*
  1530. * 名称:清除请求结果
  1531. * 描述:清除上一次请求的响应头和响应体等结果信息(该方法会在每次发送请求前自动调用)
  1532. *
  1533. * 参数:
  1534. * 返回值: TRUE -- 成功
  1535. * FALSE -- 失败
  1536. */
  1537. virtual BOOL CleanupRequestResult () = 0;
  1538. public:
  1539. /***********************************************************************/
  1540. /***************************** 属性访问方法 *****************************/
  1541. /* 设置连接超时(毫秒,0:系统默认超时,默认:5000) */
  1542. virtual void SetConnectTimeout (DWORD dwConnectTimeout) = 0;
  1543. /* 设置请求超时(毫秒,0:无限等待,默认:10000) */
  1544. virtual void SetRequestTimeout (DWORD dwRequestTimeout) = 0;
  1545. /* 获取连接超时 */
  1546. virtual DWORD GetConnectTimeout () = 0;
  1547. /* 获取请求超时 */
  1548. virtual DWORD GetRequestTimeout () = 0;
  1549. /* 获取响应体 */
  1550. virtual BOOL GetResponseBody (LPCBYTE* lpszBody, int* iLength) = 0;
  1551. };
  1552. /************************************************************************
  1553. 名称:HTTP 组件接口
  1554. 描述:继承了 HTTP 和 Socket 接口
  1555. ************************************************************************/
  1556. typedef DualInterface<IComplexHttpResponder, ITcpServer> IHttpServer;
  1557. typedef DualInterface<IComplexHttpRequester, ITcpAgent> IHttpAgent;
  1558. typedef DualInterface<IHttpRequester, ITcpClient> IHttpClient;
  1559. typedef DualInterface<IHttpSyncRequester, ITcpClient> IHttpSyncClient;
  1560. /************************************************************************
  1561. 名称:IComplexHttp 组件监听器基接口
  1562. 描述:定义 IComplexHttp 组件监听器的所有事件
  1563. ************************************************************************/
  1564. template<class T> class IHttpListenerT
  1565. {
  1566. public:
  1567. /*
  1568. * 名称:开始解析通知
  1569. * 描述:开始解析 HTTP 报文时,向监听器发送该通知
  1570. *
  1571. * 参数: pSender -- 事件源对象
  1572. * dwConnID -- 连接 ID
  1573. * 返回值: HPR_OK -- 继续执行
  1574. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1575. */
  1576. virtual EnHttpParseResult OnMessageBegin(T* pSender, CONNID dwConnID) = 0;
  1577. /*
  1578. * 名称:请求行解析完成通知(仅用于 HTTP 服务端)
  1579. * 描述:请求行解析完成后,向监听器发送该通知
  1580. *
  1581. * 参数: pSender -- 事件源对象
  1582. * dwConnID -- 连接 ID
  1583. * lpszMethod -- 请求方法名
  1584. * lpszUrl -- 请求行中的 URL 域
  1585. * 返回值: HPR_OK -- 继续执行
  1586. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1587. */
  1588. virtual EnHttpParseResult OnRequestLine(T* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) = 0;
  1589. /*
  1590. * 名称:状态行解析完成通知(仅用于 HTTP 客户端)
  1591. * 描述:状态行解析完成后,向监听器发送该通知
  1592. *
  1593. * 参数: pSender -- 事件源对象
  1594. * dwConnID -- 连接 ID
  1595. * usStatusCode -- HTTP 状态码
  1596. * lpszDesc -- 状态描述
  1597. * 返回值: HPR_OK -- 继续执行
  1598. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1599. */
  1600. virtual EnHttpParseResult OnStatusLine(T* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) = 0;
  1601. /*
  1602. * 名称:请求头通知
  1603. * 描述:每当解析完成一个请求头后,向监听器发送该通知
  1604. *
  1605. * 参数: pSender -- 事件源对象
  1606. * dwConnID -- 连接 ID
  1607. * lpszName -- 请求头名称
  1608. * lpszValue -- 请求头值
  1609. * 返回值: HPR_OK -- 继续执行
  1610. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1611. */
  1612. virtual EnHttpParseResult OnHeader(T* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) = 0;
  1613. /*
  1614. * 名称:请求头完成通知
  1615. * 描述:解析完成所有请求头后,向监听器发送该通知
  1616. *
  1617. * 参数: pSender -- 事件源对象
  1618. * dwConnID -- 连接 ID
  1619. * 返回值: HPR_OK -- 继续执行
  1620. * HPR_SKIP_BODY -- 跳过当前请求的 HTTP BODY
  1621. * HPR_UPGRADE -- 升级协议
  1622. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1623. */
  1624. virtual EnHttpParseResult OnHeadersComplete(T* pSender, CONNID dwConnID) = 0;
  1625. /*
  1626. * 名称:BODY 报文通知
  1627. * 描述:每当接收到 HTTP BODY 报文,向监听器发送该通知
  1628. *
  1629. * 参数: pSender -- 事件源对象
  1630. * dwConnID -- 连接 ID
  1631. * pData -- 数据缓冲区
  1632. * iLength -- 数据长度
  1633. * 返回值: HPR_OK -- 继续执行
  1634. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1635. */
  1636. virtual EnHttpParseResult OnBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  1637. /*
  1638. * 名称:Chunked 报文头通知
  1639. * 描述:每当解析出一个 Chunked 报文头,向监听器发送该通知
  1640. *
  1641. * 参数: pSender -- 事件源对象
  1642. * dwConnID -- 连接 ID
  1643. * iLength -- Chunked 报文体数据长度
  1644. * 返回值: HPR_OK -- 继续执行
  1645. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1646. */
  1647. virtual EnHttpParseResult OnChunkHeader(T* pSender, CONNID dwConnID, int iLength) = 0;
  1648. /*
  1649. * 名称:Chunked 报文结束通知
  1650. * 描述:每当解析完一个 Chunked 报文,向监听器发送该通知
  1651. *
  1652. * 参数: pSender -- 事件源对象
  1653. * dwConnID -- 连接 ID
  1654. * 返回值: HPR_OK -- 继续执行
  1655. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1656. */
  1657. virtual EnHttpParseResult OnChunkComplete(T* pSender, CONNID dwConnID) = 0;
  1658. /*
  1659. * 名称:完成解析通知
  1660. * 描述:每当解析完成一个完整 HTTP 报文,向监听器发送该通知
  1661. *
  1662. * 参数: pSender -- 事件源对象
  1663. * dwConnID -- 连接 ID
  1664. * 返回值: HPR_OK -- 继续执行
  1665. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  1666. */
  1667. virtual EnHttpParseResult OnMessageComplete(T* pSender, CONNID dwConnID) = 0;
  1668. /*
  1669. * 名称:升级协议通知
  1670. * 描述:当需要升级协议时,向监听器发送该通知
  1671. *
  1672. * 参数: pSender -- 事件源对象
  1673. * dwConnID -- 连接 ID
  1674. * enUpgradeType -- 协议类型
  1675. * 返回值: HPR_OK -- 继续执行
  1676. * HPR_ERROR -- 引发 OnClose() 事件并关闭连接
  1677. */
  1678. virtual EnHttpParseResult OnUpgrade(T* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) = 0;
  1679. /*
  1680. * 名称:解析错误通知
  1681. * 描述:当解析 HTTP 报文错误时,向监听器发送该通知
  1682. *
  1683. * 参数: pSender -- 事件源对象
  1684. * dwConnID -- 连接 ID
  1685. * iErrorCode -- 错误代码
  1686. * lpszErrorDesc -- 错误描述
  1687. * 返回值: HPR_OK -- 继续执行
  1688. * HPR_ERROR -- 引发 OnClose() 事件并关闭连接
  1689. */
  1690. virtual EnHttpParseResult OnParseError(T* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc) = 0;
  1691. /*
  1692. * 名称:WebSocket 数据包头通知
  1693. * 描述:当解析 WebSocket 数据包头时,向监听器发送该通知
  1694. *
  1695. * 参数: pSender -- 事件源对象
  1696. * dwConnID -- 连接 ID
  1697. * bFinal -- 是否结束帧
  1698. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1699. * iOperationCode -- 操作码:0x0 - 0xF
  1700. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  1701. * ullBodyLen -- 消息体长度
  1702. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1703. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1704. */
  1705. virtual EnHandleResult OnWSMessageHeader(T* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) = 0;
  1706. /*
  1707. * 名称:WebSocket 数据包体通知
  1708. * 描述:当接收到 WebSocket 数据包体时,向监听器发送该通知
  1709. *
  1710. * 参数: pSender -- 事件源对象
  1711. * dwConnID -- 连接 ID
  1712. * pData -- 消息体数据缓冲区
  1713. * iLength -- 消息体数据长度
  1714. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1715. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1716. */
  1717. virtual EnHandleResult OnWSMessageBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  1718. /*
  1719. * 名称:WebSocket 数据包完成通知
  1720. * 描述:当完整接收一个 WebSocket 数据包时,向监听器发送该通知
  1721. *
  1722. * 参数: pSender -- 事件源对象
  1723. * dwConnID -- 连接 ID
  1724. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1725. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1726. */
  1727. virtual EnHandleResult OnWSMessageComplete(T* pSender, CONNID dwConnID) = 0;
  1728. public:
  1729. virtual ~IHttpListenerT() {}
  1730. };
  1731. /************************************************************************
  1732. 名称:IHttpServer 组件端监听器接口
  1733. 描述:定义 IHttpServer 监听器的所有事件
  1734. ************************************************************************/
  1735. class IHttpServerListener : public IHttpListenerT<IHttpServer>, public ITcpServerListener
  1736. {
  1737. public:
  1738. };
  1739. /************************************************************************
  1740. 名称:IHttpAgent 组件端监听器接口
  1741. 描述:定义 IHttpAgent 监听器的所有事件
  1742. ************************************************************************/
  1743. class IHttpAgentListener : public IHttpListenerT<IHttpAgent>, public ITcpAgentListener
  1744. {
  1745. public:
  1746. };
  1747. /************************************************************************
  1748. 名称:IHttpClient 组件端监听器接口
  1749. 描述:定义 IHttpClient 监听器的所有事件
  1750. ************************************************************************/
  1751. class IHttpClientListener : public IHttpListenerT<IHttpClient>, public ITcpClientListener
  1752. {
  1753. public:
  1754. };
  1755. /************************************************************************
  1756. 名称:IHttpServerListener 监听器抽象基类
  1757. 描述:定义某些事件的默认处理方法(忽略事件)
  1758. ************************************************************************/
  1759. class CHttpServerListener : public IHttpServerListener
  1760. {
  1761. public:
  1762. virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen) {return HR_IGNORE;}
  1763. virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient) {return HR_IGNORE;}
  1764. virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1765. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  1766. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1767. virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1768. virtual EnHandleResult OnShutdown(ITcpServer* pSender) {return HR_IGNORE;}
  1769. virtual EnHttpParseResult OnMessageBegin(IHttpServer* pSender, CONNID dwConnID) {return HPR_OK;}
  1770. virtual EnHttpParseResult OnRequestLine(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) {return HPR_OK;}
  1771. virtual EnHttpParseResult OnStatusLine(IHttpServer* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) {return HPR_OK;}
  1772. virtual EnHttpParseResult OnHeader(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) {return HPR_OK;}
  1773. virtual EnHttpParseResult OnChunkHeader(IHttpServer* pSender, CONNID dwConnID, int iLength) {return HPR_OK;}
  1774. virtual EnHttpParseResult OnChunkComplete(IHttpServer* pSender, CONNID dwConnID) {return HPR_OK;}
  1775. virtual EnHttpParseResult OnUpgrade(IHttpServer* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) {return HPR_OK;}
  1776. virtual EnHandleResult OnWSMessageHeader(IHttpServer* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) {return HR_IGNORE;}
  1777. virtual EnHandleResult OnWSMessageBody(IHttpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1778. virtual EnHandleResult OnWSMessageComplete(IHttpServer* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1779. };
  1780. /************************************************************************
  1781. 名称:IHttpAgentListener 监听器抽象基类
  1782. 描述:定义某些事件的默认处理方法(忽略事件)
  1783. ************************************************************************/
  1784. class CHttpAgentListener : public IHttpAgentListener
  1785. {
  1786. public:
  1787. virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket) {return HR_IGNORE;}
  1788. virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1789. virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1790. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  1791. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1792. virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1793. virtual EnHandleResult OnShutdown(ITcpAgent* pSender) {return HR_IGNORE;}
  1794. virtual EnHttpParseResult OnMessageBegin(IHttpAgent* pSender, CONNID dwConnID) {return HPR_OK;}
  1795. virtual EnHttpParseResult OnRequestLine(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) {return HPR_OK;}
  1796. virtual EnHttpParseResult OnStatusLine(IHttpAgent* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) {return HPR_OK;}
  1797. virtual EnHttpParseResult OnHeader(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) {return HPR_OK;}
  1798. virtual EnHttpParseResult OnChunkHeader(IHttpAgent* pSender, CONNID dwConnID, int iLength) {return HPR_OK;}
  1799. virtual EnHttpParseResult OnChunkComplete(IHttpAgent* pSender, CONNID dwConnID) {return HPR_OK;}
  1800. virtual EnHttpParseResult OnUpgrade(IHttpAgent* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) {return HPR_OK;}
  1801. virtual EnHandleResult OnWSMessageHeader(IHttpAgent* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) {return HR_IGNORE;}
  1802. virtual EnHandleResult OnWSMessageBody(IHttpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1803. virtual EnHandleResult OnWSMessageComplete(IHttpAgent* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1804. };
  1805. /************************************************************************
  1806. 名称:IHttpClientListener 监听器抽象基类
  1807. 描述:定义某些事件的默认处理方法(忽略事件)
  1808. ************************************************************************/
  1809. class CHttpClientListener : public IHttpClientListener
  1810. {
  1811. public:
  1812. virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket) {return HR_IGNORE;}
  1813. virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1814. virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1815. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) {return HR_IGNORE;}
  1816. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1817. virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1818. virtual EnHttpParseResult OnMessageBegin(IHttpClient* pSender, CONNID dwConnID) {return HPR_OK;}
  1819. virtual EnHttpParseResult OnRequestLine(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) {return HPR_OK;}
  1820. virtual EnHttpParseResult OnStatusLine(IHttpClient* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) {return HPR_OK;}
  1821. virtual EnHttpParseResult OnHeader(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) {return HPR_OK;}
  1822. virtual EnHttpParseResult OnChunkHeader(IHttpClient* pSender, CONNID dwConnID, int iLength) {return HPR_OK;}
  1823. virtual EnHttpParseResult OnChunkComplete(IHttpClient* pSender, CONNID dwConnID) {return HPR_OK;}
  1824. virtual EnHttpParseResult OnUpgrade(IHttpClient* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) {return HPR_OK;}
  1825. virtual EnHandleResult OnWSMessageHeader(IHttpClient* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) {return HR_IGNORE;}
  1826. virtual EnHandleResult OnWSMessageBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1827. virtual EnHandleResult OnWSMessageComplete(IHttpClient* pSender, CONNID dwConnID) {return HR_IGNORE;}
  1828. };
  1829. /************************************************************************
  1830. 名称:IHttpClientListener 监听器抽象基类
  1831. 描述:定义某些事件的默认处理方法(忽略事件)
  1832. ************************************************************************/
  1833. class CHttpSyncClientListener : public CHttpClientListener
  1834. {
  1835. public:
  1836. virtual EnHandleResult OnClose(ITcpClient* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode) {return HR_IGNORE;}
  1837. virtual EnHttpParseResult OnHeadersComplete(IHttpClient* pSender, CONNID dwConnID) {return HPR_OK;}
  1838. virtual EnHttpParseResult OnBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HPR_OK;}
  1839. virtual EnHttpParseResult OnMessageComplete(IHttpClient* pSender, CONNID dwConnID) {return HPR_OK;}
  1840. virtual EnHttpParseResult OnParseError(IHttpClient* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc) {return HPR_OK;}
  1841. };
  1842. #endif