SocketInterface.h 130 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106
  1. /*
  2. * Copyright: JessMA Open Source (ldcsaa@gmail.com)
  3. *
  4. * Author : Bruce Liang
  5. * Website : https://github.com/ldcsaa
  6. * Project : https://github.com/ldcsaa/HP-Socket
  7. * Blog : http://www.cnblogs.com/ldcsaa
  8. * Wiki : http://www.oschina.net/p/hp-socket
  9. * QQ Group : 44636872, 75375912
  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 "HPTypeDef.h"
  25. /*****************************************************************************************************************************************************/
  26. /***************************************************************** TCP/UDP Interfaces ****************************************************************/
  27. /*****************************************************************************************************************************************************/
  28. /************************************************************************
  29. 名称:双接口模版类
  30. 描述:定义双接口转换方法
  31. ************************************************************************/
  32. #if defined(__arm__) && defined(__GNUC__) && !(defined(__clang__) || defined(__llvm__))
  33. #define __DUAL_VPTR_GAP__ sizeof(PVOID)
  34. class __IFakeDualInterface__
  35. {
  36. public:
  37. virtual ~__IFakeDualInterface__() {}
  38. };
  39. template<class F, class S> class DualInterface : public F, private __IFakeDualInterface__, public S
  40. #else
  41. #define __DUAL_VPTR_GAP__ 0
  42. template<class F, class S> class DualInterface : public F, public S
  43. #endif
  44. {
  45. public:
  46. /* this 转换为 F* */
  47. inline static F* ToF(DualInterface* pThis)
  48. {
  49. return (F*)(pThis);
  50. }
  51. /* F* 转换为 this */
  52. inline static DualInterface* FromF(F* pF)
  53. {
  54. return (DualInterface*)(pF);
  55. }
  56. /* this 转换为 S* */
  57. inline static S* ToS(DualInterface* pThis)
  58. {
  59. return (S*)(F2S(ToF(pThis)));
  60. }
  61. /* S* 转换为 this */
  62. inline static DualInterface* FromS(S* pS)
  63. {
  64. return FromF(S2F(pS));
  65. }
  66. /* S* 转换为 F* */
  67. inline static F* S2F(S* pS)
  68. {
  69. return (F*)((char*)pS - (sizeof(F) + __DUAL_VPTR_GAP__));
  70. }
  71. /* F* 转换为 S* */
  72. inline static S* F2S(F* pF)
  73. {
  74. return (S*)((char*)pF + (sizeof(F) + __DUAL_VPTR_GAP__));
  75. }
  76. public:
  77. virtual ~DualInterface() = default;
  78. };
  79. /************************************************************************
  80. 名称:复合 Socket 组件接口
  81. 描述:定义复合 Socket 组件的所有操作方法和属性访问方法,复合 Socket 组件同时管理多个 Socket 连接
  82. ************************************************************************/
  83. class IComplexSocket
  84. {
  85. public:
  86. /***********************************************************************/
  87. /***************************** 组件操作方法 *****************************/
  88. /*
  89. * 名称:关闭通信组件
  90. * 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源
  91. *
  92. * 参数:
  93. * 返回值: TRUE -- 成功
  94. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  95. */
  96. virtual BOOL Stop () = 0;
  97. /*
  98. * 名称:发送数据
  99. * 描述:向指定连接发送数据
  100. *
  101. * 参数: dwConnID -- 连接 ID
  102. * pBuffer -- 发送缓冲区
  103. * iLength -- 发送缓冲区长度
  104. * iOffset -- 发送缓冲区指针偏移量
  105. * 返回值: TRUE -- 成功
  106. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  107. */
  108. virtual BOOL Send (CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  109. /*
  110. * 名称:发送多组数据
  111. * 描述:向指定连接发送多组数据
  112. * TCP - 顺序发送所有数据包
  113. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  114. *
  115. * 参数: dwConnID -- 连接 ID
  116. * pBuffers -- 发送缓冲区数组
  117. * iCount -- 发送缓冲区数目
  118. * 返回值: TRUE -- 成功
  119. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  120. */
  121. virtual BOOL SendPackets(CONNID dwConnID, const WSABUF pBuffers[], int iCount) = 0;
  122. /*
  123. * 名称:暂停/恢复接收
  124. * 描述:暂停/恢复某个连接的数据接收工作
  125. *
  126. * 参数: dwConnID -- 连接 ID
  127. * bPause -- TRUE - 暂停, FALSE - 恢复
  128. * 返回值: TRUE -- 成功
  129. * FALSE -- 失败
  130. */
  131. virtual BOOL PauseReceive(CONNID dwConnID, BOOL bPause = TRUE) = 0;
  132. /*
  133. * 名称:断开连接
  134. * 描述:断开某个连接
  135. *
  136. * 参数: dwConnID -- 连接 ID
  137. * bForce -- 是否强制断开连接
  138. * 返回值: TRUE -- 成功
  139. * FALSE -- 失败
  140. */
  141. virtual BOOL Disconnect(CONNID dwConnID, BOOL bForce = TRUE) = 0;
  142. /*
  143. * 名称:断开超时连接
  144. * 描述:断开超过指定时长的连接
  145. *
  146. * 参数: dwPeriod -- 时长(毫秒)
  147. * bForce -- 是否强制断开连接
  148. * 返回值: TRUE -- 成功
  149. * FALSE -- 失败
  150. */
  151. virtual BOOL DisconnectLongConnections(DWORD dwPeriod, BOOL bForce = TRUE) = 0;
  152. /*
  153. * 名称:断开静默连接
  154. * 描述:断开超过指定时长的静默连接
  155. *
  156. * 参数: dwPeriod -- 时长(毫秒)
  157. * bForce -- 是否强制断开连接
  158. * 返回值: TRUE -- 成功
  159. * FALSE -- 失败
  160. */
  161. virtual BOOL DisconnectSilenceConnections(DWORD dwPeriod, BOOL bForce = TRUE) = 0;
  162. /*
  163. * 名称:等待
  164. * 描述:等待通信组件停止运行
  165. *
  166. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  167. * 返回值: TRUE -- 成功
  168. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  169. */
  170. virtual BOOL Wait(DWORD dwMilliseconds = INFINITE) = 0;
  171. public:
  172. /***********************************************************************/
  173. /***************************** 属性访问方法 *****************************/
  174. /*
  175. * 名称:设置连接的附加数据
  176. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序自身决定
  177. *
  178. * 参数: dwConnID -- 连接 ID
  179. * pv -- 数据
  180. * 返回值: TRUE -- 成功
  181. * FALSE -- 失败(无效的连接 ID)
  182. */
  183. virtual BOOL SetConnectionExtra (CONNID dwConnID, PVOID pExtra) = 0;
  184. /*
  185. * 名称:获取连接的附加数据
  186. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序自身决定
  187. *
  188. * 参数: dwConnID -- 连接 ID
  189. * ppv -- 数据指针
  190. * 返回值: TRUE -- 成功
  191. * FALSE -- 失败(无效的连接 ID)
  192. */
  193. virtual BOOL GetConnectionExtra (CONNID dwConnID, PVOID* ppExtra) = 0;
  194. /* 检测是否为安全连接(SSL/HTTPS) */
  195. virtual BOOL IsSecure () = 0;
  196. /* 检查通信组件是否已启动 */
  197. virtual BOOL HasStarted () = 0;
  198. /* 查看通信组件当前状态 */
  199. virtual EnServiceState GetState () = 0;
  200. /* 获取连接数 */
  201. virtual DWORD GetConnectionCount () = 0;
  202. /* 获取所有连接的 CONNID */
  203. virtual BOOL GetAllConnectionIDs (CONNID pIDs[], DWORD& dwCount) = 0;
  204. /* 获取某个连接时长(毫秒) */
  205. virtual BOOL GetConnectPeriod (CONNID dwConnID, DWORD& dwPeriod) = 0;
  206. /* 获取某个连接静默时间(毫秒) */
  207. virtual BOOL GetSilencePeriod (CONNID dwConnID, DWORD& dwPeriod) = 0;
  208. /* 获取某个连接的本地地址信息 */
  209. virtual BOOL GetLocalAddress (CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  210. /* 获取某个连接的远程地址信息 */
  211. virtual BOOL GetRemoteAddress (CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  212. /* 获取最近一次失败操作的错误代码 */
  213. virtual EnSocketError GetLastError () = 0;
  214. /* 获取最近一次失败操作的错误描述 */
  215. virtual LPCTSTR GetLastErrorDesc () = 0;
  216. /* 获取连接中未发出数据的长度 */
  217. virtual BOOL GetPendingDataLength (CONNID dwConnID, int& iPending) = 0;
  218. /* 获取连接的数据接收状态 */
  219. virtual BOOL IsPauseReceive (CONNID dwConnID, BOOL& bPaused) = 0;
  220. /* 检测是否有效连接 */
  221. virtual BOOL IsConnected (CONNID dwConnID) = 0;
  222. /* 设置地址重用选项 */
  223. virtual void SetReuseAddressPolicy(EnReuseAddressPolicy enReusePolicy) = 0;
  224. /* 设置数据发送策略(对 Linux 平台组件无效) */
  225. virtual void SetSendPolicy (EnSendPolicy enSendPolicy) = 0;
  226. /* 设置 OnSend 事件同步策略(对 Linux 平台组件无效) */
  227. virtual void SetOnSendSyncPolicy (EnOnSendSyncPolicy enSyncPolicy) = 0;
  228. /* 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)*/
  229. virtual void SetMaxConnectionCount (DWORD dwMaxConnectionCount) = 0;
  230. /* 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) */
  231. virtual void SetFreeSocketObjLockTime (DWORD dwFreeSocketObjLockTime) = 0;
  232. /* 设置 Socket 缓存池大小(通常设置为平均并发连接数的 1/3 - 1/2) */
  233. virtual void SetFreeSocketObjPool (DWORD dwFreeSocketObjPool) = 0;
  234. /* 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) */
  235. virtual void SetFreeBufferObjPool (DWORD dwFreeBufferObjPool) = 0;
  236. /* 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍) */
  237. virtual void SetFreeSocketObjHold (DWORD dwFreeSocketObjHold) = 0;
  238. /* 设置内存块缓存池回收阀值 */
  239. virtual void SetFreeBufferObjHold (DWORD dwFreeBufferObjHold) = 0;
  240. /* 设置工作线程数量(通常设置为 2 * CPU + 2) */
  241. virtual void SetWorkerThreadCount (DWORD dwWorkerThreadCount) = 0;
  242. /* 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE) */
  243. virtual void SetMarkSilence (BOOL bMarkSilence) = 0;
  244. /* 获取地址重用选项 */
  245. virtual EnReuseAddressPolicy GetReuseAddressPolicy () = 0;
  246. /* 获取数据发送策略(对 Linux 平台组件无效) */
  247. virtual EnSendPolicy GetSendPolicy () = 0;
  248. /* 获取 OnSend 事件同步策略(对 Linux 平台组件无效) */
  249. virtual EnOnSendSyncPolicy GetOnSendSyncPolicy () = 0;
  250. /* 获取最大连接数 */
  251. virtual DWORD GetMaxConnectionCount () = 0;
  252. /* 获取 Socket 缓存对象锁定时间 */
  253. virtual DWORD GetFreeSocketObjLockTime () = 0;
  254. /* 获取 Socket 缓存池大小 */
  255. virtual DWORD GetFreeSocketObjPool () = 0;
  256. /* 获取内存块缓存池大小 */
  257. virtual DWORD GetFreeBufferObjPool () = 0;
  258. /* 获取 Socket 缓存池回收阀值 */
  259. virtual DWORD GetFreeSocketObjHold () = 0;
  260. /* 获取内存块缓存池回收阀值 */
  261. virtual DWORD GetFreeBufferObjHold () = 0;
  262. /* 获取工作线程数量 */
  263. virtual DWORD GetWorkerThreadCount () = 0;
  264. /* 检测是否标记静默时间 */
  265. virtual BOOL IsMarkSilence () = 0;
  266. public:
  267. virtual ~IComplexSocket() = default;
  268. };
  269. /************************************************************************
  270. 名称:通信服务端组件接口
  271. 描述:定义通信服务端组件的所有操作方法和属性访问方法
  272. ************************************************************************/
  273. class IServer : public IComplexSocket
  274. {
  275. public:
  276. /***********************************************************************/
  277. /***************************** 组件操作方法 *****************************/
  278. /*
  279. * 名称:启动通信组件
  280. * 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据
  281. *
  282. * 参数: lpszBindAddress -- 监听地址
  283. * usPort -- 监听端口
  284. * 返回值: TRUE -- 成功
  285. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  286. */
  287. virtual BOOL Start (LPCTSTR lpszBindAddress, USHORT usPort) = 0;
  288. public:
  289. /***********************************************************************/
  290. /***************************** 属性访问方法 *****************************/
  291. /* 获取监听 Socket 的地址信息 */
  292. virtual BOOL GetListenAddress(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  293. };
  294. /************************************************************************
  295. 名称:TCP 通信服务端组件接口
  296. 描述:定义 TCP 通信服务端组件的所有操作方法和属性访问方法
  297. ************************************************************************/
  298. class ITcpServer : public IServer
  299. {
  300. public:
  301. /***********************************************************************/
  302. /***************************** 组件操作方法 *****************************/
  303. /*
  304. * 名称:发送小文件
  305. * 描述:向指定连接发送 4096 KB 以下的小文件
  306. *
  307. * 参数: dwConnID -- 连接 ID
  308. * lpszFileName -- 文件路径
  309. * pHead -- 头部附加数据
  310. * pTail -- 尾部附加数据
  311. * 返回值: TRUE -- 成功
  312. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  313. */
  314. virtual BOOL SendSmallFile(CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0;
  315. #ifdef _SSL_SUPPORT
  316. /*
  317. * 名称:初始化通信组件 SSL 环境参数
  318. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  319. *
  320. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  321. * lpszPemCertFile -- 证书文件
  322. * lpszPemKeyFile -- 私钥文件
  323. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  324. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证或客户端可选)
  325. * fnServerNameCallback -- SNI 回调函数指针(可选,如果为 nullptr 则使用 SNI 默认回调函数)
  326. *
  327. * 返回值: TRUE -- 成功
  328. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  329. */
  330. virtual BOOL SetupSSLContext(int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPassword = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr, Fn_SNI_ServerNameCallback fnServerNameCallback = nullptr) = 0;
  331. /*
  332. * 名称:初始化通信组件 SSL 环境参数(通过内存加载证书)
  333. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  334. *
  335. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  336. * lpszPemCert -- 证书内容
  337. * lpszPemKey -- 私钥内容
  338. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  339. * lpszCAPemCert -- CA 证书内容(单向验证或客户端可选)
  340. * fnServerNameCallback -- SNI 回调函数指针(可选,如果为 nullptr 则使用 SNI 默认回调函数)
  341. *
  342. * 返回值: TRUE -- 成功
  343. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  344. */
  345. virtual BOOL SetupSSLContextByMemory(int iVerifyMode = SSL_VM_NONE, LPCSTR lpszPemCert = nullptr, LPCSTR lpszPemKey = nullptr, LPCSTR lpszKeyPassword = nullptr, LPCSTR lpszCAPemCert = nullptr, Fn_SNI_ServerNameCallback fnServerNameCallback = nullptr) = 0;
  346. /*
  347. * 名称:增加 SNI 主机证书
  348. * 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书
  349. *
  350. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  351. * lpszPemCertFile -- 证书文件
  352. * lpszPemKeyFile -- 私钥文件
  353. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  354. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证可选)
  355. *
  356. * 返回值: 正数 -- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机
  357. * 负数 -- 失败,可通过 SYS_GetLastError() 获取失败原因
  358. */
  359. virtual int AddSSLContext(int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPassword = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr) = 0;
  360. /*
  361. * 名称:增加 SNI 主机证书(通过内存加载证书)
  362. * 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书
  363. *
  364. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  365. * lpszPemCert -- 证书内容
  366. * lpszPemKey -- 私钥内容
  367. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  368. * lpszCAPemCert -- CA 证书内容(单向验证可选)
  369. *
  370. * 返回值: 正数 -- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机
  371. * 负数 -- 失败,可通过 SYS_GetLastError() 获取失败原因
  372. */
  373. virtual int AddSSLContextByMemory(int iVerifyMode = SSL_VM_NONE, LPCSTR lpszPemCert = nullptr, LPCSTR lpszPemKey = nullptr, LPCSTR lpszKeyPassword = nullptr, LPCSTR lpszCAPemCert = nullptr) = 0;
  374. /*
  375. * 名称:绑定 SNI 主机域名
  376. * 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
  377. *
  378. * 参数: lpszServerName -- 主机域名
  379. * iContextIndex -- SNI 主机证书对应的索引
  380. *
  381. * 返回值: TRUE -- 成功
  382. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  383. */
  384. virtual BOOL BindSSLServerName(LPCTSTR lpszServerName, int iContextIndex) = 0;
  385. /*
  386. * 名称:清理通信组件 SSL 运行环境
  387. * 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存
  388. * 1、通信组件析构时会自动调用本方法
  389. * 2、当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
  390. *
  391. * 参数: 无
  392. *
  393. * 返回值:无
  394. */
  395. virtual void CleanupSSLContext() = 0;
  396. /*
  397. * 名称:启动 SSL 握手
  398. * 描述:当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
  399. *
  400. * 返回值: TRUE -- 成功
  401. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  402. */
  403. virtual BOOL StartSSLHandShake(CONNID dwConnID) = 0;
  404. #endif
  405. public:
  406. /***********************************************************************/
  407. /***************************** 属性访问方法 *****************************/
  408. /* 设置 EPOLL 等待事件的最大数量 */
  409. virtual void SetAcceptSocketCount (DWORD dwAcceptSocketCount) = 0;
  410. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) */
  411. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  412. /* 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置) */
  413. virtual void SetSocketListenQueue (DWORD dwSocketListenQueue) = 0;
  414. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  415. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  416. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  417. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  418. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  419. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  420. /* 获取 EPOLL 等待事件的最大数量 */
  421. virtual DWORD GetAcceptSocketCount () = 0;
  422. /* 获取通信数据缓冲区大小 */
  423. virtual DWORD GetSocketBufferSize () = 0;
  424. /* 获取监听 Socket 的等候队列大小 */
  425. virtual DWORD GetSocketListenQueue () = 0;
  426. /* 获取正常心跳包间隔 */
  427. virtual DWORD GetKeepAliveTime () = 0;
  428. /* 获取异常心跳包间隔 */
  429. virtual DWORD GetKeepAliveInterval () = 0;
  430. /* 检查是否开启 nodelay 模式 */
  431. virtual BOOL IsNoDelay () = 0;
  432. #ifdef _SSL_SUPPORT
  433. /* 设置通信组件握手方式(默认:TRUE,自动握手) */
  434. virtual void SetSSLAutoHandShake(BOOL bAutoHandShake) = 0;
  435. /* 获取通信组件握手方式 */
  436. virtual BOOL IsSSLAutoHandShake() = 0;
  437. /* 设置 SSL 加密算法列表 */
  438. virtual void SetSSLCipherList(LPCTSTR lpszCipherList) = 0;
  439. /* 获取 SSL 加密算法列表 */
  440. virtual LPCTSTR GetSSLCipherList() = 0;
  441. /*
  442. * 名称:获取 SSL Session 信息
  443. * 描述:获取指定类型的 SSL Session 信息(输出类型参考:EnSSLSessionInfo)
  444. *
  445. * 返回值: TRUE -- 成功
  446. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  447. */
  448. virtual BOOL GetSSLSessionInfo(CONNID dwConnID, EnSSLSessionInfo enInfo, LPVOID* lppInfo) = 0;
  449. #endif
  450. };
  451. #ifdef _UDP_SUPPORT
  452. /************************************************************************
  453. 名称:UDP 通信服务端组件接口
  454. 描述:定义 UDP 通信服务端组件的所有操作方法和属性访问方法
  455. ************************************************************************/
  456. class IUdpServer : public IServer
  457. {
  458. public:
  459. /***********************************************************************/
  460. /***************************** 组件操作方法 *****************************/
  461. public:
  462. /***********************************************************************/
  463. /***************************** 属性访问方法 *****************************/
  464. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  465. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  466. /* 获取数据报文最大长度 */
  467. virtual DWORD GetMaxDatagramSize () = 0;
  468. /* 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小) */
  469. virtual void SetPostReceiveCount (DWORD dwPostReceiveCount) = 0;
  470. /* 获取 Receive 预投递数量 */
  471. virtual DWORD GetPostReceiveCount () = 0;
  472. /* 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) */
  473. virtual void SetDetectAttempts (DWORD dwDetectAttempts) = 0;
  474. /* 设置监测包发送间隔(毫秒,0 不发送监测包) */
  475. virtual void SetDetectInterval (DWORD dwDetectInterval) = 0;
  476. /* 获取心跳检查次数 */
  477. virtual DWORD GetDetectAttempts () = 0;
  478. /* 获取心跳检查间隔 */
  479. virtual DWORD GetDetectInterval () = 0;
  480. };
  481. /************************************************************************
  482. 名称:Server/Agent ARQ 模型组件接口
  483. 描述:定义 Server/Agent 组件的 ARQ 模型组件的所有操作方法
  484. ************************************************************************/
  485. class IArqSocket
  486. {
  487. public:
  488. /***********************************************************************/
  489. /***************************** 组件操作方法 *****************************/
  490. public:
  491. /***********************************************************************/
  492. /***************************** 属性访问方法 *****************************/
  493. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  494. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  495. /* 设置是否关闭拥塞控制(默认:FALSE,不关闭) */
  496. virtual void SetTurnoffCongestCtrl (BOOL bTurnOff) = 0;
  497. /* 设置数据刷新间隔(毫秒,默认:60) */
  498. virtual void SetFlushInterval (DWORD dwFlushInterval) = 0;
  499. /* 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传) */
  500. virtual void SetResendByAcks (DWORD dwResendByAcks) = 0;
  501. /* 设置发送窗口大小(数据包数量,默认:128) */
  502. virtual void SetSendWndSize (DWORD dwSendWndSize) = 0;
  503. /* 设置接收窗口大小(数据包数量,默认:512) */
  504. virtual void SetRecvWndSize (DWORD dwRecvWndSize) = 0;
  505. /* 设置最小重传超时时间(毫秒,默认:30) */
  506. virtual void SetMinRto (DWORD dwMinRto) = 0;
  507. /* 设置快速握手次数限制(默认:5,如果为 0 则不限制) */
  508. virtual void SetFastLimit (DWORD dwFastLimit) = 0;
  509. /* 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致) */
  510. virtual void SetMaxTransUnit (DWORD dwMaxTransUnit) = 0;
  511. /* 设置最大数据包大小(默认:4096) */
  512. virtual void SetMaxMessageSize (DWORD dwMaxMessageSize) = 0;
  513. /* 设置握手超时时间(毫秒,默认:5000) */
  514. virtual void SetHandShakeTimeout (DWORD dwHandShakeTimeout) = 0;
  515. /* 检测是否开启 nodelay 模式 */
  516. virtual BOOL IsNoDelay () = 0;
  517. /* 检测是否关闭拥塞控制 */
  518. virtual BOOL IsTurnoffCongestCtrl () = 0;
  519. /* 获取数据刷新间隔 */
  520. virtual DWORD GetFlushInterval () = 0;
  521. /* 获取快速重传 ACK 跨越次数 */
  522. virtual DWORD GetResendByAcks () = 0;
  523. /* 获取发送窗口大小 */
  524. virtual DWORD GetSendWndSize () = 0;
  525. /* 获取接收窗口大小 */
  526. virtual DWORD GetRecvWndSize () = 0;
  527. /* 获取最小重传超时时间 */
  528. virtual DWORD GetMinRto () = 0;
  529. /* 获取快速握手次数限制 */
  530. virtual DWORD GetFastLimit () = 0;
  531. /* 获取最大传输单元 */
  532. virtual DWORD GetMaxTransUnit () = 0;
  533. /* 获取最大数据包大小 */
  534. virtual DWORD GetMaxMessageSize () = 0;
  535. /* 获取握手超时时间 */
  536. virtual DWORD GetHandShakeTimeout () = 0;
  537. /* 获取等待发送包数量 */
  538. virtual BOOL GetWaitingSendMessageCount (CONNID dwConnID, int& iCount) = 0;
  539. public:
  540. virtual ~IArqSocket() = default;
  541. };
  542. /************************************************************************
  543. 名称:UDP ARQ 通信服务端组件接口
  544. 描述:继承了 ARQ 和 Server 接口
  545. ************************************************************************/
  546. typedef DualInterface<IArqSocket, IUdpServer> IUdpArqServer;
  547. #endif
  548. /************************************************************************
  549. 名称:通信代理组件接口
  550. 描述:定义通信代理组件的所有操作方法和属性访问方法,代理组件本质是一个同时连接多个服务器的客户端组件
  551. ************************************************************************/
  552. class IAgent : public IComplexSocket
  553. {
  554. public:
  555. /***********************************************************************/
  556. /***************************** 组件操作方法 *****************************/
  557. /*
  558. * 名称:启动通信组件
  559. * 描述:启动通信代理组件,启动完成后可开始连接远程服务器
  560. *
  561. * 参数: lpszBindAddress -- 绑定地址(默认:nullptr,绑定任意地址)
  562. * bAsyncConnect -- 是否采用异步 Connect
  563. * 返回值: TRUE -- 成功
  564. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  565. */
  566. virtual BOOL Start (LPCTSTR lpszBindAddress = nullptr, BOOL bAsyncConnect = TRUE) = 0;
  567. /*
  568. * 名称:连接服务器
  569. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  570. *
  571. * 参数: lpszRemoteAddress -- 服务端地址
  572. * usPort -- 服务端端口
  573. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  574. * pExtra -- 连接附加数据(默认:nullptr)
  575. * usLocalPort -- 本地端口(默认:0)
  576. * lpszLocalAddress -- 本地地址(默认:nullptr,使用 Start() 方法中绑定的地址)
  577. * 返回值: TRUE -- 成功
  578. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  579. */
  580. virtual BOOL Connect(LPCTSTR lpszRemoteAddress, USHORT usPort, CONNID* pdwConnID = nullptr, PVOID pExtra = nullptr, USHORT usLocalPort = 0, LPCTSTR lpszLocalAddress = nullptr) = 0;
  581. public:
  582. /***********************************************************************/
  583. /***************************** 属性访问方法 *****************************/
  584. /* 获取某个连接的远程主机信息 */
  585. virtual BOOL GetRemoteHost (CONNID dwConnID, TCHAR lpszHost[], int& iHostLen, USHORT& usPort) = 0;
  586. };
  587. /************************************************************************
  588. 名称:TCP 通信代理组件接口
  589. 描述:定义 TCP 通信代理组件的所有操作方法和属性访问方法
  590. ************************************************************************/
  591. class ITcpAgent : public IAgent
  592. {
  593. public:
  594. /***********************************************************************/
  595. /***************************** 组件操作方法 *****************************/
  596. /*
  597. * 名称:发送小文件
  598. * 描述:向指定连接发送 4096 KB 以下的小文件
  599. *
  600. * 参数: dwConnID -- 连接 ID
  601. * lpszFileName -- 文件路径
  602. * pHead -- 头部附加数据
  603. * pTail -- 尾部附加数据
  604. * 返回值: TRUE -- 成功
  605. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  606. */
  607. virtual BOOL SendSmallFile(CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0;
  608. #ifdef _SSL_SUPPORT
  609. /*
  610. * 名称:初始化通信组件 SSL 环境参数
  611. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  612. *
  613. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  614. * lpszPemCertFile -- 证书文件(客户端可选)
  615. * lpszPemKeyFile -- 私钥文件(客户端可选)
  616. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  617. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证或客户端可选)
  618. *
  619. * 返回值: TRUE -- 成功
  620. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  621. */
  622. virtual BOOL SetupSSLContext(int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPassword = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr) = 0;
  623. /*
  624. * 名称:初始化通信组件 SSL 环境参数(通过内存加载证书)
  625. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  626. *
  627. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  628. * lpszPemCert -- 证书内容
  629. * lpszPemKey -- 私钥内容
  630. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  631. * lpszCAPemCert -- CA 证书内容(单向验证或客户端可选)
  632. *
  633. * 返回值: TRUE -- 成功
  634. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  635. */
  636. virtual BOOL SetupSSLContextByMemory(int iVerifyMode = SSL_VM_NONE, LPCSTR lpszPemCert = nullptr, LPCSTR lpszPemKey = nullptr, LPCSTR lpszKeyPassword = nullptr, LPCSTR lpszCAPemCert = nullptr) = 0;
  637. /*
  638. * 名称:清理通信组件 SSL 运行环境
  639. * 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存
  640. * 1、通信组件析构时会自动调用本方法
  641. * 2、当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
  642. *
  643. * 参数: 无
  644. *
  645. * 返回值:无
  646. */
  647. virtual void CleanupSSLContext() = 0;
  648. /*
  649. * 名称:启动 SSL 握手
  650. * 描述:当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
  651. *
  652. * 返回值: TRUE -- 成功
  653. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  654. */
  655. virtual BOOL StartSSLHandShake(CONNID dwConnID) = 0;
  656. #endif
  657. public:
  658. /***********************************************************************/
  659. /***************************** 属性访问方法 *****************************/
  660. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) */
  661. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  662. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  663. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  664. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  665. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  666. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  667. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  668. /* 获取通信数据缓冲区大小 */
  669. virtual DWORD GetSocketBufferSize () = 0;
  670. /* 获取正常心跳包间隔 */
  671. virtual DWORD GetKeepAliveTime () = 0;
  672. /* 获取异常心跳包间隔 */
  673. virtual DWORD GetKeepAliveInterval () = 0;
  674. /* 检查是否开启 nodelay 模式 */
  675. virtual BOOL IsNoDelay () = 0;
  676. #ifdef _SSL_SUPPORT
  677. /* 设置通信组件握手方式(默认:TRUE,自动握手) */
  678. virtual void SetSSLAutoHandShake(BOOL bAutoHandShake) = 0;
  679. /* 获取通信组件握手方式 */
  680. virtual BOOL IsSSLAutoHandShake() = 0;
  681. /* 设置 SSL 加密算法列表 */
  682. virtual void SetSSLCipherList(LPCTSTR lpszCipherList) = 0;
  683. /* 获取 SSL 加密算法列表 */
  684. virtual LPCTSTR GetSSLCipherList() = 0;
  685. /*
  686. * 名称:获取 SSL Session 信息
  687. * 描述:获取指定类型的 SSL Session 信息(输出类型参考:EnSSLSessionInfo)
  688. *
  689. * 返回值: TRUE -- 成功
  690. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  691. */
  692. virtual BOOL GetSSLSessionInfo(CONNID dwConnID, EnSSLSessionInfo enInfo, LPVOID* lppInfo) = 0;
  693. #endif
  694. };
  695. /************************************************************************
  696. 名称:通信客户端组件接口
  697. 描述:定义通信客户端组件的所有操作方法和属性访问方法
  698. ************************************************************************/
  699. class IClient
  700. {
  701. public:
  702. /***********************************************************************/
  703. /***************************** 组件操作方法 *****************************/
  704. /*
  705. * 名称:启动通信组件
  706. * 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据
  707. *
  708. * 参数: lpszRemoteAddress -- 服务端地址
  709. * usPort -- 服务端端口
  710. * bAsyncConnect -- 是否采用异步 Connect
  711. * lpszBindAddress -- 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 任意地址)
  712. * usLocalPort -- 本地端口(默认:0)
  713. * 返回值: TRUE -- 成功
  714. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  715. */
  716. virtual BOOL Start (LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect = TRUE, LPCTSTR lpszBindAddress = nullptr, USHORT usLocalPort = 0) = 0;
  717. /*
  718. * 名称:关闭通信组件
  719. * 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源
  720. *
  721. * 参数:
  722. * 返回值: TRUE -- 成功
  723. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  724. */
  725. virtual BOOL Stop () = 0;
  726. /*
  727. * 名称:发送数据
  728. * 描述:向服务端发送数据
  729. *
  730. * 参数: pBuffer -- 发送缓冲区
  731. * iLength -- 发送缓冲区长度
  732. * iOffset -- 发送缓冲区指针偏移量
  733. * 返回值: TRUE -- 成功
  734. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  735. */
  736. virtual BOOL Send (const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  737. /*
  738. * 名称:发送多组数据
  739. * 描述:向服务端发送多组数据
  740. * TCP - 顺序发送所有数据包
  741. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  742. *
  743. * 参数: pBuffers -- 发送缓冲区数组
  744. * iCount -- 发送缓冲区数目
  745. * 返回值: TRUE -- 成功
  746. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  747. */
  748. virtual BOOL SendPackets(const WSABUF pBuffers[], int iCount) = 0;
  749. /*
  750. * 名称:暂停/恢复接收
  751. * 描述:暂停/恢复某个连接的数据接收工作
  752. *
  753. * bPause -- TRUE - 暂停, FALSE - 恢复
  754. * 返回值: TRUE -- 成功
  755. * FALSE -- 失败
  756. */
  757. virtual BOOL PauseReceive(BOOL bPause = TRUE) = 0;
  758. /*
  759. * 名称:等待
  760. * 描述:等待通信组件停止运行
  761. *
  762. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  763. * 返回值: TRUE -- 成功
  764. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  765. */
  766. virtual BOOL Wait(DWORD dwMilliseconds = INFINITE) = 0;
  767. public:
  768. /***********************************************************************/
  769. /***************************** 属性访问方法 *****************************/
  770. /* 设置连接的附加数据 */
  771. virtual void SetExtra (PVOID pExtra) = 0;
  772. /* 获取连接的附加数据 */
  773. virtual PVOID GetExtra () = 0;
  774. /* 检测是否为安全连接(SSL/HTTPS) */
  775. virtual BOOL IsSecure () = 0;
  776. /* 检查通信组件是否已启动 */
  777. virtual BOOL HasStarted () = 0;
  778. /* 查看通信组件当前状态 */
  779. virtual EnServiceState GetState () = 0;
  780. /* 获取最近一次失败操作的错误代码 */
  781. virtual EnSocketError GetLastError () = 0;
  782. /* 获取最近一次失败操作的错误描述 */
  783. virtual LPCTSTR GetLastErrorDesc() = 0;
  784. /* 获取该组件对象的连接 ID */
  785. virtual CONNID GetConnectionID () = 0;
  786. /* 获取 Client Socket 的地址信息 */
  787. virtual BOOL GetLocalAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  788. /* 获取连接的远程主机信息 */
  789. virtual BOOL GetRemoteHost (TCHAR lpszHost[], int& iHostLen, USHORT& usPort) = 0;
  790. /* 获取连接中未发出数据的长度 */
  791. virtual BOOL GetPendingDataLength (int& iPending) = 0;
  792. /* 获取连接的数据接收状态 */
  793. virtual BOOL IsPauseReceive (BOOL& bPaused) = 0;
  794. /* 检测是否有效连接 */
  795. virtual BOOL IsConnected () = 0;
  796. /* 设置地址重用选项 */
  797. virtual void SetReuseAddressPolicy(EnReuseAddressPolicy enReusePolicy) = 0;
  798. /* 设置内存块缓存池大小 */
  799. virtual void SetFreeBufferPoolSize (DWORD dwFreeBufferPoolSize) = 0;
  800. /* 设置内存块缓存池回收阀值 */
  801. virtual void SetFreeBufferPoolHold (DWORD dwFreeBufferPoolHold) = 0;
  802. /* 获取地址重用选项 */
  803. virtual EnReuseAddressPolicy GetReuseAddressPolicy () = 0;
  804. /* 获取内存块缓存池大小 */
  805. virtual DWORD GetFreeBufferPoolSize () = 0;
  806. /* 获取内存块缓存池回收阀值 */
  807. virtual DWORD GetFreeBufferPoolHold () = 0;
  808. public:
  809. virtual ~IClient() = default;
  810. };
  811. /************************************************************************
  812. 名称:TCP 通信客户端组件接口
  813. 描述:定义 TCP 通信客户端组件的所有操作方法和属性访问方法
  814. ************************************************************************/
  815. class ITcpClient : public IClient
  816. {
  817. public:
  818. /***********************************************************************/
  819. /***************************** 组件操作方法 *****************************/
  820. /*
  821. * 名称:发送小文件
  822. * 描述:向服务端发送 4096 KB 以下的小文件
  823. *
  824. * 参数: lpszFileName -- 文件路径
  825. * pHead -- 头部附加数据
  826. * pTail -- 尾部附加数据
  827. * 返回值: TRUE -- 成功
  828. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  829. */
  830. virtual BOOL SendSmallFile(LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0;
  831. #ifdef _SSL_SUPPORT
  832. /*
  833. * 名称:初始化通信组件 SSL 环境参数
  834. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  835. *
  836. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  837. * lpszPemCertFile -- 证书文件(客户端可选)
  838. * lpszPemKeyFile -- 私钥文件(客户端可选)
  839. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  840. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证或客户端可选)
  841. *
  842. * 返回值: TRUE -- 成功
  843. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  844. */
  845. virtual BOOL SetupSSLContext(int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPassword = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr) = 0;
  846. /*
  847. * 名称:初始化通信组件 SSL 环境参数(通过内存加载证书)
  848. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  849. *
  850. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  851. * lpszPemCert -- 证书内容
  852. * lpszPemKey -- 私钥内容
  853. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  854. * lpszCAPemCert -- CA 证书内容(单向验证或客户端可选)
  855. *
  856. * 返回值: TRUE -- 成功
  857. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  858. */
  859. virtual BOOL SetupSSLContextByMemory(int iVerifyMode = SSL_VM_NONE, LPCSTR lpszPemCert = nullptr, LPCSTR lpszPemKey = nullptr, LPCSTR lpszKeyPassword = nullptr, LPCSTR lpszCAPemCert = nullptr) = 0;
  860. /*
  861. * 名称:清理通信组件 SSL 运行环境
  862. * 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存
  863. * 1、通信组件析构时会自动调用本方法
  864. * 2、当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
  865. *
  866. * 参数: 无
  867. *
  868. * 返回值:无
  869. */
  870. virtual void CleanupSSLContext() = 0;
  871. /*
  872. * 名称:启动 SSL 握手
  873. * 描述:当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
  874. *
  875. * 返回值: TRUE -- 成功
  876. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  877. */
  878. virtual BOOL StartSSLHandShake() = 0;
  879. #endif
  880. public:
  881. /***********************************************************************/
  882. /***************************** 属性访问方法 *****************************/
  883. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj)) */
  884. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  885. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  886. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  887. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  888. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  889. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  890. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  891. /* 获取通信数据缓冲区大小 */
  892. virtual DWORD GetSocketBufferSize () = 0;
  893. /* 获取正常心跳包间隔 */
  894. virtual DWORD GetKeepAliveTime () = 0;
  895. /* 获取异常心跳包间隔 */
  896. virtual DWORD GetKeepAliveInterval () = 0;
  897. /* 检查是否开启 nodelay 模式 */
  898. virtual BOOL IsNoDelay () = 0;
  899. #ifdef _SSL_SUPPORT
  900. /* 设置通信组件握手方式(默认:TRUE,自动握手) */
  901. virtual void SetSSLAutoHandShake(BOOL bAutoHandShake) = 0;
  902. /* 获取通信组件握手方式 */
  903. virtual BOOL IsSSLAutoHandShake() = 0;
  904. /* 设置 SSL 加密算法列表 */
  905. virtual void SetSSLCipherList(LPCTSTR lpszCipherList) = 0;
  906. /* 获取 SSL 加密算法列表 */
  907. virtual LPCTSTR GetSSLCipherList() = 0;
  908. /*
  909. * 名称:获取 SSL Session 信息
  910. * 描述:获取指定类型的 SSL Session 信息(输出类型参考:EnSSLSessionInfo)
  911. *
  912. * 返回值: TRUE -- 成功
  913. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  914. */
  915. virtual BOOL GetSSLSessionInfo(EnSSLSessionInfo enInfo, LPVOID* lppInfo) = 0;
  916. #endif
  917. };
  918. #ifdef _UDP_SUPPORT
  919. /************************************************************************
  920. 名称:UDP 通信客户端组件接口
  921. 描述:定义 UDP 通信客户端组件的所有操作方法和属性访问方法
  922. ************************************************************************/
  923. class IUdpClient : public IClient
  924. {
  925. public:
  926. /***********************************************************************/
  927. /***************************** 组件操作方法 *****************************/
  928. public:
  929. /***********************************************************************/
  930. /***************************** 属性访问方法 *****************************/
  931. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  932. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  933. /* 获取数据报文最大长度 */
  934. virtual DWORD GetMaxDatagramSize() = 0;
  935. /* 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) */
  936. virtual void SetDetectAttempts (DWORD dwDetectAttempts) = 0;
  937. /* 设置监测包发送间隔(毫秒,0 不发送监测包) */
  938. virtual void SetDetectInterval (DWORD dwDetectInterval) = 0;
  939. /* 获取心跳检查次数 */
  940. virtual DWORD GetDetectAttempts () = 0;
  941. /* 获取心跳检查间隔 */
  942. virtual DWORD GetDetectInterval () = 0;
  943. };
  944. /************************************************************************
  945. 名称:UDP 传播组件接口
  946. 描述:定义 UDP 传播(组播或广播)组件的所有操作方法和属性访问方法
  947. ************************************************************************/
  948. class IUdpCast : public IClient
  949. {
  950. public:
  951. /***********************************************************************/
  952. /***************************** 组件操作方法 *****************************/
  953. public:
  954. /***********************************************************************/
  955. /***************************** 属性访问方法 *****************************/
  956. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  957. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  958. /* 获取数据报文最大长度 */
  959. virtual DWORD GetMaxDatagramSize() = 0;
  960. /* 设置传播模式(组播或广播) */
  961. virtual void SetCastMode (EnCastMode enCastMode) = 0;
  962. /* 获取传播模式 */
  963. virtual EnCastMode GetCastMode () = 0;
  964. /* 设置组播报文的 TTL(0 - 255) */
  965. virtual void SetMultiCastTtl (int iMCTtl) = 0;
  966. /* 获取组播报文的 TTL */
  967. virtual int GetMultiCastTtl () = 0;
  968. /* 设置是否启用组播环路(TRUE or FALSE) */
  969. virtual void SetMultiCastLoop (BOOL bMCLoop) = 0;
  970. /* 检测是否启用组播环路 */
  971. virtual BOOL IsMultiCastLoop () = 0;
  972. /* 获取当前数据报的远程地址信息(通常在 OnReceive 事件中调用) */
  973. virtual BOOL GetRemoteAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  974. };
  975. /************************************************************************
  976. 名称:UDP 节点组件接口
  977. 描述:定义 UDP 节点组件的所有操作方法和属性访问方法
  978. ************************************************************************/
  979. class IUdpNode
  980. {
  981. public:
  982. /***********************************************************************/
  983. /***************************** 组件操作方法 *****************************/
  984. /*
  985. * 名称:启动通信组件
  986. * 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
  987. *
  988. * 参数: lpszBindAddress -- 绑定地址(默认:nullptr,绑定任意地址)
  989. * usPort -- 本地端口(默认:0)
  990. * enCastMode -- 传播模式(默认:CM_UNICAST)
  991. * lpszCastAddress -- 传播地址(默认:nullptr,当 enCaseMode 为 CM_MULTICAST 或 CM_BROADCAST 时有效)
  992. * 返回值: TRUE -- 成功
  993. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  994. */
  995. virtual BOOL Start(LPCTSTR lpszBindAddress = nullptr, USHORT usPort = 0, EnCastMode enCastMode = CM_UNICAST, LPCTSTR lpszCastAddress = nullptr) = 0;
  996. /*
  997. * 名称:关闭通信组件
  998. * 描述:关闭 UDP 节点通信组件,关闭完成后释放所有资源
  999. *
  1000. * 参数:
  1001. * 返回值: TRUE -- 成功
  1002. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  1003. */
  1004. virtual BOOL Stop() = 0;
  1005. /*
  1006. * 名称:发送数据
  1007. * 描述:向指定地址发送数据
  1008. *
  1009. * 参数: lpszRemoteAddress -- 远程地址
  1010. * usRemotePort -- 远程端口
  1011. * pBuffer -- 发送缓冲区
  1012. * iLength -- 发送缓冲区长度
  1013. * iOffset -- 发送缓冲区指针偏移量
  1014. * 返回值: TRUE -- 成功
  1015. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1016. */
  1017. virtual BOOL Send(LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  1018. /*
  1019. * 名称:发送多组数据
  1020. * 描述:向指定地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  1021. *
  1022. * 参数: lpszRemoteAddress -- 远程地址
  1023. * usRemotePort -- 远程端口
  1024. * pBuffers -- 发送缓冲区数组
  1025. * iCount -- 发送缓冲区数目
  1026. * 返回值: TRUE -- 成功
  1027. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1028. */
  1029. virtual BOOL SendPackets(LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const WSABUF pBuffers[], int iCount) = 0;
  1030. /*
  1031. * 名称:发送数据
  1032. * 描述:向传播地址发送数据
  1033. *
  1034. * 参数: pBuffer -- 发送缓冲区
  1035. * iLength -- 发送缓冲区长度
  1036. * iOffset -- 发送缓冲区指针偏移量
  1037. * 返回值: TRUE -- 成功
  1038. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1039. */
  1040. virtual BOOL SendCast(const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  1041. /*
  1042. * 名称:发送多组数据
  1043. * 描述:向传播地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  1044. *
  1045. * 参数: pBuffers -- 发送缓冲区数组
  1046. * iCount -- 发送缓冲区数目
  1047. * 返回值: TRUE -- 成功
  1048. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1049. */
  1050. virtual BOOL SendCastPackets(const WSABUF pBuffers[], int iCount) = 0;
  1051. /*
  1052. * 名称:等待
  1053. * 描述:等待通信组件停止运行
  1054. *
  1055. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  1056. * 返回值: TRUE -- 成功
  1057. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1058. */
  1059. virtual BOOL Wait(DWORD dwMilliseconds = INFINITE) = 0;
  1060. public:
  1061. /***********************************************************************/
  1062. /***************************** 属性访问方法 *****************************/
  1063. /* 设置附加数据 */
  1064. virtual void SetExtra (PVOID pExtra) = 0;
  1065. /* 获取附加数据 */
  1066. virtual PVOID GetExtra () = 0;
  1067. /* 检查通信组件是否已启动 */
  1068. virtual BOOL HasStarted () = 0;
  1069. /* 查看通信组件当前状态 */
  1070. virtual EnServiceState GetState () = 0;
  1071. /* 获取最近一次失败操作的错误代码 */
  1072. virtual EnSocketError GetLastError () = 0;
  1073. /* 获取最近一次失败操作的错误描述 */
  1074. virtual LPCTSTR GetLastErrorDesc () = 0;
  1075. /* 获取本节点地址 */
  1076. virtual BOOL GetLocalAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  1077. /* 获取本节点传播地址 */
  1078. virtual BOOL GetCastAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  1079. /* 获取传播模式 */
  1080. virtual EnCastMode GetCastMode () = 0;
  1081. /* 获取未发出数据的长度 */
  1082. virtual BOOL GetPendingDataLength (int& iPending) = 0;
  1083. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  1084. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  1085. /* 获取数据报文最大长度 */
  1086. virtual DWORD GetMaxDatagramSize() = 0;
  1087. /* 设置组播报文的 TTL(0 - 255) */
  1088. virtual void SetMultiCastTtl (int iMCTtl) = 0;
  1089. /* 获取组播报文的 TTL */
  1090. virtual int GetMultiCastTtl () = 0;
  1091. /* 设置是否启用组播环路(TRUE or FALSE) */
  1092. virtual void SetMultiCastLoop (BOOL bMCLoop) = 0;
  1093. /* 检测是否启用组播环路 */
  1094. virtual BOOL IsMultiCastLoop () = 0;
  1095. /* 设置地址重用选项 */
  1096. virtual void SetReuseAddressPolicy(EnReuseAddressPolicy enReusePolicy) = 0;
  1097. /* 设置工作线程数量(通常设置为 2 * CPU + 2) */
  1098. virtual void SetWorkerThreadCount (DWORD dwWorkerThreadCount) = 0;
  1099. /* 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小) */
  1100. virtual void SetPostReceiveCount (DWORD dwPostReceiveCount) = 0;
  1101. /* 设置内存块缓存池大小 */
  1102. virtual void SetFreeBufferPoolSize (DWORD dwFreeBufferPoolSize) = 0;
  1103. /* 设置内存块缓存池回收阀值 */
  1104. virtual void SetFreeBufferPoolHold (DWORD dwFreeBufferPoolHold) = 0;
  1105. /* 获取地址重用选项 */
  1106. virtual EnReuseAddressPolicy GetReuseAddressPolicy() = 0;
  1107. /* 获取工作线程数量 */
  1108. virtual DWORD GetWorkerThreadCount () = 0;
  1109. /* 获取 Receive 预投递数量 */
  1110. virtual DWORD GetPostReceiveCount () = 0;
  1111. /* 获取内存块缓存池大小 */
  1112. virtual DWORD GetFreeBufferPoolSize () = 0;
  1113. /* 获取内存块缓存池回收阀值 */
  1114. virtual DWORD GetFreeBufferPoolHold () = 0;
  1115. public:
  1116. virtual ~IUdpNode() = default;
  1117. };
  1118. /************************************************************************
  1119. 名称:Client ARQ 模型组件接口
  1120. 描述:定义 Client 组件的 ARQ 模型组件的所有操作方法
  1121. ************************************************************************/
  1122. class IArqClient
  1123. {
  1124. public:
  1125. /***********************************************************************/
  1126. /***************************** 组件操作方法 *****************************/
  1127. public:
  1128. /***********************************************************************/
  1129. /***************************** 属性访问方法 *****************************/
  1130. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  1131. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  1132. /* 设置是否关闭拥塞控制(默认:FALSE,不关闭) */
  1133. virtual void SetTurnoffCongestCtrl (BOOL bTurnOff) = 0;
  1134. /* 设置数据刷新间隔(毫秒,默认:60) */
  1135. virtual void SetFlushInterval (DWORD dwFlushInterval) = 0;
  1136. /* 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传) */
  1137. virtual void SetResendByAcks (DWORD dwResendByAcks) = 0;
  1138. /* 设置发送窗口大小(数据包数量,默认:128) */
  1139. virtual void SetSendWndSize (DWORD dwSendWndSize) = 0;
  1140. /* 设置接收窗口大小(数据包数量,默认:512) */
  1141. virtual void SetRecvWndSize (DWORD dwRecvWndSize) = 0;
  1142. /* 设置最小重传超时时间(毫秒,默认:30) */
  1143. virtual void SetMinRto (DWORD dwMinRto) = 0;
  1144. /* 设置快速握手次数限制(默认:5,如果为 0 则不限制) */
  1145. virtual void SetFastLimit (DWORD dwFastLimit) = 0;
  1146. /* 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致) */
  1147. virtual void SetMaxTransUnit (DWORD dwMaxTransUnit) = 0;
  1148. /* 设置最大数据包大小(默认:4096) */
  1149. virtual void SetMaxMessageSize (DWORD dwMaxMessageSize) = 0;
  1150. /* 设置握手超时时间(毫秒,默认:5000) */
  1151. virtual void SetHandShakeTimeout (DWORD dwHandShakeTimeout) = 0;
  1152. /* 检测是否开启 nodelay 模式 */
  1153. virtual BOOL IsNoDelay () = 0;
  1154. /* 检测是否关闭拥塞控制 */
  1155. virtual BOOL IsTurnoffCongestCtrl () = 0;
  1156. /* 获取数据刷新间隔 */
  1157. virtual DWORD GetFlushInterval () = 0;
  1158. /* 获取快速重传 ACK 跨越次数 */
  1159. virtual DWORD GetResendByAcks () = 0;
  1160. /* 获取发送窗口大小 */
  1161. virtual DWORD GetSendWndSize () = 0;
  1162. /* 获取接收窗口大小 */
  1163. virtual DWORD GetRecvWndSize () = 0;
  1164. /* 获取最小重传超时时间 */
  1165. virtual DWORD GetMinRto () = 0;
  1166. /* 获取快速握手次数限制 */
  1167. virtual DWORD GetFastLimit () = 0;
  1168. /* 获取最大传输单元 */
  1169. virtual DWORD GetMaxTransUnit () = 0;
  1170. /* 获取最大数据包大小 */
  1171. virtual DWORD GetMaxMessageSize () = 0;
  1172. /* 获取握手超时时间 */
  1173. virtual DWORD GetHandShakeTimeout () = 0;
  1174. /* 获取等待发送包数量 */
  1175. virtual BOOL GetWaitingSendMessageCount (int& iCount) = 0;
  1176. public:
  1177. virtual ~IArqClient() = default;
  1178. };
  1179. /************************************************************************
  1180. 名称:UDP ARQ 通信客户端组件接口
  1181. 描述:继承了 ARQ 和 Client 接口
  1182. ************************************************************************/
  1183. typedef DualInterface<IArqClient, IUdpClient> IUdpArqClient;
  1184. #endif
  1185. /************************************************************************
  1186. 名称:Server/Agent PULL 模型组件接口
  1187. 描述:定义 Server/Agent 组件的 PULL 模型组件的所有操作方法
  1188. ************************************************************************/
  1189. class IPullSocket
  1190. {
  1191. public:
  1192. /*
  1193. * 名称:抓取数据
  1194. * 描述:用户通过该方法从 Socket 组件中抓取数据
  1195. *
  1196. * 参数: dwConnID -- 连接 ID
  1197. * pData -- 抓取缓冲区
  1198. * iLength -- 抓取数据长度
  1199. * 返回值: EnFetchResult
  1200. */
  1201. virtual EnFetchResult Fetch (CONNID dwConnID, BYTE* pData, int iLength) = 0;
  1202. /*
  1203. * 名称:窥探数据(不会移除缓冲区数据)
  1204. * 描述:用户通过该方法从 Socket 组件中窥探数据
  1205. *
  1206. * 参数: dwConnID -- 连接 ID
  1207. * pData -- 窥探缓冲区
  1208. * iLength -- 窥探数据长度
  1209. * 返回值: EnFetchResult
  1210. */
  1211. virtual EnFetchResult Peek (CONNID dwConnID, BYTE* pData, int iLength) = 0;
  1212. public:
  1213. virtual ~IPullSocket() = default;
  1214. };
  1215. /************************************************************************
  1216. 名称:Client PULL 模型组件接口
  1217. 描述:定义 Client 组件的 PULL 模型组件的所有操作方法
  1218. ************************************************************************/
  1219. class IPullClient
  1220. {
  1221. public:
  1222. /*
  1223. * 名称:抓取数据
  1224. * 描述:用户通过该方法从 Socket 组件中抓取数据
  1225. *
  1226. * 参数: pData -- 抓取缓冲区
  1227. * iLength -- 抓取数据长度
  1228. * 返回值: EnFetchResult
  1229. */
  1230. virtual EnFetchResult Fetch (BYTE* pData, int iLength) = 0;
  1231. /*
  1232. * 名称:窥探数据(不会移除缓冲区数据)
  1233. * 描述:用户通过该方法从 Socket 组件中窥探数据
  1234. *
  1235. * 参数: pData -- 窥探缓冲区
  1236. * iLength -- 窥探数据长度
  1237. * 返回值: EnFetchResult
  1238. */
  1239. virtual EnFetchResult Peek (BYTE* pData, int iLength) = 0;
  1240. public:
  1241. virtual ~IPullClient() = default;
  1242. };
  1243. /************************************************************************
  1244. 名称:TCP PULL 模型组件接口
  1245. 描述:继承了 PULL 和 Socket 接口
  1246. ************************************************************************/
  1247. typedef DualInterface<IPullSocket, ITcpServer> ITcpPullServer;
  1248. typedef DualInterface<IPullSocket, ITcpAgent> ITcpPullAgent;
  1249. typedef DualInterface<IPullClient, ITcpClient> ITcpPullClient;
  1250. /************************************************************************
  1251. 名称:Server/Agent PACK 模型组件接口
  1252. 描述:定义 Server/Agent 组件的 PACK 模型组件的所有操作方法
  1253. ************************************************************************/
  1254. class IPackSocket
  1255. {
  1256. public:
  1257. /***********************************************************************/
  1258. /***************************** 属性访问方法 *****************************/
  1259. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  1260. virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0;
  1261. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  1262. virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0;
  1263. /* 获取数据包最大长度 */
  1264. virtual DWORD GetMaxPackSize () = 0;
  1265. /* 获取包头标识 */
  1266. virtual USHORT GetPackHeaderFlag() = 0;
  1267. public:
  1268. virtual ~IPackSocket() = default;
  1269. };
  1270. /************************************************************************
  1271. 名称:Client PACK 模型组件接口
  1272. 描述:定义 Client 组件的 PACK 模型组件的所有操作方法
  1273. ************************************************************************/
  1274. class IPackClient
  1275. {
  1276. public:
  1277. /***********************************************************************/
  1278. /***************************** 属性访问方法 *****************************/
  1279. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  1280. virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0;
  1281. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  1282. virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0;
  1283. /* 获取数据包最大长度 */
  1284. virtual DWORD GetMaxPackSize () = 0;
  1285. /* 获取包头标识 */
  1286. virtual USHORT GetPackHeaderFlag() = 0;
  1287. public:
  1288. virtual ~IPackClient() = default;
  1289. };
  1290. /************************************************************************
  1291. 名称:TCP PACK 模型组件接口
  1292. 描述:继承了 PACK 和 Socket 接口
  1293. ************************************************************************/
  1294. typedef DualInterface<IPackSocket, ITcpServer> ITcpPackServer;
  1295. typedef DualInterface<IPackSocket, ITcpAgent> ITcpPackAgent;
  1296. typedef DualInterface<IPackClient, ITcpClient> ITcpPackClient;
  1297. /************************************************************************
  1298. 名称:Socket 监听器基接口
  1299. 描述:定义组件监听器的公共方法
  1300. ************************************************************************/
  1301. template<class T> class ISocketListenerT
  1302. {
  1303. public:
  1304. /*
  1305. * 名称:握手完成通知
  1306. * 描述:连接完成握手时,Socket 监听器将收到该通知,监听器接收到该通知后才能开始
  1307. * 数据收发操作
  1308. *
  1309. * 参数: pSender -- 事件源对象
  1310. * dwConnID -- 连接 ID
  1311. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1312. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1313. */
  1314. virtual EnHandleResult OnHandShake(T* pSender, CONNID dwConnID) = 0;
  1315. /*
  1316. * 名称:已发送数据通知
  1317. * 描述:成功发送数据后,Socket 监听器将收到该通知
  1318. *
  1319. * 参数: pSender -- 事件源对象
  1320. * dwConnID -- 连接 ID
  1321. * pData -- 已发送数据缓冲区
  1322. * iLength -- 已发送数据长度
  1323. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1324. * HR_ERROR -- 该通知不允许返回 HR_ERROR(调试模式下引发断言错误)
  1325. */
  1326. virtual EnHandleResult OnSend(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  1327. /*
  1328. * 名称:数据到达通知(PUSH 模型)
  1329. * 描述:对于 PUSH 模型的 Socket 通信组件,成功接收数据后将向 Socket 监听器发送该通知
  1330. *
  1331. * 参数: pSender -- 事件源对象
  1332. * dwConnID -- 连接 ID
  1333. * pData -- 已接收数据缓冲区
  1334. * iLength -- 已接收数据长度
  1335. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1336. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1337. */
  1338. virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  1339. /*
  1340. * 名称:数据到达通知(PULL 模型)
  1341. * 描述:对于 PULL 模型的 Socket 通信组件,成功接收数据后将向 Socket 监听器发送该通知
  1342. *
  1343. * 参数: pSender -- 事件源对象
  1344. * dwConnID -- 连接 ID
  1345. * iLength -- 已接收数据长度
  1346. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1347. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1348. */
  1349. virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, int iLength) = 0;
  1350. /*
  1351. * 名称:通信错误通知
  1352. * 描述:通信发生错误后,Socket 监听器将收到该通知,并关闭连接
  1353. *
  1354. * 参数: pSender -- 事件源对象
  1355. * dwConnID -- 连接 ID
  1356. * enOperation -- Socket 操作类型
  1357. * iErrorCode -- 错误代码
  1358. * 返回值: 忽略返回值
  1359. */
  1360. virtual EnHandleResult OnClose(T* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode) = 0;
  1361. public:
  1362. virtual ~ISocketListenerT() = default;
  1363. };
  1364. template<class T> class IComplexSocketListenerT : public ISocketListenerT<T>
  1365. {
  1366. public:
  1367. /*
  1368. * 名称:关闭通信组件通知
  1369. * 描述:通信组件关闭时,Socket 监听器将收到该通知
  1370. *
  1371. * 参数: pSender -- 事件源对象
  1372. * 返回值: 忽略返回值
  1373. */
  1374. virtual EnHandleResult OnShutdown(T* pSender) = 0;
  1375. };
  1376. /************************************************************************
  1377. 名称:服务端 Socket 监听器接口
  1378. 描述:定义服务端 Socket 监听器的所有事件
  1379. ************************************************************************/
  1380. template<class T> class IServerListenerT : public IComplexSocketListenerT<T>
  1381. {
  1382. public:
  1383. /*
  1384. * 名称:准备监听通知
  1385. * 描述:通信服务端组件启动时,在监听 Socket 创建完成并开始执行监听前,Socket 监听
  1386. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1387. *
  1388. * 参数: pSender -- 事件源对象
  1389. * soListen -- 监听 Socket
  1390. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1391. * HR_ERROR -- 终止启动通信服务组件
  1392. */
  1393. virtual EnHandleResult OnPrepareListen(T* pSender, SOCKET soListen) = 0;
  1394. /*
  1395. * 名称:接收连接通知
  1396. * 描述:接收到客户端连接请求时,Socket 监听器将收到该通知,监听器可以在通知处理方
  1397. * 法中执行 Socket 选项设置或拒绝客户端连接等额外工作
  1398. *
  1399. * 参数: pSender -- 事件源对象
  1400. * dwConnID -- 连接 ID
  1401. * soClient -- TCP: 客户端 Socket 句柄,UDP: 客户端 Socket SOCKADDR 指针
  1402. * 返回值: HR_OK / HR_IGNORE -- 接受连接
  1403. * HR_ERROR -- 拒绝连接
  1404. */
  1405. virtual EnHandleResult OnAccept(T* pSender, CONNID dwConnID, UINT_PTR soClient) = 0;
  1406. };
  1407. /************************************************************************
  1408. 名称:TCP 服务端 Socket 监听器接口
  1409. 描述:定义 TCP 服务端 Socket 监听器的所有事件
  1410. ************************************************************************/
  1411. class ITcpServerListener : public IServerListenerT<ITcpServer>
  1412. {
  1413. public:
  1414. };
  1415. /************************************************************************
  1416. 名称:PUSH 模型服务端 Socket 监听器抽象基类
  1417. 描述:定义某些事件的默认处理方法(忽略事件)
  1418. ************************************************************************/
  1419. class CTcpServerListener : public ITcpServerListener
  1420. {
  1421. public:
  1422. virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen) override {return HR_IGNORE;}
  1423. virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient) override {return HR_IGNORE;}
  1424. virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1425. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1426. virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1427. virtual EnHandleResult OnShutdown(ITcpServer* pSender) override {return HR_IGNORE;}
  1428. };
  1429. /************************************************************************
  1430. 名称:PULL 模型服务端 Socket 监听器抽象基类
  1431. 描述:定义某些事件的默认处理方法(忽略事件)
  1432. ************************************************************************/
  1433. class CTcpPullServerListener : public CTcpServerListener
  1434. {
  1435. public:
  1436. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) override = 0;
  1437. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1438. };
  1439. #ifdef _UDP_SUPPORT
  1440. /************************************************************************
  1441. 名称:UDP 服务端 Socket 监听器接口
  1442. 描述:定义 UDP 服务端 Socket 监听器的所有事件
  1443. ************************************************************************/
  1444. class IUdpServerListener : public IServerListenerT<IUdpServer>
  1445. {
  1446. public:
  1447. };
  1448. /************************************************************************
  1449. 名称:UDP 服务端 Socket 监听器抽象基类
  1450. 描述:定义某些事件的默认处理方法(忽略事件)
  1451. ************************************************************************/
  1452. class CUdpServerListener : public IUdpServerListener
  1453. {
  1454. public:
  1455. virtual EnHandleResult OnPrepareListen(IUdpServer* pSender, SOCKET soListen) override {return HR_IGNORE;}
  1456. virtual EnHandleResult OnAccept(IUdpServer* pSender, CONNID dwConnID, UINT_PTR pSockAddr) override {return HR_IGNORE;}
  1457. virtual EnHandleResult OnHandShake(IUdpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1458. virtual EnHandleResult OnReceive(IUdpServer* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1459. virtual EnHandleResult OnSend(IUdpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1460. virtual EnHandleResult OnShutdown(IUdpServer* pSender) override {return HR_IGNORE;}
  1461. };
  1462. #endif
  1463. /************************************************************************
  1464. 名称:通信代理 Socket 监听器接口
  1465. 描述:定义 通信代理 Socket 监听器的所有事件
  1466. ************************************************************************/
  1467. template<class T> class IAgentListenerT : public IComplexSocketListenerT<T>
  1468. {
  1469. public:
  1470. /*
  1471. * 名称:准备连接通知
  1472. * 描述:通信客户端组件启动时,在客户端 Socket 创建完成并开始执行连接前,Socket 监听
  1473. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1474. *
  1475. * 参数: pSender -- 事件源对象
  1476. * dwConnID -- 连接 ID
  1477. * socket -- 客户端 Socket
  1478. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1479. * HR_ERROR -- 终止启动通信客户端组件
  1480. */
  1481. virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket) = 0;
  1482. /*
  1483. * 名称:连接完成通知
  1484. * 描述:与服务端成功建立连接时,Socket 监听器将收到该通知
  1485. *
  1486. * 参数: pSender -- 事件源对象
  1487. * dwConnID -- 连接 ID
  1488. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1489. * HR_ERROR -- 同步连接:终止启动通信客户端组件
  1490. * 异步连接:关闭连接
  1491. */
  1492. virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID) = 0;
  1493. };
  1494. /************************************************************************
  1495. 名称:TCP 通信代理 Socket 监听器接口
  1496. 描述:定义 TCP 通信代理 Socket 监听器的所有事件
  1497. ************************************************************************/
  1498. class ITcpAgentListener : public IAgentListenerT<ITcpAgent>
  1499. {
  1500. public:
  1501. };
  1502. /************************************************************************
  1503. 名称:PUSH 模型通信代理 Socket 监听器抽象基类
  1504. 描述:定义某些事件的默认处理方法(忽略事件)
  1505. ************************************************************************/
  1506. class CTcpAgentListener : public ITcpAgentListener
  1507. {
  1508. public:
  1509. virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1510. virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1511. virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1512. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1513. virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1514. virtual EnHandleResult OnShutdown(ITcpAgent* pSender) override {return HR_IGNORE;}
  1515. };
  1516. /************************************************************************
  1517. 名称:PULL 通信代理 Socket 监听器抽象基类
  1518. 描述:定义某些事件的默认处理方法(忽略事件)
  1519. ************************************************************************/
  1520. class CTcpPullAgentListener : public CTcpAgentListener
  1521. {
  1522. public:
  1523. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) override = 0;
  1524. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1525. };
  1526. /************************************************************************
  1527. 名称:客户端 Socket 监听器接口
  1528. 描述:定义客户端 Socket 监听器的所有事件
  1529. ************************************************************************/
  1530. template<class T> class IClientListenerT : public ISocketListenerT<T>
  1531. {
  1532. public:
  1533. /*
  1534. * 名称:准备连接通知
  1535. * 描述:通信客户端组件启动时,在客户端 Socket 创建完成并开始执行连接前,Socket 监听
  1536. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1537. *
  1538. * 参数: pSender -- 事件源对象
  1539. * dwConnID -- 连接 ID
  1540. * socket -- 客户端 Socket
  1541. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1542. * HR_ERROR -- 终止启动通信客户端组件
  1543. */
  1544. virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket) = 0;
  1545. /*
  1546. * 名称:连接完成通知
  1547. * 描述:与服务端成功建立连接时,Socket 监听器将收到该通知
  1548. *
  1549. * 参数: pSender -- 事件源对象
  1550. * dwConnID -- 连接 ID
  1551. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1552. * HR_ERROR -- 同步连接:终止启动通信客户端组件
  1553. * 异步连接:关闭连接
  1554. */
  1555. virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID) = 0;
  1556. };
  1557. /************************************************************************
  1558. 名称:TCP 客户端 Socket 监听器接口
  1559. 描述:定义 TCP 客户端 Socket 监听器的所有事件
  1560. ************************************************************************/
  1561. class ITcpClientListener : public IClientListenerT<ITcpClient>
  1562. {
  1563. public:
  1564. };
  1565. /************************************************************************
  1566. 名称:PUSH 模型客户端 Socket 监听器抽象基类
  1567. 描述:定义某些事件的默认处理方法(忽略事件)
  1568. ************************************************************************/
  1569. class CTcpClientListener : public ITcpClientListener
  1570. {
  1571. public:
  1572. virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1573. virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1574. virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1575. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1576. virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1577. };
  1578. /************************************************************************
  1579. 名称:PULL 客户端 Socket 监听器抽象基类
  1580. 描述:定义某些事件的默认处理方法(忽略事件)
  1581. ************************************************************************/
  1582. class CTcpPullClientListener : public CTcpClientListener
  1583. {
  1584. public:
  1585. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) = 0;
  1586. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1587. };
  1588. #ifdef _UDP_SUPPORT
  1589. /************************************************************************
  1590. 名称:UDP 客户端 Socket 监听器接口
  1591. 描述:定义 UDP 客户端 Socket 监听器的所有事件
  1592. ************************************************************************/
  1593. class IUdpClientListener : public IClientListenerT<IUdpClient>
  1594. {
  1595. public:
  1596. };
  1597. /************************************************************************
  1598. 名称:UDP 户端 Socket 监听器抽象基类
  1599. 描述:定义某些事件的默认处理方法(忽略事件)
  1600. ************************************************************************/
  1601. class CUdpClientListener : public IUdpClientListener
  1602. {
  1603. public:
  1604. virtual EnHandleResult OnPrepareConnect(IUdpClient* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1605. virtual EnHandleResult OnConnect(IUdpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1606. virtual EnHandleResult OnHandShake(IUdpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1607. virtual EnHandleResult OnReceive(IUdpClient* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1608. virtual EnHandleResult OnSend(IUdpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1609. };
  1610. /************************************************************************
  1611. 名称:UDP 传播 Socket 监听器接口
  1612. 描述:定义 UDP 传播 Socket 监听器的所有事件
  1613. ************************************************************************/
  1614. class IUdpCastListener : public IClientListenerT<IUdpCast>
  1615. {
  1616. public:
  1617. };
  1618. /************************************************************************
  1619. 名称:UDP 传播 Socket 监听器抽象基类
  1620. 描述:定义某些事件的默认处理方法(忽略事件)
  1621. ************************************************************************/
  1622. class CUdpCastListener : public IUdpCastListener
  1623. {
  1624. public:
  1625. virtual EnHandleResult OnPrepareConnect(IUdpCast* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1626. virtual EnHandleResult OnConnect(IUdpCast* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1627. virtual EnHandleResult OnHandShake(IUdpCast* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1628. virtual EnHandleResult OnReceive(IUdpCast* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1629. virtual EnHandleResult OnSend(IUdpCast* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1630. };
  1631. /************************************************************************
  1632. 名称:UDP 节点 Socket 监听器接口
  1633. 描述:定义 UDP 节点 Socket 监听器的所有事件
  1634. ************************************************************************/
  1635. class IUdpNodeListener
  1636. {
  1637. public:
  1638. /*
  1639. * 名称:准备监听通知
  1640. * 描述:通信组件启动时,在监听 Socket 创建完成并开始执行监听前,Socket 监听器
  1641. * 将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1642. *
  1643. * 参数: pSender -- 事件源对象
  1644. * soListen -- 监听 Socket
  1645. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1646. * HR_ERROR -- 终止启动通信服务组件
  1647. */
  1648. virtual EnHandleResult OnPrepareListen(IUdpNode* pSender, SOCKET soListen) = 0;
  1649. /*
  1650. * 名称:已发送数据通知
  1651. * 描述:成功发送数据后,Socket 监听器将收到该通知
  1652. *
  1653. * 参数: pSender -- 事件源对象
  1654. * lpszRemoteAddress -- 远程地址
  1655. * usRemotePort -- 远程端口
  1656. * pData -- 已发送数据缓冲区
  1657. * iLength -- 已发送数据长度
  1658. * 返回值: 忽略返回值
  1659. */
  1660. virtual EnHandleResult OnSend(IUdpNode* pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) = 0;
  1661. /*
  1662. * 名称:数据到达通知(PUSH 模型)
  1663. * 描述:成功接收数据后,Socket 监听器将收到该通知
  1664. *
  1665. * 参数: pSender -- 事件源对象
  1666. * lpszRemoteAddress -- 远程地址
  1667. * usRemotePort -- 远程端口
  1668. * pData -- 已发送数据缓冲区
  1669. * iLength -- 已发送数据长度
  1670. * 返回值: 忽略返回值
  1671. */
  1672. virtual EnHandleResult OnReceive(IUdpNode* pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) = 0;
  1673. /*
  1674. * 名称:通信错误通知
  1675. * 描述:通信发生错误后,Socket 监听器将收到该通知
  1676. *
  1677. * 参数: pSender -- 事件源对象
  1678. * lpszRemoteAddress -- 远程地址
  1679. * usRemotePort -- 远程端口
  1680. * enOperation -- Socket 操作类型
  1681. * iErrorCode -- 错误代码
  1682. * pData -- 本次事件关联的数据缓冲区
  1683. * iLength -- 本次事件关联的数据长度
  1684. * 返回值: 忽略返回值
  1685. */
  1686. virtual EnHandleResult OnError(IUdpNode* pSender, EnSocketOperation enOperation, int iErrorCode, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) = 0;
  1687. /*
  1688. * 名称:关闭通信组件通知
  1689. * 描述:通信组件关闭时,Socket 监听器将收到该通知
  1690. *
  1691. * 参数: pSender -- 事件源对象
  1692. * 返回值: 忽略返回值
  1693. */
  1694. virtual EnHandleResult OnShutdown(IUdpNode* pSender) = 0;
  1695. public:
  1696. virtual ~IUdpNodeListener() = default;
  1697. };
  1698. /************************************************************************
  1699. 名称:UDP 节点 Socket 监听器抽象基类
  1700. 描述:定义某些事件的默认处理方法(忽略事件)
  1701. ************************************************************************/
  1702. class CUdpNodeListener : public IUdpNodeListener
  1703. {
  1704. public:
  1705. virtual EnHandleResult OnPrepareListen(IUdpNode* pSender, SOCKET soListen) override {return HR_IGNORE;}
  1706. virtual EnHandleResult OnSend(IUdpNode* pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1707. virtual EnHandleResult OnShutdown(IUdpNode* pSender) override {return HR_IGNORE;}
  1708. };
  1709. #endif
  1710. /*****************************************************************************************************************************************************/
  1711. /****************************************************************** HTTP Interfaces ******************************************************************/
  1712. /*****************************************************************************************************************************************************/
  1713. #ifdef _HTTP_SUPPORT
  1714. /************************************************************************
  1715. 名称:复合 Http 组件接口
  1716. 描述:定义复合 Http 组件的所有操作方法和属性访问方法,复合 Http 组件同时管理多个 Http 连接
  1717. ************************************************************************/
  1718. class IComplexHttp
  1719. {
  1720. public:
  1721. /***********************************************************************/
  1722. /***************************** 组件操作方法 *****************************/
  1723. /*
  1724. * 名称:启动 HTTP 通信
  1725. * 描述:当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信
  1726. *
  1727. * 返回值: TRUE -- 成功
  1728. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  1729. */
  1730. virtual BOOL StartHttp(CONNID dwConnID) = 0;
  1731. /*
  1732. * 名称:发送 Chunked 数据分片
  1733. * 描述:向对端发送 Chunked 数据分片
  1734. *
  1735. * 参数: dwConnID -- 连接 ID
  1736. * pData -- Chunked 数据分片
  1737. * iLength -- 数据分片长度(为 0 表示结束分片)
  1738. * lpszExtensions -- 扩展属性(默认:nullptr)
  1739. * 返回值: TRUE -- 成功
  1740. * FALSE -- 失败
  1741. */
  1742. virtual BOOL SendChunkData(CONNID dwConnID, const BYTE* pData = nullptr, int iLength = 0, LPCSTR lpszExtensions = nullptr) = 0;
  1743. public:
  1744. /***********************************************************************/
  1745. /***************************** 属性访问方法 *****************************/
  1746. /* 设置本地协议版本 */
  1747. virtual void SetLocalVersion(EnHttpVersion usVersion) = 0;
  1748. /* 获取本地协议版本 */
  1749. virtual EnHttpVersion GetLocalVersion() = 0;
  1750. /* 检查是否升级协议 */
  1751. virtual BOOL IsUpgrade(CONNID dwConnID) = 0;
  1752. /* 检查是否有 Keep-Alive 标识 */
  1753. virtual BOOL IsKeepAlive(CONNID dwConnID) = 0;
  1754. /* 获取协议版本 */
  1755. virtual USHORT GetVersion(CONNID dwConnID) = 0;
  1756. /* 获取内容长度 */
  1757. virtual ULONGLONG GetContentLength(CONNID dwConnID) = 0;
  1758. /* 获取内容类型 */
  1759. virtual LPCSTR GetContentType(CONNID dwConnID) = 0;
  1760. /* 获取内容编码 */
  1761. virtual LPCSTR GetContentEncoding(CONNID dwConnID) = 0;
  1762. /* 获取传输编码 */
  1763. virtual LPCSTR GetTransferEncoding(CONNID dwConnID) = 0;
  1764. /* 获取协议升级类型 */
  1765. virtual EnHttpUpgradeType GetUpgradeType(CONNID dwConnID) = 0;
  1766. /* 获取解析错误代码 */
  1767. virtual USHORT GetParseErrorCode(CONNID dwConnID, LPCSTR* lpszErrorDesc = nullptr) = 0;
  1768. /* 获取某个请求头(单值) */
  1769. virtual BOOL GetHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1770. /* 获取某个请求头(多值) */
  1771. virtual BOOL GetHeaders(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1772. /* 获取所有请求头 */
  1773. virtual BOOL GetAllHeaders(CONNID dwConnID, THeader lpHeaders[], DWORD& dwCount) = 0;
  1774. /* 获取所有请求头名称 */
  1775. virtual BOOL GetAllHeaderNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0;
  1776. /* 获取 Cookie */
  1777. virtual BOOL GetCookie(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1778. /* 获取所有 Cookie */
  1779. virtual BOOL GetAllCookies(CONNID dwConnID, TCookie lpCookies[], DWORD& dwCount) = 0;
  1780. /*
  1781. // !! maybe implemented in future !! //
  1782. virtual BOOL GetParam(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1783. virtual BOOL GetParams(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1784. virtual BOOL GetAllParams(CONNID dwConnID, LPPARAM lpszParam[], DWORD& dwCount) = 0;
  1785. virtual BOOL GetAllParamNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0;
  1786. */
  1787. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  1788. virtual BOOL GetWSMessageState(CONNID dwConnID, BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain) = 0;
  1789. /* 设置 HTTP 启动方式(默认:TRUE,自动启动) */
  1790. virtual void SetHttpAutoStart(BOOL bAutoStart) = 0;
  1791. /* 获取 HTTP 启动方式 */
  1792. virtual BOOL IsHttpAutoStart() = 0;
  1793. public:
  1794. virtual ~IComplexHttp() = default;
  1795. };
  1796. /************************************************************************
  1797. 名称:复合 Http 请求者组件接口
  1798. 描述:定义复合 Http 请求者组件的所有操作方法和属性访问方法
  1799. ************************************************************************/
  1800. class IComplexHttpRequester : public IComplexHttp
  1801. {
  1802. public:
  1803. /***********************************************************************/
  1804. /***************************** 组件操作方法 *****************************/
  1805. /*
  1806. * 名称:发送 WebSocket 消息
  1807. * 描述:向对端端发送 WebSocket 消息
  1808. *
  1809. * 参数: dwConnID -- 连接 ID
  1810. * bFinal -- 是否结束帧
  1811. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1812. * iOperationCode -- 操作码:0x0 - 0xF
  1813. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  1814. * pData -- 消息体数据缓冲区
  1815. * iLength -- 消息体数据长度
  1816. * ullBodyLen -- 消息总长度
  1817. * ullBodyLen = 0 -> 消息总长度为 iLength
  1818. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1819. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1820. * ullBodyLen < iLength -> 错误参数,发送失败
  1821. * 返回值: TRUE -- 成功
  1822. * FALSE -- 失败
  1823. */
  1824. virtual BOOL SendWSMessage(CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], const BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0) = 0;
  1825. /*
  1826. * 名称:发送请求
  1827. * 描述:向服务端发送 HTTP 请求
  1828. *
  1829. * 参数: dwConnID -- 连接 ID
  1830. * lpszMethod -- 请求方法
  1831. * lpszPath -- 请求路径
  1832. * lpHeaders -- 请求头
  1833. * iHeaderCount -- 请求头数量
  1834. * pBody -- 请求体
  1835. * iLength -- 请求体长度
  1836. * 返回值: TRUE -- 成功
  1837. * FALSE -- 失败
  1838. */
  1839. virtual BOOL SendRequest(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0;
  1840. /*
  1841. * 名称:发送本地文件
  1842. * 描述:向指定连接发送 4096 KB 以下的小文件
  1843. *
  1844. * 参数: dwConnID -- 连接 ID
  1845. * lpszFileName -- 文件路径
  1846. * lpszMethod -- 请求方法
  1847. * lpszPath -- 请求路径
  1848. * lpHeaders -- 请求头
  1849. * iHeaderCount -- 请求头数量
  1850. * 返回值: TRUE -- 成功
  1851. * FALSE -- 失败
  1852. */
  1853. virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1854. /* 发送 POST 请求 */
  1855. virtual BOOL SendPost(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1856. /* 发送 PUT 请求 */
  1857. virtual BOOL SendPut(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1858. /* 发送 PATCH 请求 */
  1859. virtual BOOL SendPatch(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1860. /* 发送 GET 请求 */
  1861. virtual BOOL SendGet(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1862. /* 发送 DELETE 请求 */
  1863. virtual BOOL SendDelete(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1864. /* 发送 HEAD 请求 */
  1865. virtual BOOL SendHead(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1866. /* 发送 TRACE 请求 */
  1867. virtual BOOL SendTrace(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1868. /* 发送 OPTIONS 请求 */
  1869. virtual BOOL SendOptions(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1870. /* 发送 CONNECT 请求 */
  1871. virtual BOOL SendConnect(CONNID dwConnID, LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1872. public:
  1873. /***********************************************************************/
  1874. /***************************** 属性访问方法 *****************************/
  1875. /* 获取 HTTP 状态码 */
  1876. virtual USHORT GetStatusCode(CONNID dwConnID) = 0;
  1877. /* 设置是否使用 Cookie(默认:TRUE) */
  1878. virtual void SetUseCookie(BOOL bUseCookie) = 0;
  1879. /* 检查是否使用 Cookie */
  1880. virtual BOOL IsUseCookie() = 0;
  1881. };
  1882. /************************************************************************
  1883. 名称:复合 Http 响应者组件接口
  1884. 描述:定义复合 Http 响应者组件的所有操作方法和属性访问方法
  1885. ************************************************************************/
  1886. class IComplexHttpResponder : public IComplexHttp
  1887. {
  1888. public:
  1889. /***********************************************************************/
  1890. /***************************** 组件操作方法 *****************************/
  1891. /*
  1892. * 名称:发送 WebSocket 消息
  1893. * 描述:向对端端发送 WebSocket 消息
  1894. *
  1895. * 参数: dwConnID -- 连接 ID
  1896. * bFinal -- 是否结束帧
  1897. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1898. * iOperationCode -- 操作码:0x0 - 0xF
  1899. * pData -- 消息体数据缓冲区
  1900. * iLength -- 消息体数据长度
  1901. * ullBodyLen -- 消息总长度
  1902. * ullBodyLen = 0 -> 消息总长度为 iLength
  1903. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1904. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1905. * ullBodyLen < iLength -> 错误参数,发送失败
  1906. * 返回值: TRUE -- 成功
  1907. * FALSE -- 失败
  1908. */
  1909. virtual BOOL SendWSMessage(CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0) = 0;
  1910. /*
  1911. * 名称:回复请求
  1912. * 描述:向客户端回复 HTTP 请求
  1913. *
  1914. * 参数: dwConnID -- 连接 ID
  1915. * usStatusCode -- HTTP 状态码
  1916. * lpszDesc -- HTTP 状态描述
  1917. * lpHeaders -- 回复请求头
  1918. * iHeaderCount -- 回复请求头数量
  1919. * pData -- 回复请求体
  1920. * iLength -- 回复请求体长度
  1921. * 返回值: TRUE -- 成功
  1922. * FALSE -- 失败
  1923. */
  1924. 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;
  1925. /*
  1926. * 名称:发送本地文件
  1927. * 描述:向指定连接发送 4096 KB 以下的小文件
  1928. *
  1929. * 参数: dwConnID -- 连接 ID
  1930. * lpszFileName -- 文件路径
  1931. * usStatusCode -- HTTP 状态码
  1932. * lpszDesc -- HTTP 状态描述
  1933. * lpHeaders -- 回复请求头
  1934. * iHeaderCount -- 回复请求头数量
  1935. * 返回值: TRUE -- 成功
  1936. * FALSE -- 失败
  1937. */
  1938. virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, USHORT usStatusCode = HSC_OK, LPCSTR lpszDesc = nullptr, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1939. /*
  1940. * 名称:释放连接
  1941. * 描述:把连接放入释放队列,等待某个时间(通过 SetReleaseDelay() 设置)关闭连接
  1942. *
  1943. * 参数: dwConnID -- 连接 ID
  1944. * 返回值: TRUE -- 成功
  1945. * FALSE -- 失败
  1946. */
  1947. virtual BOOL Release(CONNID dwConnID) = 0;
  1948. public:
  1949. /***********************************************************************/
  1950. /***************************** 属性访问方法 *****************************/
  1951. /* 获取主机 */
  1952. virtual LPCSTR GetHost(CONNID dwConnID) = 0;
  1953. /* 设置连接释放延时(默认:3000 毫秒) */
  1954. virtual void SetReleaseDelay(DWORD dwReleaseDelay) = 0;
  1955. /* 获取连接释放延时 */
  1956. virtual DWORD GetReleaseDelay() = 0;
  1957. /* 获取请求行 URL 域掩码(URL 域参考:EnHttpUrlField) */
  1958. virtual USHORT GetUrlFieldSet(CONNID dwConnID) = 0;
  1959. /* 获取某个 URL 域值 */
  1960. virtual LPCSTR GetUrlField(CONNID dwConnID, EnHttpUrlField enField) = 0;
  1961. /* 获取请求方法 */
  1962. virtual LPCSTR GetMethod(CONNID dwConnID) = 0;
  1963. };
  1964. /************************************************************************
  1965. 名称:简单 HTTP 组件接口
  1966. 描述:定义 简单 HTTP 组件的所有操作方法和属性访问方法
  1967. ************************************************************************/
  1968. class IHttp
  1969. {
  1970. public:
  1971. /***********************************************************************/
  1972. /***************************** 组件操作方法 *****************************/
  1973. /*
  1974. * 名称:发送 WebSocket 消息
  1975. * 描述:向对端端发送 WebSocket 消息
  1976. *
  1977. * 参数: bFinal -- 是否结束帧
  1978. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1979. * iOperationCode -- 操作码:0x0 - 0xF
  1980. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  1981. * pData -- 消息体数据缓冲区
  1982. * iLength -- 消息体数据长度
  1983. * ullBodyLen -- 消息总长度
  1984. * ullBodyLen = 0 -> 消息总长度为 iLength
  1985. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1986. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1987. * ullBodyLen < iLength -> 错误参数,发送失败
  1988. * 返回值: TRUE -- 成功
  1989. * FALSE -- 失败
  1990. */
  1991. virtual BOOL SendWSMessage(BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], const BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0) = 0;
  1992. /*
  1993. * 名称:启动 HTTP 通信
  1994. * 描述:当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信
  1995. *
  1996. * 返回值: TRUE -- 成功
  1997. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  1998. */
  1999. virtual BOOL StartHttp() = 0;
  2000. /*
  2001. * 名称:发送 Chunked 数据分片
  2002. * 描述:向对端发送 Chunked 数据分片
  2003. *
  2004. * 参数: pData -- Chunked 数据分片
  2005. * iLength -- 数据分片长度(为 0 表示结束分片)
  2006. * lpszExtensions -- 扩展属性(默认:nullptr)
  2007. * 返回值: TRUE -- 成功
  2008. * FALSE -- 失败
  2009. */
  2010. virtual BOOL SendChunkData(const BYTE* pData = nullptr, int iLength = 0, LPCSTR lpszExtensions = nullptr) = 0;
  2011. public:
  2012. /***********************************************************************/
  2013. /***************************** 属性访问方法 *****************************/
  2014. /* 设置本地协议版本 */
  2015. virtual void SetLocalVersion(EnHttpVersion usVersion) = 0;
  2016. /* 获取本地协议版本 */
  2017. virtual EnHttpVersion GetLocalVersion() = 0;
  2018. /* 检查是否升级协议 */
  2019. virtual BOOL IsUpgrade() = 0;
  2020. /* 检查是否有 Keep-Alive 标识 */
  2021. virtual BOOL IsKeepAlive() = 0;
  2022. /* 获取协议版本 */
  2023. virtual USHORT GetVersion() = 0;
  2024. /* 获取内容长度 */
  2025. virtual ULONGLONG GetContentLength() = 0;
  2026. /* 获取内容类型 */
  2027. virtual LPCSTR GetContentType() = 0;
  2028. /* 获取内容编码 */
  2029. virtual LPCSTR GetContentEncoding() = 0;
  2030. /* 获取传输编码 */
  2031. virtual LPCSTR GetTransferEncoding() = 0;
  2032. /* 获取协议升级类型 */
  2033. virtual EnHttpUpgradeType GetUpgradeType() = 0;
  2034. /* 获取解析错误代码 */
  2035. virtual USHORT GetParseErrorCode(LPCSTR* lpszErrorDesc = nullptr) = 0;
  2036. /* 获取 HTTP 状态码 */
  2037. virtual USHORT GetStatusCode() = 0;
  2038. /* 获取某个请求头(单值) */
  2039. virtual BOOL GetHeader(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  2040. /* 获取某个请求头(多值) */
  2041. virtual BOOL GetHeaders(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  2042. /* 获取所有请求头 */
  2043. virtual BOOL GetAllHeaders(THeader lpHeaders[], DWORD& dwCount) = 0;
  2044. /* 获取所有请求头名称 */
  2045. virtual BOOL GetAllHeaderNames(LPCSTR lpszName[], DWORD& dwCount) = 0;
  2046. /* 获取 Cookie */
  2047. virtual BOOL GetCookie(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  2048. /* 获取所有 Cookie */
  2049. virtual BOOL GetAllCookies(TCookie lpCookies[], DWORD& dwCount) = 0;
  2050. /*
  2051. // !! maybe implemented in future !! //
  2052. virtual BOOL GetParam(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  2053. virtual BOOL GetParams(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  2054. virtual BOOL GetAllParams(LPPARAM lpszParam[], DWORD& dwCount) = 0;
  2055. virtual BOOL GetAllParamNames(LPCSTR lpszName[], DWORD& dwCount) = 0;
  2056. */
  2057. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  2058. virtual BOOL GetWSMessageState(BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain) = 0;
  2059. /* 设置 HTTP 启动方式(默认:TRUE,自动启动) */
  2060. virtual void SetHttpAutoStart(BOOL bAutoStart) = 0;
  2061. /* 获取 HTTP 启动方式 */
  2062. virtual BOOL IsHttpAutoStart() = 0;
  2063. public:
  2064. virtual ~IHttp() = default;
  2065. };
  2066. /************************************************************************
  2067. 名称:简单 Http 请求者组件接口
  2068. 描述:定义简单 Http 请求者组件的所有操作方法和属性访问方法
  2069. ************************************************************************/
  2070. class IHttpRequester : public IHttp
  2071. {
  2072. public:
  2073. /***********************************************************************/
  2074. /***************************** 组件操作方法 *****************************/
  2075. /*
  2076. * 名称:发送请求
  2077. * 描述:向服务端发送 HTTP 请求
  2078. *
  2079. * 参数: lpszMethod -- 请求方法
  2080. * lpszPath -- 请求路径
  2081. * lpHeaders -- 请求头
  2082. * iHeaderCount -- 请求头数量
  2083. * pBody -- 请求体
  2084. * iLength -- 请求体长度
  2085. * 返回值: TRUE -- 成功
  2086. * FALSE -- 失败
  2087. */
  2088. virtual BOOL SendRequest(LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0;
  2089. /*
  2090. * 名称:发送本地文件
  2091. * 描述:向指定连接发送 4096 KB 以下的小文件
  2092. *
  2093. * 参数: dwConnID -- 连接 ID
  2094. * lpszFileName -- 文件路径
  2095. * lpszMethod -- 请求方法
  2096. * lpszPath -- 请求路径
  2097. * lpHeaders -- 请求头
  2098. * iHeaderCount -- 请求头数量
  2099. * 返回值: TRUE -- 成功
  2100. * FALSE -- 失败
  2101. */
  2102. virtual BOOL SendLocalFile(LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2103. /* 发送 POST 请求 */
  2104. virtual BOOL SendPost(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  2105. /* 发送 PUT 请求 */
  2106. virtual BOOL SendPut(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  2107. /* 发送 PATCH 请求 */
  2108. virtual BOOL SendPatch(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  2109. /* 发送 GET 请求 */
  2110. virtual BOOL SendGet(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2111. /* 发送 DELETE 请求 */
  2112. virtual BOOL SendDelete(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2113. /* 发送 HEAD 请求 */
  2114. virtual BOOL SendHead(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2115. /* 发送 TRACE 请求 */
  2116. virtual BOOL SendTrace(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2117. /* 发送 OPTIONS 请求 */
  2118. virtual BOOL SendOptions(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2119. /* 发送 CONNECT 请求 */
  2120. virtual BOOL SendConnect(LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2121. public:
  2122. /***********************************************************************/
  2123. /***************************** 属性访问方法 *****************************/
  2124. /* 设置是否使用 Cookie(默认:TRUE) */
  2125. virtual void SetUseCookie(BOOL bUseCookie) = 0;
  2126. /* 检查是否使用 Cookie */
  2127. virtual BOOL IsUseCookie() = 0;
  2128. };
  2129. /************************************************************************
  2130. 名称:简单 Http 同步请求者组件接口
  2131. 描述:定义简单 Http 同步请求者组件的所有操作方法和属性访问方法
  2132. ************************************************************************/
  2133. class IHttpSyncRequester : public IHttpRequester
  2134. {
  2135. public:
  2136. /*
  2137. * 名称:发送 URL 请求
  2138. * 描述:向服务端发送 HTTP URL 请求
  2139. *
  2140. * 参数: lpszMethod -- 请求方法
  2141. * lpszUrl -- 请求 URL
  2142. * lpHeaders -- 请求头
  2143. * iHeaderCount -- 请求头数量
  2144. * pBody -- 请求体
  2145. * iLength -- 请求体长度
  2146. * bForceReconnect -- 强制重新连接(默认:FALSE,当请求 URL 的主机和端口与现有连接一致时,重用现有连接)
  2147. * 返回值: TRUE -- 成功
  2148. * FALSE -- 失败
  2149. */
  2150. 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;
  2151. /***********************************************************************/
  2152. /***************************** 组件操作方法 *****************************/
  2153. /*
  2154. * 名称:清除请求结果
  2155. * 描述:清除上一次请求的响应头和响应体等结果信息(该方法会在每次发送请求前自动调用)
  2156. *
  2157. * 参数:
  2158. * 返回值: TRUE -- 成功
  2159. * FALSE -- 失败
  2160. */
  2161. virtual BOOL CleanupRequestResult () = 0;
  2162. public:
  2163. /***********************************************************************/
  2164. /***************************** 属性访问方法 *****************************/
  2165. /* 设置连接超时(毫秒,0:系统默认超时,默认:5000) */
  2166. virtual void SetConnectTimeout (DWORD dwConnectTimeout) = 0;
  2167. /* 设置请求超时(毫秒,0:无限等待,默认:10000) */
  2168. virtual void SetRequestTimeout (DWORD dwRequestTimeout) = 0;
  2169. /* 获取连接超时 */
  2170. virtual DWORD GetConnectTimeout () = 0;
  2171. /* 获取请求超时 */
  2172. virtual DWORD GetRequestTimeout () = 0;
  2173. /* 获取响应体 */
  2174. virtual BOOL GetResponseBody (LPCBYTE* lpszBody, int* iLength) = 0;
  2175. };
  2176. /************************************************************************
  2177. 名称:HTTP 组件接口
  2178. 描述:继承了 HTTP 和 Socket 接口
  2179. ************************************************************************/
  2180. typedef DualInterface<IComplexHttpResponder, ITcpServer> IHttpServer;
  2181. typedef DualInterface<IComplexHttpRequester, ITcpAgent> IHttpAgent;
  2182. typedef DualInterface<IHttpRequester, ITcpClient> IHttpClient;
  2183. typedef DualInterface<IHttpSyncRequester, ITcpClient> IHttpSyncClient;
  2184. /************************************************************************
  2185. 名称:IComplexHttp 组件监听器基接口
  2186. 描述:定义 IComplexHttp 组件监听器的所有事件
  2187. ************************************************************************/
  2188. template<class T> class IHttpListenerT
  2189. {
  2190. public:
  2191. /*
  2192. * 名称:开始解析通知
  2193. * 描述:开始解析 HTTP 报文时,向监听器发送该通知
  2194. *
  2195. * 参数: pSender -- 事件源对象
  2196. * dwConnID -- 连接 ID
  2197. * 返回值: HPR_OK -- 继续执行
  2198. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2199. */
  2200. virtual EnHttpParseResult OnMessageBegin(T* pSender, CONNID dwConnID) = 0;
  2201. /*
  2202. * 名称:请求行解析完成通知(仅用于 HTTP 服务端)
  2203. * 描述:请求行解析完成后,向监听器发送该通知
  2204. *
  2205. * 参数: pSender -- 事件源对象
  2206. * dwConnID -- 连接 ID
  2207. * lpszMethod -- 请求方法名
  2208. * lpszUrl -- 请求行中的 URL 域
  2209. * 返回值: HPR_OK -- 继续执行
  2210. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2211. */
  2212. virtual EnHttpParseResult OnRequestLine(T* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) = 0;
  2213. /*
  2214. * 名称:状态行解析完成通知(仅用于 HTTP 客户端)
  2215. * 描述:状态行解析完成后,向监听器发送该通知
  2216. *
  2217. * 参数: pSender -- 事件源对象
  2218. * dwConnID -- 连接 ID
  2219. * usStatusCode -- HTTP 状态码
  2220. * lpszDesc -- 状态描述
  2221. * 返回值: HPR_OK -- 继续执行
  2222. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2223. */
  2224. virtual EnHttpParseResult OnStatusLine(T* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) = 0;
  2225. /*
  2226. * 名称:请求头通知
  2227. * 描述:每当解析完成一个请求头后,向监听器发送该通知
  2228. *
  2229. * 参数: pSender -- 事件源对象
  2230. * dwConnID -- 连接 ID
  2231. * lpszName -- 请求头名称
  2232. * lpszValue -- 请求头值
  2233. * 返回值: HPR_OK -- 继续执行
  2234. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2235. */
  2236. virtual EnHttpParseResult OnHeader(T* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) = 0;
  2237. /*
  2238. * 名称:请求头完成通知
  2239. * 描述:解析完成所有请求头后,向监听器发送该通知
  2240. *
  2241. * 参数: pSender -- 事件源对象
  2242. * dwConnID -- 连接 ID
  2243. * 返回值: HPR_OK -- 继续执行
  2244. * HPR_SKIP_BODY -- 跳过当前请求的 HTTP BODY
  2245. * HPR_UPGRADE -- 升级协议
  2246. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2247. */
  2248. virtual EnHttpParseResult OnHeadersComplete(T* pSender, CONNID dwConnID) = 0;
  2249. /*
  2250. * 名称:BODY 报文通知
  2251. * 描述:每当接收到 HTTP BODY 报文,向监听器发送该通知
  2252. *
  2253. * 参数: pSender -- 事件源对象
  2254. * dwConnID -- 连接 ID
  2255. * pData -- 数据缓冲区
  2256. * iLength -- 数据长度
  2257. * 返回值: HPR_OK -- 继续执行
  2258. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2259. */
  2260. virtual EnHttpParseResult OnBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  2261. /*
  2262. * 名称:Chunked 报文头通知
  2263. * 描述:每当解析出一个 Chunked 报文头,向监听器发送该通知
  2264. *
  2265. * 参数: pSender -- 事件源对象
  2266. * dwConnID -- 连接 ID
  2267. * iLength -- Chunked 报文体数据长度
  2268. * 返回值: HPR_OK -- 继续执行
  2269. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2270. */
  2271. virtual EnHttpParseResult OnChunkHeader(T* pSender, CONNID dwConnID, int iLength) = 0;
  2272. /*
  2273. * 名称:Chunked 报文结束通知
  2274. * 描述:每当解析完一个 Chunked 报文,向监听器发送该通知
  2275. *
  2276. * 参数: pSender -- 事件源对象
  2277. * dwConnID -- 连接 ID
  2278. * 返回值: HPR_OK -- 继续执行
  2279. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2280. */
  2281. virtual EnHttpParseResult OnChunkComplete(T* pSender, CONNID dwConnID) = 0;
  2282. /*
  2283. * 名称:完成解析通知
  2284. * 描述:每当解析完成一个完整 HTTP 报文,向监听器发送该通知
  2285. *
  2286. * 参数: pSender -- 事件源对象
  2287. * dwConnID -- 连接 ID
  2288. * 返回值: HPR_OK -- 继续执行
  2289. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2290. */
  2291. virtual EnHttpParseResult OnMessageComplete(T* pSender, CONNID dwConnID) = 0;
  2292. /*
  2293. * 名称:升级协议通知
  2294. * 描述:当需要升级协议时,向监听器发送该通知
  2295. *
  2296. * 参数: pSender -- 事件源对象
  2297. * dwConnID -- 连接 ID
  2298. * enUpgradeType -- 协议类型
  2299. * 返回值: HPR_OK -- 继续执行
  2300. * HPR_ERROR -- 引发 OnClose() 事件并关闭连接
  2301. */
  2302. virtual EnHttpParseResult OnUpgrade(T* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) = 0;
  2303. /*
  2304. * 名称:解析错误通知
  2305. * 描述:当解析 HTTP 报文错误时,向监听器发送该通知
  2306. *
  2307. * 参数: pSender -- 事件源对象
  2308. * dwConnID -- 连接 ID
  2309. * iErrorCode -- 错误代码
  2310. * lpszErrorDesc -- 错误描述
  2311. * 返回值: HPR_OK -- 继续执行
  2312. * HPR_ERROR -- 引发 OnClose() 事件并关闭连接
  2313. */
  2314. virtual EnHttpParseResult OnParseError(T* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc) = 0;
  2315. /*
  2316. * 名称:WebSocket 数据包头通知
  2317. * 描述:当解析 WebSocket 数据包头时,向监听器发送该通知
  2318. *
  2319. * 参数: pSender -- 事件源对象
  2320. * dwConnID -- 连接 ID
  2321. * bFinal -- 是否结束帧
  2322. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  2323. * iOperationCode -- 操作码:0x0 - 0xF
  2324. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  2325. * ullBodyLen -- 消息体长度
  2326. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  2327. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  2328. */
  2329. virtual EnHandleResult OnWSMessageHeader(T* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) = 0;
  2330. /*
  2331. * 名称:WebSocket 数据包体通知
  2332. * 描述:当接收到 WebSocket 数据包体时,向监听器发送该通知
  2333. *
  2334. * 参数: pSender -- 事件源对象
  2335. * dwConnID -- 连接 ID
  2336. * pData -- 消息体数据缓冲区
  2337. * iLength -- 消息体数据长度
  2338. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  2339. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  2340. */
  2341. virtual EnHandleResult OnWSMessageBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  2342. /*
  2343. * 名称:WebSocket 数据包完成通知
  2344. * 描述:当完整接收一个 WebSocket 数据包时,向监听器发送该通知
  2345. *
  2346. * 参数: pSender -- 事件源对象
  2347. * dwConnID -- 连接 ID
  2348. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  2349. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  2350. */
  2351. virtual EnHandleResult OnWSMessageComplete(T* pSender, CONNID dwConnID) = 0;
  2352. public:
  2353. virtual ~IHttpListenerT() = default;
  2354. };
  2355. /************************************************************************
  2356. 名称:IHttpServer 组件端监听器接口
  2357. 描述:定义 IHttpServer 监听器的所有事件
  2358. ************************************************************************/
  2359. class IHttpServerListener : public IHttpListenerT<IHttpServer>, public ITcpServerListener
  2360. {
  2361. public:
  2362. };
  2363. /************************************************************************
  2364. 名称:IHttpAgent 组件端监听器接口
  2365. 描述:定义 IHttpAgent 监听器的所有事件
  2366. ************************************************************************/
  2367. class IHttpAgentListener : public IHttpListenerT<IHttpAgent>, public ITcpAgentListener
  2368. {
  2369. public:
  2370. };
  2371. /************************************************************************
  2372. 名称:IHttpClient 组件端监听器接口
  2373. 描述:定义 IHttpClient 监听器的所有事件
  2374. ************************************************************************/
  2375. class IHttpClientListener : public IHttpListenerT<IHttpClient>, public ITcpClientListener
  2376. {
  2377. public:
  2378. };
  2379. /************************************************************************
  2380. 名称:IHttpServerListener 监听器抽象基类
  2381. 描述:定义某些事件的默认处理方法(忽略事件)
  2382. ************************************************************************/
  2383. class CHttpServerListener : public IHttpServerListener
  2384. {
  2385. public:
  2386. virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen) override {return HR_IGNORE;}
  2387. virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient) override {return HR_IGNORE;}
  2388. virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2389. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  2390. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2391. virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2392. virtual EnHandleResult OnShutdown(ITcpServer* pSender) override {return HR_IGNORE;}
  2393. virtual EnHttpParseResult OnMessageBegin(IHttpServer* pSender, CONNID dwConnID) override {return HPR_OK;}
  2394. virtual EnHttpParseResult OnRequestLine(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) override {return HPR_OK;}
  2395. virtual EnHttpParseResult OnStatusLine(IHttpServer* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) override {return HPR_OK;}
  2396. virtual EnHttpParseResult OnHeader(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) override {return HPR_OK;}
  2397. virtual EnHttpParseResult OnChunkHeader(IHttpServer* pSender, CONNID dwConnID, int iLength) override {return HPR_OK;}
  2398. virtual EnHttpParseResult OnChunkComplete(IHttpServer* pSender, CONNID dwConnID) override {return HPR_OK;}
  2399. virtual EnHttpParseResult OnUpgrade(IHttpServer* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) override {return HPR_OK;}
  2400. virtual EnHandleResult OnWSMessageHeader(IHttpServer* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) override {return HR_IGNORE;}
  2401. virtual EnHandleResult OnWSMessageBody(IHttpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2402. virtual EnHandleResult OnWSMessageComplete(IHttpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2403. };
  2404. /************************************************************************
  2405. 名称:IHttpAgentListener 监听器抽象基类
  2406. 描述:定义某些事件的默认处理方法(忽略事件)
  2407. ************************************************************************/
  2408. class CHttpAgentListener : public IHttpAgentListener
  2409. {
  2410. public:
  2411. virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  2412. virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2413. virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2414. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  2415. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2416. virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2417. virtual EnHandleResult OnShutdown(ITcpAgent* pSender) override {return HR_IGNORE;}
  2418. virtual EnHttpParseResult OnMessageBegin(IHttpAgent* pSender, CONNID dwConnID) override {return HPR_OK;}
  2419. virtual EnHttpParseResult OnRequestLine(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) override {return HPR_OK;}
  2420. virtual EnHttpParseResult OnStatusLine(IHttpAgent* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) override {return HPR_OK;}
  2421. virtual EnHttpParseResult OnHeader(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) override {return HPR_OK;}
  2422. virtual EnHttpParseResult OnChunkHeader(IHttpAgent* pSender, CONNID dwConnID, int iLength) override {return HPR_OK;}
  2423. virtual EnHttpParseResult OnChunkComplete(IHttpAgent* pSender, CONNID dwConnID) override {return HPR_OK;}
  2424. virtual EnHttpParseResult OnUpgrade(IHttpAgent* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) override {return HPR_OK;}
  2425. virtual EnHandleResult OnWSMessageHeader(IHttpAgent* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) override {return HR_IGNORE;}
  2426. virtual EnHandleResult OnWSMessageBody(IHttpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2427. virtual EnHandleResult OnWSMessageComplete(IHttpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2428. };
  2429. /************************************************************************
  2430. 名称:IHttpClientListener 监听器抽象基类
  2431. 描述:定义某些事件的默认处理方法(忽略事件)
  2432. ************************************************************************/
  2433. class CHttpClientListener : public IHttpClientListener
  2434. {
  2435. public:
  2436. virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  2437. virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2438. virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2439. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  2440. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2441. virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2442. virtual EnHttpParseResult OnMessageBegin(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2443. virtual EnHttpParseResult OnRequestLine(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) override {return HPR_OK;}
  2444. virtual EnHttpParseResult OnStatusLine(IHttpClient* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) override {return HPR_OK;}
  2445. virtual EnHttpParseResult OnHeader(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) override {return HPR_OK;}
  2446. virtual EnHttpParseResult OnChunkHeader(IHttpClient* pSender, CONNID dwConnID, int iLength) override {return HPR_OK;}
  2447. virtual EnHttpParseResult OnChunkComplete(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2448. virtual EnHttpParseResult OnUpgrade(IHttpClient* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) override {return HPR_OK;}
  2449. virtual EnHandleResult OnWSMessageHeader(IHttpClient* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) override {return HR_IGNORE;}
  2450. virtual EnHandleResult OnWSMessageBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2451. virtual EnHandleResult OnWSMessageComplete(IHttpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2452. };
  2453. /************************************************************************
  2454. 名称:IHttpClientListener 监听器抽象基类
  2455. 描述:定义某些事件的默认处理方法(忽略事件)
  2456. ************************************************************************/
  2457. class CHttpSyncClientListener : public CHttpClientListener
  2458. {
  2459. public:
  2460. virtual EnHandleResult OnClose(ITcpClient* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode) override {return HR_IGNORE;}
  2461. virtual EnHttpParseResult OnHeadersComplete(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2462. virtual EnHttpParseResult OnBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HPR_OK;}
  2463. virtual EnHttpParseResult OnMessageComplete(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2464. virtual EnHttpParseResult OnParseError(IHttpClient* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc) override {return HPR_OK;}
  2465. };
  2466. #endif
  2467. /*****************************************************************************************************************************************************/
  2468. /************************************************************** Thread Pool Interfaces ***************************************************************/
  2469. /*****************************************************************************************************************************************************/
  2470. /************************************************************************
  2471. 名称:线程池组件接口
  2472. 描述:定义线程池组件的所有操作方法和属性访问方法
  2473. ************************************************************************/
  2474. class IHPThreadPool
  2475. {
  2476. public:
  2477. /***********************************************************************/
  2478. /***************************** 组件操作方法 *****************************/
  2479. /*
  2480. * 名称:启动线程池组件
  2481. * 描述:
  2482. *
  2483. * 参数: dwThreadCount -- 线程数量,(默认:0)
  2484. * >0 -> dwThreadCount
  2485. * =0 -> (CPU核数 * 2 + 2)
  2486. * <0 -> (CPU核数 * (-dwThreadCount))
  2487. * dwMaxQueueSize -- 任务队列最大容量(默认:0,不限制)
  2488. * enRejectedPolicy -- 任务拒绝处理策略
  2489. * TRP_CALL_FAIL(默认) :立刻返回失败
  2490. * TRP_WAIT_FOR :等待(直到成功、超时或线程池关闭等原因导致失败)
  2491. * TRP_CALLER_RUN :调用者线程直接执行
  2492. * dwStackSize -- 线程堆栈空间大小(默认:0 -> 操作系统默认)
  2493. * 返回值: TRUE -- 成功
  2494. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2495. */
  2496. virtual BOOL Start (DWORD dwThreadCount = 0, DWORD dwMaxQueueSize = 0, EnRejectedPolicy enRejectedPolicy = TRP_CALL_FAIL, DWORD dwStackSize = 0) = 0;
  2497. /*
  2498. * 名称:关闭线程池组件
  2499. * 描述:在规定时间内关闭线程池组件,如果工作线程在最大等待时间内未能正常关闭,会尝试强制关闭,这种情况下很可能会造成系统资源泄漏
  2500. *
  2501. * 参数: dwMaxWait -- 最大等待时间(毫秒,默认:INFINITE,一直等待)
  2502. * 返回值: TRUE -- 成功
  2503. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2504. */
  2505. virtual BOOL Stop (DWORD dwMaxWait = INFINITE) = 0;
  2506. /*
  2507. * 名称:提交任务
  2508. * 描述:向线程池提交异步任务
  2509. *
  2510. * 参数: fnTaskProc -- 任务处理函数
  2511. * pvArg -- 任务参数
  2512. * dwMaxWait -- 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
  2513. * 返回值: TRUE -- 成功
  2514. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2515. * 其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
  2516. */
  2517. virtual BOOL Submit (Fn_TaskProc fnTaskProc, PVOID pvArg, DWORD dwMaxWait = INFINITE) = 0;
  2518. /*
  2519. * 名称:提交 Socket 任务
  2520. * 描述:向线程池提交异步 Socket 任务
  2521. *
  2522. * 参数: pTask -- 任务参数
  2523. * dwMaxWait -- 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
  2524. * 返回值: TRUE -- 成功
  2525. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2526. * 其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
  2527. * 注意:如果提交失败,需要手工调用 Destroy_HP_SocketTaskObj() 销毁 TSocketTask 对象
  2528. */
  2529. virtual BOOL Submit (LPTSocketTask pTask, DWORD dwMaxWait = INFINITE) = 0;
  2530. /*
  2531. * 名称:调整线程池大小
  2532. * 描述:增加或减少线程池的工作线程数量
  2533. *
  2534. * 参数: dwNewThreadCount -- 线程数量
  2535. * >0 -> dwNewThreadCount
  2536. * =0 -> (CPU核数 * 2 + 2)
  2537. * <0 -> (CPU核数 * (-dwNewThreadCount))
  2538. * 返回值: TRUE -- 成功
  2539. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2540. */
  2541. virtual BOOL AdjustThreadCount(DWORD dwNewThreadCount) = 0;
  2542. /*
  2543. * 名称:等待
  2544. * 描述:等待线程池组件停止运行
  2545. *
  2546. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  2547. * 返回值: TRUE -- 成功
  2548. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2549. */
  2550. virtual BOOL Wait(DWORD dwMilliseconds = INFINITE) = 0;
  2551. public:
  2552. /***********************************************************************/
  2553. /***************************** 属性访问方法 *****************************/
  2554. /* 检查线程池组件是否已启动 */
  2555. virtual BOOL HasStarted () = 0;
  2556. /* 查看线程池组件当前状态 */
  2557. virtual EnServiceState GetState () = 0;
  2558. /* 获取当前任务等待队列大小 */
  2559. virtual DWORD GetQueueSize () = 0;
  2560. /* 获取当前正在执行的任务数量 */
  2561. virtual DWORD GetTaskCount () = 0;
  2562. /* 获取工作线程数量 */
  2563. virtual DWORD GetThreadCount () = 0;
  2564. /* 获取任务队列最大容量 */
  2565. virtual DWORD GetMaxQueueSize () = 0;
  2566. /* 获取任务拒绝处理策略 */
  2567. virtual EnRejectedPolicy GetRejectedPolicy () = 0;
  2568. public:
  2569. virtual ~IHPThreadPool() = default;
  2570. };
  2571. /************************************************************************
  2572. 名称:线程池监听器接口
  2573. 描述:定义线程池监听器的所有事件
  2574. ************************************************************************/
  2575. class IHPThreadPoolListener
  2576. {
  2577. public:
  2578. /*
  2579. * 名称:线程池启动通知
  2580. * 描述:线程池启动时监听器将收到该通知,监听器可以在通知处理方法中执行预处理工作
  2581. *
  2582. * 参数: pThreadPool -- 线程池对象
  2583. * 返回值: 无
  2584. */
  2585. virtual void OnStartup(IHPThreadPool* pThreadPool) = 0;
  2586. /*
  2587. * 名称:线程池启动关闭通知
  2588. * 描述:线程池关闭时监听器将收到该通知,监听器可以在通知处理方法中执行后处理工作
  2589. *
  2590. * 参数: pThreadPool -- 线程池对象
  2591. * 返回值: 无
  2592. */
  2593. virtual void OnShutdown(IHPThreadPool* pThreadPool) = 0;
  2594. /*
  2595. * 名称:工作线程启动通知
  2596. * 描述:工作线程启动时监听器将收到该通知,监听器可以在通知处理方法中执行线程级别预处理工作
  2597. *
  2598. * 参数: pThreadPool -- 线程池对象
  2599. * dwThreadID -- 工作线程 ID
  2600. * 返回值: 无
  2601. */
  2602. virtual void OnWorkerThreadStart(IHPThreadPool* pThreadPool, THR_ID dwThreadID) = 0;
  2603. /*
  2604. * 名称:工作线程退出通知
  2605. * 描述:工作线程退出时监听器将收到该通知,监听器可以在通知处理方法中执行线程级别后处理工作
  2606. *
  2607. * 参数: pThreadPool -- 线程池对象
  2608. * dwThreadID -- 工作线程 ID
  2609. * 返回值: 无
  2610. */
  2611. virtual void OnWorkerThreadEnd(IHPThreadPool* pThreadPool, THR_ID dwThreadID) = 0;
  2612. public:
  2613. virtual ~IHPThreadPoolListener() {};
  2614. };
  2615. /************************************************************************
  2616. 名称:线程池监听器抽象基类
  2617. 描述:定义某些事件的默认处理方法(忽略事件)
  2618. ************************************************************************/
  2619. class CHPThreadPoolListener : public IHPThreadPoolListener
  2620. {
  2621. public:
  2622. virtual void OnStartup(IHPThreadPool* pThreadPool) override {}
  2623. virtual void OnShutdown(IHPThreadPool* pThreadPool) override {}
  2624. virtual void OnWorkerThreadStart(IHPThreadPool* pThreadPool, THR_ID dwThreadID) override {}
  2625. virtual void OnWorkerThreadEnd(IHPThreadPool* pThreadPool, THR_ID dwThreadID) override {}
  2626. };
  2627. /************************************************************************
  2628. 名称:压缩器接口
  2629. 描述:定义压缩器的所有操作方法和属性访问方法
  2630. ************************************************************************/
  2631. class IHPCompressor
  2632. {
  2633. public:
  2634. /***********************************************************************/
  2635. /***************************** 组件操作方法 *****************************/
  2636. /*
  2637. * 名称:执行压缩
  2638. * 描述:可循环调用以压缩流式或分段数据
  2639. *
  2640. * 参数: pData -- 待压缩数据缓冲区
  2641. * iLength -- 待压缩数据长度
  2642. * bLast -- 是否最后一段待压缩数据
  2643. * pContext -- 压缩回调函数 Fn_CompressDataCallback 的上下文参数
  2644. *
  2645. * 返回值: TRUE -- 成功
  2646. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2647. */
  2648. virtual BOOL Process(const BYTE* pData, int iLength, BOOL bLast, PVOID pContext = nullptr) = 0;
  2649. /*
  2650. * 名称:执行压缩
  2651. * 描述:可循环调用以压缩流式或分段数据
  2652. *
  2653. * 参数: pData -- 待压缩数据缓冲区
  2654. * iLength -- 待压缩数据长度
  2655. * bLast -- 是否最后一段待压缩数据
  2656. * bFlush -- 是否强制刷新(强制刷新会降低压缩效率,但可对数据进行分段压缩)
  2657. * pContext -- 压缩回调函数 Fn_CompressDataCallback 的上下文参数
  2658. *
  2659. * 返回值: TRUE -- 成功
  2660. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2661. */
  2662. virtual BOOL ProcessEx(const BYTE* pData, int iLength, BOOL bLast, BOOL bFlush = FALSE, PVOID pContext = nullptr) = 0;
  2663. /* 重置压缩器 */
  2664. virtual BOOL Reset() = 0;
  2665. /***********************************************************************/
  2666. /***************************** 属性访问方法 *****************************/
  2667. /* 检测压缩器是否可用 */
  2668. virtual BOOL IsValid() = 0;
  2669. public:
  2670. virtual ~IHPCompressor() = default;
  2671. };
  2672. /************************************************************************
  2673. 名称:解压器接口
  2674. 描述:定义解压器的所有操作方法和属性访问方法
  2675. ************************************************************************/
  2676. class IHPDecompressor
  2677. {
  2678. public:
  2679. /***********************************************************************/
  2680. /***************************** 组件操作方法 *****************************/
  2681. /*
  2682. * 名称:执行解压
  2683. * 描述:可循环调用以解压流式或分段数据
  2684. *
  2685. * 参数: pData -- 待解压数据缓冲区
  2686. * iLength -- 待解压数据长度
  2687. * pContext -- 解压回调函数 Fn_DecompressDataCallback 的上下文参数
  2688. *
  2689. * 返回值: TRUE -- 成功
  2690. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2691. */
  2692. virtual BOOL Process(const BYTE* pData, int iLength, PVOID pContext = nullptr) = 0;
  2693. /* 重置解压器 */
  2694. virtual BOOL Reset() = 0;
  2695. public:
  2696. /***********************************************************************/
  2697. /***************************** 属性访问方法 *****************************/
  2698. /* 检测解压器是否可用 */
  2699. virtual BOOL IsValid() = 0;
  2700. public:
  2701. virtual ~IHPDecompressor() = default;
  2702. };