SocketInterface.h 130 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114
  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. /* 设置同步连接超时时间(毫秒) */
  661. virtual void SetSyncConnectTimeout (DWORD dwSyncConnectTimeout) = 0;
  662. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) */
  663. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  664. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  665. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  666. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  667. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  668. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  669. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  670. /* 获取同步连接超时时间 */
  671. virtual DWORD GetSyncConnectTimeout () = 0;
  672. /* 获取通信数据缓冲区大小 */
  673. virtual DWORD GetSocketBufferSize () = 0;
  674. /* 获取正常心跳包间隔 */
  675. virtual DWORD GetKeepAliveTime () = 0;
  676. /* 获取异常心跳包间隔 */
  677. virtual DWORD GetKeepAliveInterval () = 0;
  678. /* 检查是否开启 nodelay 模式 */
  679. virtual BOOL IsNoDelay () = 0;
  680. #ifdef _SSL_SUPPORT
  681. /* 设置通信组件握手方式(默认:TRUE,自动握手) */
  682. virtual void SetSSLAutoHandShake(BOOL bAutoHandShake) = 0;
  683. /* 获取通信组件握手方式 */
  684. virtual BOOL IsSSLAutoHandShake() = 0;
  685. /* 设置 SSL 加密算法列表 */
  686. virtual void SetSSLCipherList(LPCTSTR lpszCipherList) = 0;
  687. /* 获取 SSL 加密算法列表 */
  688. virtual LPCTSTR GetSSLCipherList() = 0;
  689. /*
  690. * 名称:获取 SSL Session 信息
  691. * 描述:获取指定类型的 SSL Session 信息(输出类型参考:EnSSLSessionInfo)
  692. *
  693. * 返回值: TRUE -- 成功
  694. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  695. */
  696. virtual BOOL GetSSLSessionInfo(CONNID dwConnID, EnSSLSessionInfo enInfo, LPVOID* lppInfo) = 0;
  697. #endif
  698. };
  699. /************************************************************************
  700. 名称:通信客户端组件接口
  701. 描述:定义通信客户端组件的所有操作方法和属性访问方法
  702. ************************************************************************/
  703. class IClient
  704. {
  705. public:
  706. /***********************************************************************/
  707. /***************************** 组件操作方法 *****************************/
  708. /*
  709. * 名称:启动通信组件
  710. * 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据
  711. *
  712. * 参数: lpszRemoteAddress -- 服务端地址
  713. * usPort -- 服务端端口
  714. * bAsyncConnect -- 是否采用异步 Connect
  715. * lpszBindAddress -- 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 任意地址)
  716. * usLocalPort -- 本地端口(默认:0)
  717. * 返回值: TRUE -- 成功
  718. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  719. */
  720. virtual BOOL Start (LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect = TRUE, LPCTSTR lpszBindAddress = nullptr, USHORT usLocalPort = 0) = 0;
  721. /*
  722. * 名称:关闭通信组件
  723. * 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源
  724. *
  725. * 参数:
  726. * 返回值: TRUE -- 成功
  727. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  728. */
  729. virtual BOOL Stop () = 0;
  730. /*
  731. * 名称:发送数据
  732. * 描述:向服务端发送数据
  733. *
  734. * 参数: pBuffer -- 发送缓冲区
  735. * iLength -- 发送缓冲区长度
  736. * iOffset -- 发送缓冲区指针偏移量
  737. * 返回值: TRUE -- 成功
  738. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  739. */
  740. virtual BOOL Send (const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  741. /*
  742. * 名称:发送多组数据
  743. * 描述:向服务端发送多组数据
  744. * TCP - 顺序发送所有数据包
  745. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  746. *
  747. * 参数: pBuffers -- 发送缓冲区数组
  748. * iCount -- 发送缓冲区数目
  749. * 返回值: TRUE -- 成功
  750. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  751. */
  752. virtual BOOL SendPackets(const WSABUF pBuffers[], int iCount) = 0;
  753. /*
  754. * 名称:暂停/恢复接收
  755. * 描述:暂停/恢复某个连接的数据接收工作
  756. *
  757. * bPause -- TRUE - 暂停, FALSE - 恢复
  758. * 返回值: TRUE -- 成功
  759. * FALSE -- 失败
  760. */
  761. virtual BOOL PauseReceive(BOOL bPause = TRUE) = 0;
  762. /*
  763. * 名称:等待
  764. * 描述:等待通信组件停止运行
  765. *
  766. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  767. * 返回值: TRUE -- 成功
  768. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  769. */
  770. virtual BOOL Wait(DWORD dwMilliseconds = INFINITE) = 0;
  771. public:
  772. /***********************************************************************/
  773. /***************************** 属性访问方法 *****************************/
  774. /* 设置连接的附加数据 */
  775. virtual void SetExtra (PVOID pExtra) = 0;
  776. /* 获取连接的附加数据 */
  777. virtual PVOID GetExtra () = 0;
  778. /* 检测是否为安全连接(SSL/HTTPS) */
  779. virtual BOOL IsSecure () = 0;
  780. /* 检查通信组件是否已启动 */
  781. virtual BOOL HasStarted () = 0;
  782. /* 查看通信组件当前状态 */
  783. virtual EnServiceState GetState () = 0;
  784. /* 获取最近一次失败操作的错误代码 */
  785. virtual EnSocketError GetLastError () = 0;
  786. /* 获取最近一次失败操作的错误描述 */
  787. virtual LPCTSTR GetLastErrorDesc() = 0;
  788. /* 获取该组件对象的连接 ID */
  789. virtual CONNID GetConnectionID () = 0;
  790. /* 获取 Client Socket 的地址信息 */
  791. virtual BOOL GetLocalAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  792. /* 获取连接的远程主机信息 */
  793. virtual BOOL GetRemoteHost (TCHAR lpszHost[], int& iHostLen, USHORT& usPort) = 0;
  794. /* 获取连接中未发出数据的长度 */
  795. virtual BOOL GetPendingDataLength (int& iPending) = 0;
  796. /* 获取连接的数据接收状态 */
  797. virtual BOOL IsPauseReceive (BOOL& bPaused) = 0;
  798. /* 检测是否有效连接 */
  799. virtual BOOL IsConnected () = 0;
  800. /* 设置地址重用选项 */
  801. virtual void SetReuseAddressPolicy(EnReuseAddressPolicy enReusePolicy) = 0;
  802. /* 设置内存块缓存池大小 */
  803. virtual void SetFreeBufferPoolSize (DWORD dwFreeBufferPoolSize) = 0;
  804. /* 设置内存块缓存池回收阀值 */
  805. virtual void SetFreeBufferPoolHold (DWORD dwFreeBufferPoolHold) = 0;
  806. /* 获取地址重用选项 */
  807. virtual EnReuseAddressPolicy GetReuseAddressPolicy () = 0;
  808. /* 获取内存块缓存池大小 */
  809. virtual DWORD GetFreeBufferPoolSize () = 0;
  810. /* 获取内存块缓存池回收阀值 */
  811. virtual DWORD GetFreeBufferPoolHold () = 0;
  812. public:
  813. virtual ~IClient() = default;
  814. };
  815. /************************************************************************
  816. 名称:TCP 通信客户端组件接口
  817. 描述:定义 TCP 通信客户端组件的所有操作方法和属性访问方法
  818. ************************************************************************/
  819. class ITcpClient : public IClient
  820. {
  821. public:
  822. /***********************************************************************/
  823. /***************************** 组件操作方法 *****************************/
  824. /*
  825. * 名称:发送小文件
  826. * 描述:向服务端发送 4096 KB 以下的小文件
  827. *
  828. * 参数: lpszFileName -- 文件路径
  829. * pHead -- 头部附加数据
  830. * pTail -- 尾部附加数据
  831. * 返回值: TRUE -- 成功
  832. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  833. */
  834. virtual BOOL SendSmallFile(LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0;
  835. #ifdef _SSL_SUPPORT
  836. /*
  837. * 名称:初始化通信组件 SSL 环境参数
  838. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  839. *
  840. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  841. * lpszPemCertFile -- 证书文件(客户端可选)
  842. * lpszPemKeyFile -- 私钥文件(客户端可选)
  843. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  844. * lpszCAPemCertFileOrPath -- CA 证书文件或目录(单向验证或客户端可选)
  845. *
  846. * 返回值: TRUE -- 成功
  847. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  848. */
  849. virtual BOOL SetupSSLContext(int iVerifyMode = SSL_VM_NONE, LPCTSTR lpszPemCertFile = nullptr, LPCTSTR lpszPemKeyFile = nullptr, LPCTSTR lpszKeyPassword = nullptr, LPCTSTR lpszCAPemCertFileOrPath = nullptr) = 0;
  850. /*
  851. * 名称:初始化通信组件 SSL 环境参数(通过内存加载证书)
  852. * 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
  853. *
  854. * 参数: iVerifyMode -- SSL 验证模式(参考 EnSSLVerifyMode)
  855. * lpszPemCert -- 证书内容
  856. * lpszPemKey -- 私钥内容
  857. * lpszKeyPassword -- 私钥密码(没有密码则为空)
  858. * lpszCAPemCert -- CA 证书内容(单向验证或客户端可选)
  859. *
  860. * 返回值: TRUE -- 成功
  861. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  862. */
  863. virtual BOOL SetupSSLContextByMemory(int iVerifyMode = SSL_VM_NONE, LPCSTR lpszPemCert = nullptr, LPCSTR lpszPemKey = nullptr, LPCSTR lpszKeyPassword = nullptr, LPCSTR lpszCAPemCert = nullptr) = 0;
  864. /*
  865. * 名称:清理通信组件 SSL 运行环境
  866. * 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存
  867. * 1、通信组件析构时会自动调用本方法
  868. * 2、当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
  869. *
  870. * 参数: 无
  871. *
  872. * 返回值:无
  873. */
  874. virtual void CleanupSSLContext() = 0;
  875. /*
  876. * 名称:启动 SSL 握手
  877. * 描述:当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
  878. *
  879. * 返回值: TRUE -- 成功
  880. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  881. */
  882. virtual BOOL StartSSLHandShake() = 0;
  883. #endif
  884. public:
  885. /***********************************************************************/
  886. /***************************** 属性访问方法 *****************************/
  887. /* 设置同步连接超时时间(毫秒) */
  888. virtual void SetSyncConnectTimeout (DWORD dwSyncConnectTimeout) = 0;
  889. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj)) */
  890. virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0;
  891. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  892. virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0;
  893. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  894. virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0;
  895. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  896. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  897. /* 获取同步连接超时时间 */
  898. virtual DWORD GetSyncConnectTimeout () = 0;
  899. /* 获取通信数据缓冲区大小 */
  900. virtual DWORD GetSocketBufferSize () = 0;
  901. /* 获取正常心跳包间隔 */
  902. virtual DWORD GetKeepAliveTime () = 0;
  903. /* 获取异常心跳包间隔 */
  904. virtual DWORD GetKeepAliveInterval () = 0;
  905. /* 检查是否开启 nodelay 模式 */
  906. virtual BOOL IsNoDelay () = 0;
  907. #ifdef _SSL_SUPPORT
  908. /* 设置通信组件握手方式(默认:TRUE,自动握手) */
  909. virtual void SetSSLAutoHandShake(BOOL bAutoHandShake) = 0;
  910. /* 获取通信组件握手方式 */
  911. virtual BOOL IsSSLAutoHandShake() = 0;
  912. /* 设置 SSL 加密算法列表 */
  913. virtual void SetSSLCipherList(LPCTSTR lpszCipherList) = 0;
  914. /* 获取 SSL 加密算法列表 */
  915. virtual LPCTSTR GetSSLCipherList() = 0;
  916. /*
  917. * 名称:获取 SSL Session 信息
  918. * 描述:获取指定类型的 SSL Session 信息(输出类型参考:EnSSLSessionInfo)
  919. *
  920. * 返回值: TRUE -- 成功
  921. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  922. */
  923. virtual BOOL GetSSLSessionInfo(EnSSLSessionInfo enInfo, LPVOID* lppInfo) = 0;
  924. #endif
  925. };
  926. #ifdef _UDP_SUPPORT
  927. /************************************************************************
  928. 名称:UDP 通信客户端组件接口
  929. 描述:定义 UDP 通信客户端组件的所有操作方法和属性访问方法
  930. ************************************************************************/
  931. class IUdpClient : public IClient
  932. {
  933. public:
  934. /***********************************************************************/
  935. /***************************** 组件操作方法 *****************************/
  936. public:
  937. /***********************************************************************/
  938. /***************************** 属性访问方法 *****************************/
  939. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  940. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  941. /* 获取数据报文最大长度 */
  942. virtual DWORD GetMaxDatagramSize() = 0;
  943. /* 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) */
  944. virtual void SetDetectAttempts (DWORD dwDetectAttempts) = 0;
  945. /* 设置监测包发送间隔(毫秒,0 不发送监测包) */
  946. virtual void SetDetectInterval (DWORD dwDetectInterval) = 0;
  947. /* 获取心跳检查次数 */
  948. virtual DWORD GetDetectAttempts () = 0;
  949. /* 获取心跳检查间隔 */
  950. virtual DWORD GetDetectInterval () = 0;
  951. };
  952. /************************************************************************
  953. 名称:UDP 传播组件接口
  954. 描述:定义 UDP 传播(组播或广播)组件的所有操作方法和属性访问方法
  955. ************************************************************************/
  956. class IUdpCast : public IClient
  957. {
  958. public:
  959. /***********************************************************************/
  960. /***************************** 组件操作方法 *****************************/
  961. public:
  962. /***********************************************************************/
  963. /***************************** 属性访问方法 *****************************/
  964. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  965. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  966. /* 获取数据报文最大长度 */
  967. virtual DWORD GetMaxDatagramSize() = 0;
  968. /* 设置传播模式(组播或广播) */
  969. virtual void SetCastMode (EnCastMode enCastMode) = 0;
  970. /* 获取传播模式 */
  971. virtual EnCastMode GetCastMode () = 0;
  972. /* 设置组播报文的 TTL(0 - 255) */
  973. virtual void SetMultiCastTtl (int iMCTtl) = 0;
  974. /* 获取组播报文的 TTL */
  975. virtual int GetMultiCastTtl () = 0;
  976. /* 设置是否启用组播环路(TRUE or FALSE) */
  977. virtual void SetMultiCastLoop (BOOL bMCLoop) = 0;
  978. /* 检测是否启用组播环路 */
  979. virtual BOOL IsMultiCastLoop () = 0;
  980. /* 获取当前数据报的远程地址信息(通常在 OnReceive 事件中调用) */
  981. virtual BOOL GetRemoteAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  982. };
  983. /************************************************************************
  984. 名称:UDP 节点组件接口
  985. 描述:定义 UDP 节点组件的所有操作方法和属性访问方法
  986. ************************************************************************/
  987. class IUdpNode
  988. {
  989. public:
  990. /***********************************************************************/
  991. /***************************** 组件操作方法 *****************************/
  992. /*
  993. * 名称:启动通信组件
  994. * 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
  995. *
  996. * 参数: lpszBindAddress -- 绑定地址(默认:nullptr,绑定任意地址)
  997. * usPort -- 本地端口(默认:0)
  998. * enCastMode -- 传播模式(默认:CM_UNICAST)
  999. * lpszCastAddress -- 传播地址(默认:nullptr,当 enCaseMode 为 CM_MULTICAST 或 CM_BROADCAST 时有效)
  1000. * 返回值: TRUE -- 成功
  1001. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  1002. */
  1003. virtual BOOL Start(LPCTSTR lpszBindAddress = nullptr, USHORT usPort = 0, EnCastMode enCastMode = CM_UNICAST, LPCTSTR lpszCastAddress = nullptr) = 0;
  1004. /*
  1005. * 名称:关闭通信组件
  1006. * 描述:关闭 UDP 节点通信组件,关闭完成后释放所有资源
  1007. *
  1008. * 参数:
  1009. * 返回值: TRUE -- 成功
  1010. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  1011. */
  1012. virtual BOOL Stop() = 0;
  1013. /*
  1014. * 名称:发送数据
  1015. * 描述:向指定地址发送数据
  1016. *
  1017. * 参数: lpszRemoteAddress -- 远程地址
  1018. * usRemotePort -- 远程端口
  1019. * pBuffer -- 发送缓冲区
  1020. * iLength -- 发送缓冲区长度
  1021. * iOffset -- 发送缓冲区指针偏移量
  1022. * 返回值: TRUE -- 成功
  1023. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1024. */
  1025. virtual BOOL Send(LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  1026. /*
  1027. * 名称:发送多组数据
  1028. * 描述:向指定地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  1029. *
  1030. * 参数: lpszRemoteAddress -- 远程地址
  1031. * usRemotePort -- 远程端口
  1032. * pBuffers -- 发送缓冲区数组
  1033. * iCount -- 发送缓冲区数目
  1034. * 返回值: TRUE -- 成功
  1035. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1036. */
  1037. virtual BOOL SendPackets(LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const WSABUF pBuffers[], int iCount) = 0;
  1038. /*
  1039. * 名称:发送数据
  1040. * 描述:向传播地址发送数据
  1041. *
  1042. * 参数: pBuffer -- 发送缓冲区
  1043. * iLength -- 发送缓冲区长度
  1044. * iOffset -- 发送缓冲区指针偏移量
  1045. * 返回值: TRUE -- 成功
  1046. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1047. */
  1048. virtual BOOL SendCast(const BYTE* pBuffer, int iLength, int iOffset = 0) = 0;
  1049. /*
  1050. * 名称:发送多组数据
  1051. * 描述:向传播地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  1052. *
  1053. * 参数: pBuffers -- 发送缓冲区数组
  1054. * iCount -- 发送缓冲区数目
  1055. * 返回值: TRUE -- 成功
  1056. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1057. */
  1058. virtual BOOL SendCastPackets(const WSABUF pBuffers[], int iCount) = 0;
  1059. /*
  1060. * 名称:等待
  1061. * 描述:等待通信组件停止运行
  1062. *
  1063. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  1064. * 返回值: TRUE -- 成功
  1065. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1066. */
  1067. virtual BOOL Wait(DWORD dwMilliseconds = INFINITE) = 0;
  1068. public:
  1069. /***********************************************************************/
  1070. /***************************** 属性访问方法 *****************************/
  1071. /* 设置附加数据 */
  1072. virtual void SetExtra (PVOID pExtra) = 0;
  1073. /* 获取附加数据 */
  1074. virtual PVOID GetExtra () = 0;
  1075. /* 检查通信组件是否已启动 */
  1076. virtual BOOL HasStarted () = 0;
  1077. /* 查看通信组件当前状态 */
  1078. virtual EnServiceState GetState () = 0;
  1079. /* 获取最近一次失败操作的错误代码 */
  1080. virtual EnSocketError GetLastError () = 0;
  1081. /* 获取最近一次失败操作的错误描述 */
  1082. virtual LPCTSTR GetLastErrorDesc () = 0;
  1083. /* 获取本节点地址 */
  1084. virtual BOOL GetLocalAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  1085. /* 获取本节点传播地址 */
  1086. virtual BOOL GetCastAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0;
  1087. /* 获取传播模式 */
  1088. virtual EnCastMode GetCastMode () = 0;
  1089. /* 获取未发出数据的长度 */
  1090. virtual BOOL GetPendingDataLength (int& iPending) = 0;
  1091. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  1092. virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0;
  1093. /* 获取数据报文最大长度 */
  1094. virtual DWORD GetMaxDatagramSize() = 0;
  1095. /* 设置组播报文的 TTL(0 - 255) */
  1096. virtual void SetMultiCastTtl (int iMCTtl) = 0;
  1097. /* 获取组播报文的 TTL */
  1098. virtual int GetMultiCastTtl () = 0;
  1099. /* 设置是否启用组播环路(TRUE or FALSE) */
  1100. virtual void SetMultiCastLoop (BOOL bMCLoop) = 0;
  1101. /* 检测是否启用组播环路 */
  1102. virtual BOOL IsMultiCastLoop () = 0;
  1103. /* 设置地址重用选项 */
  1104. virtual void SetReuseAddressPolicy(EnReuseAddressPolicy enReusePolicy) = 0;
  1105. /* 设置工作线程数量(通常设置为 2 * CPU + 2) */
  1106. virtual void SetWorkerThreadCount (DWORD dwWorkerThreadCount) = 0;
  1107. /* 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小) */
  1108. virtual void SetPostReceiveCount (DWORD dwPostReceiveCount) = 0;
  1109. /* 设置内存块缓存池大小 */
  1110. virtual void SetFreeBufferPoolSize (DWORD dwFreeBufferPoolSize) = 0;
  1111. /* 设置内存块缓存池回收阀值 */
  1112. virtual void SetFreeBufferPoolHold (DWORD dwFreeBufferPoolHold) = 0;
  1113. /* 获取地址重用选项 */
  1114. virtual EnReuseAddressPolicy GetReuseAddressPolicy() = 0;
  1115. /* 获取工作线程数量 */
  1116. virtual DWORD GetWorkerThreadCount () = 0;
  1117. /* 获取 Receive 预投递数量 */
  1118. virtual DWORD GetPostReceiveCount () = 0;
  1119. /* 获取内存块缓存池大小 */
  1120. virtual DWORD GetFreeBufferPoolSize () = 0;
  1121. /* 获取内存块缓存池回收阀值 */
  1122. virtual DWORD GetFreeBufferPoolHold () = 0;
  1123. public:
  1124. virtual ~IUdpNode() = default;
  1125. };
  1126. /************************************************************************
  1127. 名称:Client ARQ 模型组件接口
  1128. 描述:定义 Client 组件的 ARQ 模型组件的所有操作方法
  1129. ************************************************************************/
  1130. class IArqClient
  1131. {
  1132. public:
  1133. /***********************************************************************/
  1134. /***************************** 组件操作方法 *****************************/
  1135. public:
  1136. /***********************************************************************/
  1137. /***************************** 属性访问方法 *****************************/
  1138. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  1139. virtual void SetNoDelay (BOOL bNoDelay) = 0;
  1140. /* 设置是否关闭拥塞控制(默认:FALSE,不关闭) */
  1141. virtual void SetTurnoffCongestCtrl (BOOL bTurnOff) = 0;
  1142. /* 设置数据刷新间隔(毫秒,默认:60) */
  1143. virtual void SetFlushInterval (DWORD dwFlushInterval) = 0;
  1144. /* 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传) */
  1145. virtual void SetResendByAcks (DWORD dwResendByAcks) = 0;
  1146. /* 设置发送窗口大小(数据包数量,默认:128) */
  1147. virtual void SetSendWndSize (DWORD dwSendWndSize) = 0;
  1148. /* 设置接收窗口大小(数据包数量,默认:512) */
  1149. virtual void SetRecvWndSize (DWORD dwRecvWndSize) = 0;
  1150. /* 设置最小重传超时时间(毫秒,默认:30) */
  1151. virtual void SetMinRto (DWORD dwMinRto) = 0;
  1152. /* 设置快速握手次数限制(默认:5,如果为 0 则不限制) */
  1153. virtual void SetFastLimit (DWORD dwFastLimit) = 0;
  1154. /* 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致) */
  1155. virtual void SetMaxTransUnit (DWORD dwMaxTransUnit) = 0;
  1156. /* 设置最大数据包大小(默认:4096) */
  1157. virtual void SetMaxMessageSize (DWORD dwMaxMessageSize) = 0;
  1158. /* 设置握手超时时间(毫秒,默认:5000) */
  1159. virtual void SetHandShakeTimeout (DWORD dwHandShakeTimeout) = 0;
  1160. /* 检测是否开启 nodelay 模式 */
  1161. virtual BOOL IsNoDelay () = 0;
  1162. /* 检测是否关闭拥塞控制 */
  1163. virtual BOOL IsTurnoffCongestCtrl () = 0;
  1164. /* 获取数据刷新间隔 */
  1165. virtual DWORD GetFlushInterval () = 0;
  1166. /* 获取快速重传 ACK 跨越次数 */
  1167. virtual DWORD GetResendByAcks () = 0;
  1168. /* 获取发送窗口大小 */
  1169. virtual DWORD GetSendWndSize () = 0;
  1170. /* 获取接收窗口大小 */
  1171. virtual DWORD GetRecvWndSize () = 0;
  1172. /* 获取最小重传超时时间 */
  1173. virtual DWORD GetMinRto () = 0;
  1174. /* 获取快速握手次数限制 */
  1175. virtual DWORD GetFastLimit () = 0;
  1176. /* 获取最大传输单元 */
  1177. virtual DWORD GetMaxTransUnit () = 0;
  1178. /* 获取最大数据包大小 */
  1179. virtual DWORD GetMaxMessageSize () = 0;
  1180. /* 获取握手超时时间 */
  1181. virtual DWORD GetHandShakeTimeout () = 0;
  1182. /* 获取等待发送包数量 */
  1183. virtual BOOL GetWaitingSendMessageCount (int& iCount) = 0;
  1184. public:
  1185. virtual ~IArqClient() = default;
  1186. };
  1187. /************************************************************************
  1188. 名称:UDP ARQ 通信客户端组件接口
  1189. 描述:继承了 ARQ 和 Client 接口
  1190. ************************************************************************/
  1191. typedef DualInterface<IArqClient, IUdpClient> IUdpArqClient;
  1192. #endif
  1193. /************************************************************************
  1194. 名称:Server/Agent PULL 模型组件接口
  1195. 描述:定义 Server/Agent 组件的 PULL 模型组件的所有操作方法
  1196. ************************************************************************/
  1197. class IPullSocket
  1198. {
  1199. public:
  1200. /*
  1201. * 名称:抓取数据
  1202. * 描述:用户通过该方法从 Socket 组件中抓取数据
  1203. *
  1204. * 参数: dwConnID -- 连接 ID
  1205. * pData -- 抓取缓冲区
  1206. * iLength -- 抓取数据长度
  1207. * 返回值: EnFetchResult
  1208. */
  1209. virtual EnFetchResult Fetch (CONNID dwConnID, BYTE* pData, int iLength) = 0;
  1210. /*
  1211. * 名称:窥探数据(不会移除缓冲区数据)
  1212. * 描述:用户通过该方法从 Socket 组件中窥探数据
  1213. *
  1214. * 参数: dwConnID -- 连接 ID
  1215. * pData -- 窥探缓冲区
  1216. * iLength -- 窥探数据长度
  1217. * 返回值: EnFetchResult
  1218. */
  1219. virtual EnFetchResult Peek (CONNID dwConnID, BYTE* pData, int iLength) = 0;
  1220. public:
  1221. virtual ~IPullSocket() = default;
  1222. };
  1223. /************************************************************************
  1224. 名称:Client PULL 模型组件接口
  1225. 描述:定义 Client 组件的 PULL 模型组件的所有操作方法
  1226. ************************************************************************/
  1227. class IPullClient
  1228. {
  1229. public:
  1230. /*
  1231. * 名称:抓取数据
  1232. * 描述:用户通过该方法从 Socket 组件中抓取数据
  1233. *
  1234. * 参数: pData -- 抓取缓冲区
  1235. * iLength -- 抓取数据长度
  1236. * 返回值: EnFetchResult
  1237. */
  1238. virtual EnFetchResult Fetch (BYTE* pData, int iLength) = 0;
  1239. /*
  1240. * 名称:窥探数据(不会移除缓冲区数据)
  1241. * 描述:用户通过该方法从 Socket 组件中窥探数据
  1242. *
  1243. * 参数: pData -- 窥探缓冲区
  1244. * iLength -- 窥探数据长度
  1245. * 返回值: EnFetchResult
  1246. */
  1247. virtual EnFetchResult Peek (BYTE* pData, int iLength) = 0;
  1248. public:
  1249. virtual ~IPullClient() = default;
  1250. };
  1251. /************************************************************************
  1252. 名称:TCP PULL 模型组件接口
  1253. 描述:继承了 PULL 和 Socket 接口
  1254. ************************************************************************/
  1255. typedef DualInterface<IPullSocket, ITcpServer> ITcpPullServer;
  1256. typedef DualInterface<IPullSocket, ITcpAgent> ITcpPullAgent;
  1257. typedef DualInterface<IPullClient, ITcpClient> ITcpPullClient;
  1258. /************************************************************************
  1259. 名称:Server/Agent PACK 模型组件接口
  1260. 描述:定义 Server/Agent 组件的 PACK 模型组件的所有操作方法
  1261. ************************************************************************/
  1262. class IPackSocket
  1263. {
  1264. public:
  1265. /***********************************************************************/
  1266. /***************************** 属性访问方法 *****************************/
  1267. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  1268. virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0;
  1269. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  1270. virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0;
  1271. /* 获取数据包最大长度 */
  1272. virtual DWORD GetMaxPackSize () = 0;
  1273. /* 获取包头标识 */
  1274. virtual USHORT GetPackHeaderFlag() = 0;
  1275. public:
  1276. virtual ~IPackSocket() = default;
  1277. };
  1278. /************************************************************************
  1279. 名称:Client PACK 模型组件接口
  1280. 描述:定义 Client 组件的 PACK 模型组件的所有操作方法
  1281. ************************************************************************/
  1282. class IPackClient
  1283. {
  1284. public:
  1285. /***********************************************************************/
  1286. /***************************** 属性访问方法 *****************************/
  1287. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  1288. virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0;
  1289. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  1290. virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0;
  1291. /* 获取数据包最大长度 */
  1292. virtual DWORD GetMaxPackSize () = 0;
  1293. /* 获取包头标识 */
  1294. virtual USHORT GetPackHeaderFlag() = 0;
  1295. public:
  1296. virtual ~IPackClient() = default;
  1297. };
  1298. /************************************************************************
  1299. 名称:TCP PACK 模型组件接口
  1300. 描述:继承了 PACK 和 Socket 接口
  1301. ************************************************************************/
  1302. typedef DualInterface<IPackSocket, ITcpServer> ITcpPackServer;
  1303. typedef DualInterface<IPackSocket, ITcpAgent> ITcpPackAgent;
  1304. typedef DualInterface<IPackClient, ITcpClient> ITcpPackClient;
  1305. /************************************************************************
  1306. 名称:Socket 监听器基接口
  1307. 描述:定义组件监听器的公共方法
  1308. ************************************************************************/
  1309. template<class T> class ISocketListenerT
  1310. {
  1311. public:
  1312. /*
  1313. * 名称:握手完成通知
  1314. * 描述:连接完成握手时,Socket 监听器将收到该通知,监听器接收到该通知后才能开始
  1315. * 数据收发操作
  1316. *
  1317. * 参数: pSender -- 事件源对象
  1318. * dwConnID -- 连接 ID
  1319. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1320. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1321. */
  1322. virtual EnHandleResult OnHandShake(T* pSender, CONNID dwConnID) = 0;
  1323. /*
  1324. * 名称:已发送数据通知
  1325. * 描述:成功发送数据后,Socket 监听器将收到该通知
  1326. *
  1327. * 参数: pSender -- 事件源对象
  1328. * dwConnID -- 连接 ID
  1329. * pData -- 已发送数据缓冲区
  1330. * iLength -- 已发送数据长度
  1331. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1332. * HR_ERROR -- 该通知不允许返回 HR_ERROR(调试模式下引发断言错误)
  1333. */
  1334. virtual EnHandleResult OnSend(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  1335. /*
  1336. * 名称:数据到达通知(PUSH 模型)
  1337. * 描述:对于 PUSH 模型的 Socket 通信组件,成功接收数据后将向 Socket 监听器发送该通知
  1338. *
  1339. * 参数: pSender -- 事件源对象
  1340. * dwConnID -- 连接 ID
  1341. * pData -- 已接收数据缓冲区
  1342. * iLength -- 已接收数据长度
  1343. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1344. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1345. */
  1346. virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  1347. /*
  1348. * 名称:数据到达通知(PULL 模型)
  1349. * 描述:对于 PULL 模型的 Socket 通信组件,成功接收数据后将向 Socket 监听器发送该通知
  1350. *
  1351. * 参数: pSender -- 事件源对象
  1352. * dwConnID -- 连接 ID
  1353. * iLength -- 已接收数据长度
  1354. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1355. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  1356. */
  1357. virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, int iLength) = 0;
  1358. /*
  1359. * 名称:通信错误通知
  1360. * 描述:通信发生错误后,Socket 监听器将收到该通知,并关闭连接
  1361. *
  1362. * 参数: pSender -- 事件源对象
  1363. * dwConnID -- 连接 ID
  1364. * enOperation -- Socket 操作类型
  1365. * iErrorCode -- 错误代码
  1366. * 返回值: 忽略返回值
  1367. */
  1368. virtual EnHandleResult OnClose(T* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode) = 0;
  1369. public:
  1370. virtual ~ISocketListenerT() = default;
  1371. };
  1372. template<class T> class IComplexSocketListenerT : public ISocketListenerT<T>
  1373. {
  1374. public:
  1375. /*
  1376. * 名称:关闭通信组件通知
  1377. * 描述:通信组件关闭时,Socket 监听器将收到该通知
  1378. *
  1379. * 参数: pSender -- 事件源对象
  1380. * 返回值: 忽略返回值
  1381. */
  1382. virtual EnHandleResult OnShutdown(T* pSender) = 0;
  1383. };
  1384. /************************************************************************
  1385. 名称:服务端 Socket 监听器接口
  1386. 描述:定义服务端 Socket 监听器的所有事件
  1387. ************************************************************************/
  1388. template<class T> class IServerListenerT : public IComplexSocketListenerT<T>
  1389. {
  1390. public:
  1391. /*
  1392. * 名称:准备监听通知
  1393. * 描述:通信服务端组件启动时,在监听 Socket 创建完成并开始执行监听前,Socket 监听
  1394. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1395. *
  1396. * 参数: pSender -- 事件源对象
  1397. * soListen -- 监听 Socket
  1398. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1399. * HR_ERROR -- 终止启动通信服务组件
  1400. */
  1401. virtual EnHandleResult OnPrepareListen(T* pSender, SOCKET soListen) = 0;
  1402. /*
  1403. * 名称:接收连接通知
  1404. * 描述:接收到客户端连接请求时,Socket 监听器将收到该通知,监听器可以在通知处理方
  1405. * 法中执行 Socket 选项设置或拒绝客户端连接等额外工作
  1406. *
  1407. * 参数: pSender -- 事件源对象
  1408. * dwConnID -- 连接 ID
  1409. * soClient -- TCP: 客户端 Socket 句柄,UDP: 客户端 Socket SOCKADDR 指针
  1410. * 返回值: HR_OK / HR_IGNORE -- 接受连接
  1411. * HR_ERROR -- 拒绝连接
  1412. */
  1413. virtual EnHandleResult OnAccept(T* pSender, CONNID dwConnID, UINT_PTR soClient) = 0;
  1414. };
  1415. /************************************************************************
  1416. 名称:TCP 服务端 Socket 监听器接口
  1417. 描述:定义 TCP 服务端 Socket 监听器的所有事件
  1418. ************************************************************************/
  1419. class ITcpServerListener : public IServerListenerT<ITcpServer>
  1420. {
  1421. public:
  1422. };
  1423. /************************************************************************
  1424. 名称:PUSH 模型服务端 Socket 监听器抽象基类
  1425. 描述:定义某些事件的默认处理方法(忽略事件)
  1426. ************************************************************************/
  1427. class CTcpServerListener : public ITcpServerListener
  1428. {
  1429. public:
  1430. virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen) override {return HR_IGNORE;}
  1431. virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient) override {return HR_IGNORE;}
  1432. virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1433. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1434. virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1435. virtual EnHandleResult OnShutdown(ITcpServer* pSender) override {return HR_IGNORE;}
  1436. };
  1437. /************************************************************************
  1438. 名称:PULL 模型服务端 Socket 监听器抽象基类
  1439. 描述:定义某些事件的默认处理方法(忽略事件)
  1440. ************************************************************************/
  1441. class CTcpPullServerListener : public CTcpServerListener
  1442. {
  1443. public:
  1444. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) override = 0;
  1445. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1446. };
  1447. #ifdef _UDP_SUPPORT
  1448. /************************************************************************
  1449. 名称:UDP 服务端 Socket 监听器接口
  1450. 描述:定义 UDP 服务端 Socket 监听器的所有事件
  1451. ************************************************************************/
  1452. class IUdpServerListener : public IServerListenerT<IUdpServer>
  1453. {
  1454. public:
  1455. };
  1456. /************************************************************************
  1457. 名称:UDP 服务端 Socket 监听器抽象基类
  1458. 描述:定义某些事件的默认处理方法(忽略事件)
  1459. ************************************************************************/
  1460. class CUdpServerListener : public IUdpServerListener
  1461. {
  1462. public:
  1463. virtual EnHandleResult OnPrepareListen(IUdpServer* pSender, SOCKET soListen) override {return HR_IGNORE;}
  1464. virtual EnHandleResult OnAccept(IUdpServer* pSender, CONNID dwConnID, UINT_PTR pSockAddr) override {return HR_IGNORE;}
  1465. virtual EnHandleResult OnHandShake(IUdpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1466. virtual EnHandleResult OnReceive(IUdpServer* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1467. virtual EnHandleResult OnSend(IUdpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1468. virtual EnHandleResult OnShutdown(IUdpServer* pSender) override {return HR_IGNORE;}
  1469. };
  1470. #endif
  1471. /************************************************************************
  1472. 名称:通信代理 Socket 监听器接口
  1473. 描述:定义 通信代理 Socket 监听器的所有事件
  1474. ************************************************************************/
  1475. template<class T> class IAgentListenerT : public IComplexSocketListenerT<T>
  1476. {
  1477. public:
  1478. /*
  1479. * 名称:准备连接通知
  1480. * 描述:通信客户端组件启动时,在客户端 Socket 创建完成并开始执行连接前,Socket 监听
  1481. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1482. *
  1483. * 参数: pSender -- 事件源对象
  1484. * dwConnID -- 连接 ID
  1485. * socket -- 客户端 Socket
  1486. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1487. * HR_ERROR -- 终止启动通信客户端组件
  1488. */
  1489. virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket) = 0;
  1490. /*
  1491. * 名称:连接完成通知
  1492. * 描述:与服务端成功建立连接时,Socket 监听器将收到该通知
  1493. *
  1494. * 参数: pSender -- 事件源对象
  1495. * dwConnID -- 连接 ID
  1496. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1497. * HR_ERROR -- 同步连接:终止启动通信客户端组件
  1498. * 异步连接:关闭连接
  1499. */
  1500. virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID) = 0;
  1501. };
  1502. /************************************************************************
  1503. 名称:TCP 通信代理 Socket 监听器接口
  1504. 描述:定义 TCP 通信代理 Socket 监听器的所有事件
  1505. ************************************************************************/
  1506. class ITcpAgentListener : public IAgentListenerT<ITcpAgent>
  1507. {
  1508. public:
  1509. };
  1510. /************************************************************************
  1511. 名称:PUSH 模型通信代理 Socket 监听器抽象基类
  1512. 描述:定义某些事件的默认处理方法(忽略事件)
  1513. ************************************************************************/
  1514. class CTcpAgentListener : public ITcpAgentListener
  1515. {
  1516. public:
  1517. virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1518. virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1519. virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1520. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1521. virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1522. virtual EnHandleResult OnShutdown(ITcpAgent* pSender) override {return HR_IGNORE;}
  1523. };
  1524. /************************************************************************
  1525. 名称:PULL 通信代理 Socket 监听器抽象基类
  1526. 描述:定义某些事件的默认处理方法(忽略事件)
  1527. ************************************************************************/
  1528. class CTcpPullAgentListener : public CTcpAgentListener
  1529. {
  1530. public:
  1531. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) override = 0;
  1532. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1533. };
  1534. /************************************************************************
  1535. 名称:客户端 Socket 监听器接口
  1536. 描述:定义客户端 Socket 监听器的所有事件
  1537. ************************************************************************/
  1538. template<class T> class IClientListenerT : public ISocketListenerT<T>
  1539. {
  1540. public:
  1541. /*
  1542. * 名称:准备连接通知
  1543. * 描述:通信客户端组件启动时,在客户端 Socket 创建完成并开始执行连接前,Socket 监听
  1544. * 器将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1545. *
  1546. * 参数: pSender -- 事件源对象
  1547. * dwConnID -- 连接 ID
  1548. * socket -- 客户端 Socket
  1549. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1550. * HR_ERROR -- 终止启动通信客户端组件
  1551. */
  1552. virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket) = 0;
  1553. /*
  1554. * 名称:连接完成通知
  1555. * 描述:与服务端成功建立连接时,Socket 监听器将收到该通知
  1556. *
  1557. * 参数: pSender -- 事件源对象
  1558. * dwConnID -- 连接 ID
  1559. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1560. * HR_ERROR -- 同步连接:终止启动通信客户端组件
  1561. * 异步连接:关闭连接
  1562. */
  1563. virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID) = 0;
  1564. };
  1565. /************************************************************************
  1566. 名称:TCP 客户端 Socket 监听器接口
  1567. 描述:定义 TCP 客户端 Socket 监听器的所有事件
  1568. ************************************************************************/
  1569. class ITcpClientListener : public IClientListenerT<ITcpClient>
  1570. {
  1571. public:
  1572. };
  1573. /************************************************************************
  1574. 名称:PUSH 模型客户端 Socket 监听器抽象基类
  1575. 描述:定义某些事件的默认处理方法(忽略事件)
  1576. ************************************************************************/
  1577. class CTcpClientListener : public ITcpClientListener
  1578. {
  1579. public:
  1580. virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1581. virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1582. virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1583. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1584. virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1585. };
  1586. /************************************************************************
  1587. 名称:PULL 客户端 Socket 监听器抽象基类
  1588. 描述:定义某些事件的默认处理方法(忽略事件)
  1589. ************************************************************************/
  1590. class CTcpPullClientListener : public CTcpClientListener
  1591. {
  1592. public:
  1593. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) = 0;
  1594. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;}
  1595. };
  1596. #ifdef _UDP_SUPPORT
  1597. /************************************************************************
  1598. 名称:UDP 客户端 Socket 监听器接口
  1599. 描述:定义 UDP 客户端 Socket 监听器的所有事件
  1600. ************************************************************************/
  1601. class IUdpClientListener : public IClientListenerT<IUdpClient>
  1602. {
  1603. public:
  1604. };
  1605. /************************************************************************
  1606. 名称:UDP 户端 Socket 监听器抽象基类
  1607. 描述:定义某些事件的默认处理方法(忽略事件)
  1608. ************************************************************************/
  1609. class CUdpClientListener : public IUdpClientListener
  1610. {
  1611. public:
  1612. virtual EnHandleResult OnPrepareConnect(IUdpClient* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1613. virtual EnHandleResult OnConnect(IUdpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1614. virtual EnHandleResult OnHandShake(IUdpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1615. virtual EnHandleResult OnReceive(IUdpClient* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1616. virtual EnHandleResult OnSend(IUdpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1617. };
  1618. /************************************************************************
  1619. 名称:UDP 传播 Socket 监听器接口
  1620. 描述:定义 UDP 传播 Socket 监听器的所有事件
  1621. ************************************************************************/
  1622. class IUdpCastListener : public IClientListenerT<IUdpCast>
  1623. {
  1624. public:
  1625. };
  1626. /************************************************************************
  1627. 名称:UDP 传播 Socket 监听器抽象基类
  1628. 描述:定义某些事件的默认处理方法(忽略事件)
  1629. ************************************************************************/
  1630. class CUdpCastListener : public IUdpCastListener
  1631. {
  1632. public:
  1633. virtual EnHandleResult OnPrepareConnect(IUdpCast* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  1634. virtual EnHandleResult OnConnect(IUdpCast* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1635. virtual EnHandleResult OnHandShake(IUdpCast* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  1636. virtual EnHandleResult OnReceive(IUdpCast* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  1637. virtual EnHandleResult OnSend(IUdpCast* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1638. };
  1639. /************************************************************************
  1640. 名称:UDP 节点 Socket 监听器接口
  1641. 描述:定义 UDP 节点 Socket 监听器的所有事件
  1642. ************************************************************************/
  1643. class IUdpNodeListener
  1644. {
  1645. public:
  1646. /*
  1647. * 名称:准备监听通知
  1648. * 描述:通信组件启动时,在监听 Socket 创建完成并开始执行监听前,Socket 监听器
  1649. * 将收到该通知,监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
  1650. *
  1651. * 参数: pSender -- 事件源对象
  1652. * soListen -- 监听 Socket
  1653. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  1654. * HR_ERROR -- 终止启动通信服务组件
  1655. */
  1656. virtual EnHandleResult OnPrepareListen(IUdpNode* pSender, SOCKET soListen) = 0;
  1657. /*
  1658. * 名称:已发送数据通知
  1659. * 描述:成功发送数据后,Socket 监听器将收到该通知
  1660. *
  1661. * 参数: pSender -- 事件源对象
  1662. * lpszRemoteAddress -- 远程地址
  1663. * usRemotePort -- 远程端口
  1664. * pData -- 已发送数据缓冲区
  1665. * iLength -- 已发送数据长度
  1666. * 返回值: 忽略返回值
  1667. */
  1668. virtual EnHandleResult OnSend(IUdpNode* pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) = 0;
  1669. /*
  1670. * 名称:数据到达通知(PUSH 模型)
  1671. * 描述:成功接收数据后,Socket 监听器将收到该通知
  1672. *
  1673. * 参数: pSender -- 事件源对象
  1674. * lpszRemoteAddress -- 远程地址
  1675. * usRemotePort -- 远程端口
  1676. * pData -- 已发送数据缓冲区
  1677. * iLength -- 已发送数据长度
  1678. * 返回值: 忽略返回值
  1679. */
  1680. virtual EnHandleResult OnReceive(IUdpNode* pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) = 0;
  1681. /*
  1682. * 名称:通信错误通知
  1683. * 描述:通信发生错误后,Socket 监听器将收到该通知
  1684. *
  1685. * 参数: pSender -- 事件源对象
  1686. * lpszRemoteAddress -- 远程地址
  1687. * usRemotePort -- 远程端口
  1688. * enOperation -- Socket 操作类型
  1689. * iErrorCode -- 错误代码
  1690. * pData -- 本次事件关联的数据缓冲区
  1691. * iLength -- 本次事件关联的数据长度
  1692. * 返回值: 忽略返回值
  1693. */
  1694. virtual EnHandleResult OnError(IUdpNode* pSender, EnSocketOperation enOperation, int iErrorCode, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) = 0;
  1695. /*
  1696. * 名称:关闭通信组件通知
  1697. * 描述:通信组件关闭时,Socket 监听器将收到该通知
  1698. *
  1699. * 参数: pSender -- 事件源对象
  1700. * 返回值: 忽略返回值
  1701. */
  1702. virtual EnHandleResult OnShutdown(IUdpNode* pSender) = 0;
  1703. public:
  1704. virtual ~IUdpNodeListener() = default;
  1705. };
  1706. /************************************************************************
  1707. 名称:UDP 节点 Socket 监听器抽象基类
  1708. 描述:定义某些事件的默认处理方法(忽略事件)
  1709. ************************************************************************/
  1710. class CUdpNodeListener : public IUdpNodeListener
  1711. {
  1712. public:
  1713. virtual EnHandleResult OnPrepareListen(IUdpNode* pSender, SOCKET soListen) override {return HR_IGNORE;}
  1714. virtual EnHandleResult OnSend(IUdpNode* pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  1715. virtual EnHandleResult OnShutdown(IUdpNode* pSender) override {return HR_IGNORE;}
  1716. };
  1717. #endif
  1718. /*****************************************************************************************************************************************************/
  1719. /****************************************************************** HTTP Interfaces ******************************************************************/
  1720. /*****************************************************************************************************************************************************/
  1721. #ifdef _HTTP_SUPPORT
  1722. /************************************************************************
  1723. 名称:复合 Http 组件接口
  1724. 描述:定义复合 Http 组件的所有操作方法和属性访问方法,复合 Http 组件同时管理多个 Http 连接
  1725. ************************************************************************/
  1726. class IComplexHttp
  1727. {
  1728. public:
  1729. /***********************************************************************/
  1730. /***************************** 组件操作方法 *****************************/
  1731. /*
  1732. * 名称:启动 HTTP 通信
  1733. * 描述:当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信
  1734. *
  1735. * 返回值: TRUE -- 成功
  1736. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  1737. */
  1738. virtual BOOL StartHttp(CONNID dwConnID) = 0;
  1739. /*
  1740. * 名称:发送 Chunked 数据分片
  1741. * 描述:向对端发送 Chunked 数据分片
  1742. *
  1743. * 参数: dwConnID -- 连接 ID
  1744. * pData -- Chunked 数据分片
  1745. * iLength -- 数据分片长度(为 0 表示结束分片)
  1746. * lpszExtensions -- 扩展属性(默认:nullptr)
  1747. * 返回值: TRUE -- 成功
  1748. * FALSE -- 失败
  1749. */
  1750. virtual BOOL SendChunkData(CONNID dwConnID, const BYTE* pData = nullptr, int iLength = 0, LPCSTR lpszExtensions = nullptr) = 0;
  1751. public:
  1752. /***********************************************************************/
  1753. /***************************** 属性访问方法 *****************************/
  1754. /* 设置本地协议版本 */
  1755. virtual void SetLocalVersion(EnHttpVersion usVersion) = 0;
  1756. /* 获取本地协议版本 */
  1757. virtual EnHttpVersion GetLocalVersion() = 0;
  1758. /* 检查是否升级协议 */
  1759. virtual BOOL IsUpgrade(CONNID dwConnID) = 0;
  1760. /* 检查是否有 Keep-Alive 标识 */
  1761. virtual BOOL IsKeepAlive(CONNID dwConnID) = 0;
  1762. /* 获取协议版本 */
  1763. virtual USHORT GetVersion(CONNID dwConnID) = 0;
  1764. /* 获取内容长度 */
  1765. virtual ULONGLONG GetContentLength(CONNID dwConnID) = 0;
  1766. /* 获取内容类型 */
  1767. virtual LPCSTR GetContentType(CONNID dwConnID) = 0;
  1768. /* 获取内容编码 */
  1769. virtual LPCSTR GetContentEncoding(CONNID dwConnID) = 0;
  1770. /* 获取传输编码 */
  1771. virtual LPCSTR GetTransferEncoding(CONNID dwConnID) = 0;
  1772. /* 获取协议升级类型 */
  1773. virtual EnHttpUpgradeType GetUpgradeType(CONNID dwConnID) = 0;
  1774. /* 获取解析错误代码 */
  1775. virtual USHORT GetParseErrorCode(CONNID dwConnID, LPCSTR* lpszErrorDesc = nullptr) = 0;
  1776. /* 获取某个请求头(单值) */
  1777. virtual BOOL GetHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1778. /* 获取某个请求头(多值) */
  1779. virtual BOOL GetHeaders(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1780. /* 获取所有请求头 */
  1781. virtual BOOL GetAllHeaders(CONNID dwConnID, THeader lpHeaders[], DWORD& dwCount) = 0;
  1782. /* 获取所有请求头名称 */
  1783. virtual BOOL GetAllHeaderNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0;
  1784. /* 获取 Cookie */
  1785. virtual BOOL GetCookie(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1786. /* 获取所有 Cookie */
  1787. virtual BOOL GetAllCookies(CONNID dwConnID, TCookie lpCookies[], DWORD& dwCount) = 0;
  1788. /*
  1789. // !! maybe implemented in future !! //
  1790. virtual BOOL GetParam(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  1791. virtual BOOL GetParams(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  1792. virtual BOOL GetAllParams(CONNID dwConnID, LPPARAM lpszParam[], DWORD& dwCount) = 0;
  1793. virtual BOOL GetAllParamNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0;
  1794. */
  1795. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  1796. virtual BOOL GetWSMessageState(CONNID dwConnID, BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain) = 0;
  1797. /* 设置 HTTP 启动方式(默认:TRUE,自动启动) */
  1798. virtual void SetHttpAutoStart(BOOL bAutoStart) = 0;
  1799. /* 获取 HTTP 启动方式 */
  1800. virtual BOOL IsHttpAutoStart() = 0;
  1801. public:
  1802. virtual ~IComplexHttp() = default;
  1803. };
  1804. /************************************************************************
  1805. 名称:复合 Http 请求者组件接口
  1806. 描述:定义复合 Http 请求者组件的所有操作方法和属性访问方法
  1807. ************************************************************************/
  1808. class IComplexHttpRequester : public IComplexHttp
  1809. {
  1810. public:
  1811. /***********************************************************************/
  1812. /***************************** 组件操作方法 *****************************/
  1813. /*
  1814. * 名称:发送 WebSocket 消息
  1815. * 描述:向对端端发送 WebSocket 消息
  1816. *
  1817. * 参数: dwConnID -- 连接 ID
  1818. * bFinal -- 是否结束帧
  1819. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1820. * iOperationCode -- 操作码:0x0 - 0xF
  1821. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  1822. * pData -- 消息体数据缓冲区
  1823. * iLength -- 消息体数据长度
  1824. * ullBodyLen -- 消息总长度
  1825. * ullBodyLen = 0 -> 消息总长度为 iLength
  1826. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1827. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1828. * ullBodyLen < iLength -> 错误参数,发送失败
  1829. * 返回值: TRUE -- 成功
  1830. * FALSE -- 失败
  1831. */
  1832. 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;
  1833. /*
  1834. * 名称:发送请求
  1835. * 描述:向服务端发送 HTTP 请求
  1836. *
  1837. * 参数: dwConnID -- 连接 ID
  1838. * lpszMethod -- 请求方法
  1839. * lpszPath -- 请求路径
  1840. * lpHeaders -- 请求头
  1841. * iHeaderCount -- 请求头数量
  1842. * pBody -- 请求体
  1843. * iLength -- 请求体长度
  1844. * 返回值: TRUE -- 成功
  1845. * FALSE -- 失败
  1846. */
  1847. virtual BOOL SendRequest(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0;
  1848. /*
  1849. * 名称:发送本地文件
  1850. * 描述:向指定连接发送 4096 KB 以下的小文件
  1851. *
  1852. * 参数: dwConnID -- 连接 ID
  1853. * lpszFileName -- 文件路径
  1854. * lpszMethod -- 请求方法
  1855. * lpszPath -- 请求路径
  1856. * lpHeaders -- 请求头
  1857. * iHeaderCount -- 请求头数量
  1858. * 返回值: TRUE -- 成功
  1859. * FALSE -- 失败
  1860. */
  1861. virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1862. /* 发送 POST 请求 */
  1863. virtual BOOL SendPost(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1864. /* 发送 PUT 请求 */
  1865. virtual BOOL SendPut(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1866. /* 发送 PATCH 请求 */
  1867. virtual BOOL SendPatch(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  1868. /* 发送 GET 请求 */
  1869. virtual BOOL SendGet(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1870. /* 发送 DELETE 请求 */
  1871. virtual BOOL SendDelete(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1872. /* 发送 HEAD 请求 */
  1873. virtual BOOL SendHead(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1874. /* 发送 TRACE 请求 */
  1875. virtual BOOL SendTrace(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1876. /* 发送 OPTIONS 请求 */
  1877. virtual BOOL SendOptions(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1878. /* 发送 CONNECT 请求 */
  1879. virtual BOOL SendConnect(CONNID dwConnID, LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1880. public:
  1881. /***********************************************************************/
  1882. /***************************** 属性访问方法 *****************************/
  1883. /* 获取 HTTP 状态码 */
  1884. virtual USHORT GetStatusCode(CONNID dwConnID) = 0;
  1885. /* 设置是否使用 Cookie(默认:TRUE) */
  1886. virtual void SetUseCookie(BOOL bUseCookie) = 0;
  1887. /* 检查是否使用 Cookie */
  1888. virtual BOOL IsUseCookie() = 0;
  1889. };
  1890. /************************************************************************
  1891. 名称:复合 Http 响应者组件接口
  1892. 描述:定义复合 Http 响应者组件的所有操作方法和属性访问方法
  1893. ************************************************************************/
  1894. class IComplexHttpResponder : public IComplexHttp
  1895. {
  1896. public:
  1897. /***********************************************************************/
  1898. /***************************** 组件操作方法 *****************************/
  1899. /*
  1900. * 名称:发送 WebSocket 消息
  1901. * 描述:向对端端发送 WebSocket 消息
  1902. *
  1903. * 参数: dwConnID -- 连接 ID
  1904. * bFinal -- 是否结束帧
  1905. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1906. * iOperationCode -- 操作码:0x0 - 0xF
  1907. * pData -- 消息体数据缓冲区
  1908. * iLength -- 消息体数据长度
  1909. * ullBodyLen -- 消息总长度
  1910. * ullBodyLen = 0 -> 消息总长度为 iLength
  1911. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1912. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1913. * ullBodyLen < iLength -> 错误参数,发送失败
  1914. * 返回值: TRUE -- 成功
  1915. * FALSE -- 失败
  1916. */
  1917. virtual BOOL SendWSMessage(CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0) = 0;
  1918. /*
  1919. * 名称:回复请求
  1920. * 描述:向客户端回复 HTTP 请求
  1921. *
  1922. * 参数: dwConnID -- 连接 ID
  1923. * usStatusCode -- HTTP 状态码
  1924. * lpszDesc -- HTTP 状态描述
  1925. * lpHeaders -- 回复请求头
  1926. * iHeaderCount -- 回复请求头数量
  1927. * pData -- 回复请求体
  1928. * iLength -- 回复请求体长度
  1929. * 返回值: TRUE -- 成功
  1930. * FALSE -- 失败
  1931. */
  1932. 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;
  1933. /*
  1934. * 名称:发送本地文件
  1935. * 描述:向指定连接发送 4096 KB 以下的小文件
  1936. *
  1937. * 参数: dwConnID -- 连接 ID
  1938. * lpszFileName -- 文件路径
  1939. * usStatusCode -- HTTP 状态码
  1940. * lpszDesc -- HTTP 状态描述
  1941. * lpHeaders -- 回复请求头
  1942. * iHeaderCount -- 回复请求头数量
  1943. * 返回值: TRUE -- 成功
  1944. * FALSE -- 失败
  1945. */
  1946. virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, USHORT usStatusCode = HSC_OK, LPCSTR lpszDesc = nullptr, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  1947. /*
  1948. * 名称:释放连接
  1949. * 描述:把连接放入释放队列,等待某个时间(通过 SetReleaseDelay() 设置)关闭连接
  1950. *
  1951. * 参数: dwConnID -- 连接 ID
  1952. * 返回值: TRUE -- 成功
  1953. * FALSE -- 失败
  1954. */
  1955. virtual BOOL Release(CONNID dwConnID) = 0;
  1956. public:
  1957. /***********************************************************************/
  1958. /***************************** 属性访问方法 *****************************/
  1959. /* 获取主机 */
  1960. virtual LPCSTR GetHost(CONNID dwConnID) = 0;
  1961. /* 设置连接释放延时(默认:3000 毫秒) */
  1962. virtual void SetReleaseDelay(DWORD dwReleaseDelay) = 0;
  1963. /* 获取连接释放延时 */
  1964. virtual DWORD GetReleaseDelay() = 0;
  1965. /* 获取请求行 URL 域掩码(URL 域参考:EnHttpUrlField) */
  1966. virtual USHORT GetUrlFieldSet(CONNID dwConnID) = 0;
  1967. /* 获取某个 URL 域值 */
  1968. virtual LPCSTR GetUrlField(CONNID dwConnID, EnHttpUrlField enField) = 0;
  1969. /* 获取请求方法 */
  1970. virtual LPCSTR GetMethod(CONNID dwConnID) = 0;
  1971. };
  1972. /************************************************************************
  1973. 名称:简单 HTTP 组件接口
  1974. 描述:定义 简单 HTTP 组件的所有操作方法和属性访问方法
  1975. ************************************************************************/
  1976. class IHttp
  1977. {
  1978. public:
  1979. /***********************************************************************/
  1980. /***************************** 组件操作方法 *****************************/
  1981. /*
  1982. * 名称:发送 WebSocket 消息
  1983. * 描述:向对端端发送 WebSocket 消息
  1984. *
  1985. * 参数: bFinal -- 是否结束帧
  1986. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1987. * iOperationCode -- 操作码:0x0 - 0xF
  1988. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  1989. * pData -- 消息体数据缓冲区
  1990. * iLength -- 消息体数据长度
  1991. * ullBodyLen -- 消息总长度
  1992. * ullBodyLen = 0 -> 消息总长度为 iLength
  1993. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1994. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1995. * ullBodyLen < iLength -> 错误参数,发送失败
  1996. * 返回值: TRUE -- 成功
  1997. * FALSE -- 失败
  1998. */
  1999. virtual BOOL SendWSMessage(BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], const BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0) = 0;
  2000. /*
  2001. * 名称:启动 HTTP 通信
  2002. * 描述:当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信
  2003. *
  2004. * 返回值: TRUE -- 成功
  2005. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  2006. */
  2007. virtual BOOL StartHttp() = 0;
  2008. /*
  2009. * 名称:发送 Chunked 数据分片
  2010. * 描述:向对端发送 Chunked 数据分片
  2011. *
  2012. * 参数: pData -- Chunked 数据分片
  2013. * iLength -- 数据分片长度(为 0 表示结束分片)
  2014. * lpszExtensions -- 扩展属性(默认:nullptr)
  2015. * 返回值: TRUE -- 成功
  2016. * FALSE -- 失败
  2017. */
  2018. virtual BOOL SendChunkData(const BYTE* pData = nullptr, int iLength = 0, LPCSTR lpszExtensions = nullptr) = 0;
  2019. public:
  2020. /***********************************************************************/
  2021. /***************************** 属性访问方法 *****************************/
  2022. /* 设置本地协议版本 */
  2023. virtual void SetLocalVersion(EnHttpVersion usVersion) = 0;
  2024. /* 获取本地协议版本 */
  2025. virtual EnHttpVersion GetLocalVersion() = 0;
  2026. /* 检查是否升级协议 */
  2027. virtual BOOL IsUpgrade() = 0;
  2028. /* 检查是否有 Keep-Alive 标识 */
  2029. virtual BOOL IsKeepAlive() = 0;
  2030. /* 获取协议版本 */
  2031. virtual USHORT GetVersion() = 0;
  2032. /* 获取内容长度 */
  2033. virtual ULONGLONG GetContentLength() = 0;
  2034. /* 获取内容类型 */
  2035. virtual LPCSTR GetContentType() = 0;
  2036. /* 获取内容编码 */
  2037. virtual LPCSTR GetContentEncoding() = 0;
  2038. /* 获取传输编码 */
  2039. virtual LPCSTR GetTransferEncoding() = 0;
  2040. /* 获取协议升级类型 */
  2041. virtual EnHttpUpgradeType GetUpgradeType() = 0;
  2042. /* 获取解析错误代码 */
  2043. virtual USHORT GetParseErrorCode(LPCSTR* lpszErrorDesc = nullptr) = 0;
  2044. /* 获取 HTTP 状态码 */
  2045. virtual USHORT GetStatusCode() = 0;
  2046. /* 获取某个请求头(单值) */
  2047. virtual BOOL GetHeader(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  2048. /* 获取某个请求头(多值) */
  2049. virtual BOOL GetHeaders(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  2050. /* 获取所有请求头 */
  2051. virtual BOOL GetAllHeaders(THeader lpHeaders[], DWORD& dwCount) = 0;
  2052. /* 获取所有请求头名称 */
  2053. virtual BOOL GetAllHeaderNames(LPCSTR lpszName[], DWORD& dwCount) = 0;
  2054. /* 获取 Cookie */
  2055. virtual BOOL GetCookie(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  2056. /* 获取所有 Cookie */
  2057. virtual BOOL GetAllCookies(TCookie lpCookies[], DWORD& dwCount) = 0;
  2058. /*
  2059. // !! maybe implemented in future !! //
  2060. virtual BOOL GetParam(LPCSTR lpszName, LPCSTR* lpszValue) = 0;
  2061. virtual BOOL GetParams(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0;
  2062. virtual BOOL GetAllParams(LPPARAM lpszParam[], DWORD& dwCount) = 0;
  2063. virtual BOOL GetAllParamNames(LPCSTR lpszName[], DWORD& dwCount) = 0;
  2064. */
  2065. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  2066. virtual BOOL GetWSMessageState(BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain) = 0;
  2067. /* 设置 HTTP 启动方式(默认:TRUE,自动启动) */
  2068. virtual void SetHttpAutoStart(BOOL bAutoStart) = 0;
  2069. /* 获取 HTTP 启动方式 */
  2070. virtual BOOL IsHttpAutoStart() = 0;
  2071. public:
  2072. virtual ~IHttp() = default;
  2073. };
  2074. /************************************************************************
  2075. 名称:简单 Http 请求者组件接口
  2076. 描述:定义简单 Http 请求者组件的所有操作方法和属性访问方法
  2077. ************************************************************************/
  2078. class IHttpRequester : public IHttp
  2079. {
  2080. public:
  2081. /***********************************************************************/
  2082. /***************************** 组件操作方法 *****************************/
  2083. /*
  2084. * 名称:发送请求
  2085. * 描述:向服务端发送 HTTP 请求
  2086. *
  2087. * 参数: lpszMethod -- 请求方法
  2088. * lpszPath -- 请求路径
  2089. * lpHeaders -- 请求头
  2090. * iHeaderCount -- 请求头数量
  2091. * pBody -- 请求体
  2092. * iLength -- 请求体长度
  2093. * 返回值: TRUE -- 成功
  2094. * FALSE -- 失败
  2095. */
  2096. virtual BOOL SendRequest(LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0;
  2097. /*
  2098. * 名称:发送本地文件
  2099. * 描述:向指定连接发送 4096 KB 以下的小文件
  2100. *
  2101. * 参数: dwConnID -- 连接 ID
  2102. * lpszFileName -- 文件路径
  2103. * lpszMethod -- 请求方法
  2104. * lpszPath -- 请求路径
  2105. * lpHeaders -- 请求头
  2106. * iHeaderCount -- 请求头数量
  2107. * 返回值: TRUE -- 成功
  2108. * FALSE -- 失败
  2109. */
  2110. virtual BOOL SendLocalFile(LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2111. /* 发送 POST 请求 */
  2112. virtual BOOL SendPost(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  2113. /* 发送 PUT 请求 */
  2114. virtual BOOL SendPut(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  2115. /* 发送 PATCH 请求 */
  2116. virtual BOOL SendPatch(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0;
  2117. /* 发送 GET 请求 */
  2118. virtual BOOL SendGet(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2119. /* 发送 DELETE 请求 */
  2120. virtual BOOL SendDelete(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2121. /* 发送 HEAD 请求 */
  2122. virtual BOOL SendHead(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2123. /* 发送 TRACE 请求 */
  2124. virtual BOOL SendTrace(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2125. /* 发送 OPTIONS 请求 */
  2126. virtual BOOL SendOptions(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2127. /* 发送 CONNECT 请求 */
  2128. virtual BOOL SendConnect(LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0;
  2129. public:
  2130. /***********************************************************************/
  2131. /***************************** 属性访问方法 *****************************/
  2132. /* 设置是否使用 Cookie(默认:TRUE) */
  2133. virtual void SetUseCookie(BOOL bUseCookie) = 0;
  2134. /* 检查是否使用 Cookie */
  2135. virtual BOOL IsUseCookie() = 0;
  2136. };
  2137. /************************************************************************
  2138. 名称:简单 Http 同步请求者组件接口
  2139. 描述:定义简单 Http 同步请求者组件的所有操作方法和属性访问方法
  2140. ************************************************************************/
  2141. class IHttpSyncRequester : public IHttpRequester
  2142. {
  2143. public:
  2144. /*
  2145. * 名称:发送 URL 请求
  2146. * 描述:向服务端发送 HTTP URL 请求
  2147. *
  2148. * 参数: lpszMethod -- 请求方法
  2149. * lpszUrl -- 请求 URL
  2150. * lpHeaders -- 请求头
  2151. * iHeaderCount -- 请求头数量
  2152. * pBody -- 请求体
  2153. * iLength -- 请求体长度
  2154. * bForceReconnect -- 强制重新连接(默认:FALSE,当请求 URL 的主机和端口与现有连接一致时,重用现有连接)
  2155. * 返回值: TRUE -- 成功
  2156. * FALSE -- 失败
  2157. */
  2158. 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;
  2159. /***********************************************************************/
  2160. /***************************** 组件操作方法 *****************************/
  2161. /*
  2162. * 名称:清除请求结果
  2163. * 描述:清除上一次请求的响应头和响应体等结果信息(该方法会在每次发送请求前自动调用)
  2164. *
  2165. * 参数:
  2166. * 返回值: TRUE -- 成功
  2167. * FALSE -- 失败
  2168. */
  2169. virtual BOOL CleanupRequestResult () = 0;
  2170. public:
  2171. /***********************************************************************/
  2172. /***************************** 属性访问方法 *****************************/
  2173. /* 设置连接超时(毫秒,0:系统默认超时,默认:5000) */
  2174. virtual void SetConnectTimeout (DWORD dwConnectTimeout) = 0;
  2175. /* 设置请求超时(毫秒,0:无限等待,默认:10000) */
  2176. virtual void SetRequestTimeout (DWORD dwRequestTimeout) = 0;
  2177. /* 获取连接超时 */
  2178. virtual DWORD GetConnectTimeout () = 0;
  2179. /* 获取请求超时 */
  2180. virtual DWORD GetRequestTimeout () = 0;
  2181. /* 获取响应体 */
  2182. virtual BOOL GetResponseBody (LPCBYTE* lpszBody, int* iLength) = 0;
  2183. };
  2184. /************************************************************************
  2185. 名称:HTTP 组件接口
  2186. 描述:继承了 HTTP 和 Socket 接口
  2187. ************************************************************************/
  2188. typedef DualInterface<IComplexHttpResponder, ITcpServer> IHttpServer;
  2189. typedef DualInterface<IComplexHttpRequester, ITcpAgent> IHttpAgent;
  2190. typedef DualInterface<IHttpRequester, ITcpClient> IHttpClient;
  2191. typedef DualInterface<IHttpSyncRequester, ITcpClient> IHttpSyncClient;
  2192. /************************************************************************
  2193. 名称:IComplexHttp 组件监听器基接口
  2194. 描述:定义 IComplexHttp 组件监听器的所有事件
  2195. ************************************************************************/
  2196. template<class T> class IHttpListenerT
  2197. {
  2198. public:
  2199. /*
  2200. * 名称:开始解析通知
  2201. * 描述:开始解析 HTTP 报文时,向监听器发送该通知
  2202. *
  2203. * 参数: pSender -- 事件源对象
  2204. * dwConnID -- 连接 ID
  2205. * 返回值: HPR_OK -- 继续执行
  2206. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2207. */
  2208. virtual EnHttpParseResult OnMessageBegin(T* pSender, CONNID dwConnID) = 0;
  2209. /*
  2210. * 名称:请求行解析完成通知(仅用于 HTTP 服务端)
  2211. * 描述:请求行解析完成后,向监听器发送该通知
  2212. *
  2213. * 参数: pSender -- 事件源对象
  2214. * dwConnID -- 连接 ID
  2215. * lpszMethod -- 请求方法名
  2216. * lpszUrl -- 请求行中的 URL 域
  2217. * 返回值: HPR_OK -- 继续执行
  2218. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2219. */
  2220. virtual EnHttpParseResult OnRequestLine(T* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) = 0;
  2221. /*
  2222. * 名称:状态行解析完成通知(仅用于 HTTP 客户端)
  2223. * 描述:状态行解析完成后,向监听器发送该通知
  2224. *
  2225. * 参数: pSender -- 事件源对象
  2226. * dwConnID -- 连接 ID
  2227. * usStatusCode -- HTTP 状态码
  2228. * lpszDesc -- 状态描述
  2229. * 返回值: HPR_OK -- 继续执行
  2230. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2231. */
  2232. virtual EnHttpParseResult OnStatusLine(T* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) = 0;
  2233. /*
  2234. * 名称:请求头通知
  2235. * 描述:每当解析完成一个请求头后,向监听器发送该通知
  2236. *
  2237. * 参数: pSender -- 事件源对象
  2238. * dwConnID -- 连接 ID
  2239. * lpszName -- 请求头名称
  2240. * lpszValue -- 请求头值
  2241. * 返回值: HPR_OK -- 继续执行
  2242. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2243. */
  2244. virtual EnHttpParseResult OnHeader(T* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) = 0;
  2245. /*
  2246. * 名称:请求头完成通知
  2247. * 描述:解析完成所有请求头后,向监听器发送该通知
  2248. *
  2249. * 参数: pSender -- 事件源对象
  2250. * dwConnID -- 连接 ID
  2251. * 返回值: HPR_OK -- 继续执行
  2252. * HPR_SKIP_BODY -- 跳过当前请求的 HTTP BODY
  2253. * HPR_UPGRADE -- 升级协议
  2254. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2255. */
  2256. virtual EnHttpParseResult OnHeadersComplete(T* pSender, CONNID dwConnID) = 0;
  2257. /*
  2258. * 名称:BODY 报文通知
  2259. * 描述:每当接收到 HTTP BODY 报文,向监听器发送该通知
  2260. *
  2261. * 参数: pSender -- 事件源对象
  2262. * dwConnID -- 连接 ID
  2263. * pData -- 数据缓冲区
  2264. * iLength -- 数据长度
  2265. * 返回值: HPR_OK -- 继续执行
  2266. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2267. */
  2268. virtual EnHttpParseResult OnBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  2269. /*
  2270. * 名称:Chunked 报文头通知
  2271. * 描述:每当解析出一个 Chunked 报文头,向监听器发送该通知
  2272. *
  2273. * 参数: pSender -- 事件源对象
  2274. * dwConnID -- 连接 ID
  2275. * iLength -- Chunked 报文体数据长度
  2276. * 返回值: HPR_OK -- 继续执行
  2277. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2278. */
  2279. virtual EnHttpParseResult OnChunkHeader(T* pSender, CONNID dwConnID, int iLength) = 0;
  2280. /*
  2281. * 名称:Chunked 报文结束通知
  2282. * 描述:每当解析完一个 Chunked 报文,向监听器发送该通知
  2283. *
  2284. * 参数: pSender -- 事件源对象
  2285. * dwConnID -- 连接 ID
  2286. * 返回值: HPR_OK -- 继续执行
  2287. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2288. */
  2289. virtual EnHttpParseResult OnChunkComplete(T* pSender, CONNID dwConnID) = 0;
  2290. /*
  2291. * 名称:完成解析通知
  2292. * 描述:每当解析完成一个完整 HTTP 报文,向监听器发送该通知
  2293. *
  2294. * 参数: pSender -- 事件源对象
  2295. * dwConnID -- 连接 ID
  2296. * 返回值: HPR_OK -- 继续执行
  2297. * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接
  2298. */
  2299. virtual EnHttpParseResult OnMessageComplete(T* pSender, CONNID dwConnID) = 0;
  2300. /*
  2301. * 名称:升级协议通知
  2302. * 描述:当需要升级协议时,向监听器发送该通知
  2303. *
  2304. * 参数: pSender -- 事件源对象
  2305. * dwConnID -- 连接 ID
  2306. * enUpgradeType -- 协议类型
  2307. * 返回值: HPR_OK -- 继续执行
  2308. * HPR_ERROR -- 引发 OnClose() 事件并关闭连接
  2309. */
  2310. virtual EnHttpParseResult OnUpgrade(T* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) = 0;
  2311. /*
  2312. * 名称:解析错误通知
  2313. * 描述:当解析 HTTP 报文错误时,向监听器发送该通知
  2314. *
  2315. * 参数: pSender -- 事件源对象
  2316. * dwConnID -- 连接 ID
  2317. * iErrorCode -- 错误代码
  2318. * lpszErrorDesc -- 错误描述
  2319. * 返回值: HPR_OK -- 继续执行
  2320. * HPR_ERROR -- 引发 OnClose() 事件并关闭连接
  2321. */
  2322. virtual EnHttpParseResult OnParseError(T* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc) = 0;
  2323. /*
  2324. * 名称:WebSocket 数据包头通知
  2325. * 描述:当解析 WebSocket 数据包头时,向监听器发送该通知
  2326. *
  2327. * 参数: pSender -- 事件源对象
  2328. * dwConnID -- 连接 ID
  2329. * bFinal -- 是否结束帧
  2330. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  2331. * iOperationCode -- 操作码:0x0 - 0xF
  2332. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  2333. * ullBodyLen -- 消息体长度
  2334. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  2335. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  2336. */
  2337. virtual EnHandleResult OnWSMessageHeader(T* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) = 0;
  2338. /*
  2339. * 名称:WebSocket 数据包体通知
  2340. * 描述:当接收到 WebSocket 数据包体时,向监听器发送该通知
  2341. *
  2342. * 参数: pSender -- 事件源对象
  2343. * dwConnID -- 连接 ID
  2344. * pData -- 消息体数据缓冲区
  2345. * iLength -- 消息体数据长度
  2346. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  2347. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  2348. */
  2349. virtual EnHandleResult OnWSMessageBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength) = 0;
  2350. /*
  2351. * 名称:WebSocket 数据包完成通知
  2352. * 描述:当完整接收一个 WebSocket 数据包时,向监听器发送该通知
  2353. *
  2354. * 参数: pSender -- 事件源对象
  2355. * dwConnID -- 连接 ID
  2356. * 返回值: HR_OK / HR_IGNORE -- 继续执行
  2357. * HR_ERROR -- 引发 OnClose() 事件并关闭连接
  2358. */
  2359. virtual EnHandleResult OnWSMessageComplete(T* pSender, CONNID dwConnID) = 0;
  2360. public:
  2361. virtual ~IHttpListenerT() = default;
  2362. };
  2363. /************************************************************************
  2364. 名称:IHttpServer 组件端监听器接口
  2365. 描述:定义 IHttpServer 监听器的所有事件
  2366. ************************************************************************/
  2367. class IHttpServerListener : public IHttpListenerT<IHttpServer>, public ITcpServerListener
  2368. {
  2369. public:
  2370. };
  2371. /************************************************************************
  2372. 名称:IHttpAgent 组件端监听器接口
  2373. 描述:定义 IHttpAgent 监听器的所有事件
  2374. ************************************************************************/
  2375. class IHttpAgentListener : public IHttpListenerT<IHttpAgent>, public ITcpAgentListener
  2376. {
  2377. public:
  2378. };
  2379. /************************************************************************
  2380. 名称:IHttpClient 组件端监听器接口
  2381. 描述:定义 IHttpClient 监听器的所有事件
  2382. ************************************************************************/
  2383. class IHttpClientListener : public IHttpListenerT<IHttpClient>, public ITcpClientListener
  2384. {
  2385. public:
  2386. };
  2387. /************************************************************************
  2388. 名称:IHttpServerListener 监听器抽象基类
  2389. 描述:定义某些事件的默认处理方法(忽略事件)
  2390. ************************************************************************/
  2391. class CHttpServerListener : public IHttpServerListener
  2392. {
  2393. public:
  2394. virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen) override {return HR_IGNORE;}
  2395. virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient) override {return HR_IGNORE;}
  2396. virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2397. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  2398. virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2399. virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2400. virtual EnHandleResult OnShutdown(ITcpServer* pSender) override {return HR_IGNORE;}
  2401. virtual EnHttpParseResult OnMessageBegin(IHttpServer* pSender, CONNID dwConnID) override {return HPR_OK;}
  2402. virtual EnHttpParseResult OnRequestLine(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) override {return HPR_OK;}
  2403. virtual EnHttpParseResult OnStatusLine(IHttpServer* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) override {return HPR_OK;}
  2404. virtual EnHttpParseResult OnHeader(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) override {return HPR_OK;}
  2405. virtual EnHttpParseResult OnChunkHeader(IHttpServer* pSender, CONNID dwConnID, int iLength) override {return HPR_OK;}
  2406. virtual EnHttpParseResult OnChunkComplete(IHttpServer* pSender, CONNID dwConnID) override {return HPR_OK;}
  2407. virtual EnHttpParseResult OnUpgrade(IHttpServer* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) override {return HPR_OK;}
  2408. virtual EnHandleResult OnWSMessageHeader(IHttpServer* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) override {return HR_IGNORE;}
  2409. virtual EnHandleResult OnWSMessageBody(IHttpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2410. virtual EnHandleResult OnWSMessageComplete(IHttpServer* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2411. };
  2412. /************************************************************************
  2413. 名称:IHttpAgentListener 监听器抽象基类
  2414. 描述:定义某些事件的默认处理方法(忽略事件)
  2415. ************************************************************************/
  2416. class CHttpAgentListener : public IHttpAgentListener
  2417. {
  2418. public:
  2419. virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  2420. virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2421. virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2422. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  2423. virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2424. virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2425. virtual EnHandleResult OnShutdown(ITcpAgent* pSender) override {return HR_IGNORE;}
  2426. virtual EnHttpParseResult OnMessageBegin(IHttpAgent* pSender, CONNID dwConnID) override {return HPR_OK;}
  2427. virtual EnHttpParseResult OnRequestLine(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) override {return HPR_OK;}
  2428. virtual EnHttpParseResult OnStatusLine(IHttpAgent* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) override {return HPR_OK;}
  2429. virtual EnHttpParseResult OnHeader(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) override {return HPR_OK;}
  2430. virtual EnHttpParseResult OnChunkHeader(IHttpAgent* pSender, CONNID dwConnID, int iLength) override {return HPR_OK;}
  2431. virtual EnHttpParseResult OnChunkComplete(IHttpAgent* pSender, CONNID dwConnID) override {return HPR_OK;}
  2432. virtual EnHttpParseResult OnUpgrade(IHttpAgent* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) override {return HPR_OK;}
  2433. virtual EnHandleResult OnWSMessageHeader(IHttpAgent* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) override {return HR_IGNORE;}
  2434. virtual EnHandleResult OnWSMessageBody(IHttpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2435. virtual EnHandleResult OnWSMessageComplete(IHttpAgent* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2436. };
  2437. /************************************************************************
  2438. 名称:IHttpClientListener 监听器抽象基类
  2439. 描述:定义某些事件的默认处理方法(忽略事件)
  2440. ************************************************************************/
  2441. class CHttpClientListener : public IHttpClientListener
  2442. {
  2443. public:
  2444. virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket) override {return HR_IGNORE;}
  2445. virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2446. virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2447. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength) override {return HR_IGNORE;}
  2448. virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2449. virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2450. virtual EnHttpParseResult OnMessageBegin(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2451. virtual EnHttpParseResult OnRequestLine(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) override {return HPR_OK;}
  2452. virtual EnHttpParseResult OnStatusLine(IHttpClient* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) override {return HPR_OK;}
  2453. virtual EnHttpParseResult OnHeader(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) override {return HPR_OK;}
  2454. virtual EnHttpParseResult OnChunkHeader(IHttpClient* pSender, CONNID dwConnID, int iLength) override {return HPR_OK;}
  2455. virtual EnHttpParseResult OnChunkComplete(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2456. virtual EnHttpParseResult OnUpgrade(IHttpClient* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType) override {return HPR_OK;}
  2457. virtual EnHandleResult OnWSMessageHeader(IHttpClient* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen) override {return HR_IGNORE;}
  2458. virtual EnHandleResult OnWSMessageBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HR_IGNORE;}
  2459. virtual EnHandleResult OnWSMessageComplete(IHttpClient* pSender, CONNID dwConnID) override {return HR_IGNORE;}
  2460. };
  2461. /************************************************************************
  2462. 名称:IHttpClientListener 监听器抽象基类
  2463. 描述:定义某些事件的默认处理方法(忽略事件)
  2464. ************************************************************************/
  2465. class CHttpSyncClientListener : public CHttpClientListener
  2466. {
  2467. public:
  2468. virtual EnHandleResult OnClose(ITcpClient* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode) override {return HR_IGNORE;}
  2469. virtual EnHttpParseResult OnHeadersComplete(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2470. virtual EnHttpParseResult OnBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength) override {return HPR_OK;}
  2471. virtual EnHttpParseResult OnMessageComplete(IHttpClient* pSender, CONNID dwConnID) override {return HPR_OK;}
  2472. virtual EnHttpParseResult OnParseError(IHttpClient* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc) override {return HPR_OK;}
  2473. };
  2474. #endif
  2475. /*****************************************************************************************************************************************************/
  2476. /************************************************************** Thread Pool Interfaces ***************************************************************/
  2477. /*****************************************************************************************************************************************************/
  2478. /************************************************************************
  2479. 名称:线程池组件接口
  2480. 描述:定义线程池组件的所有操作方法和属性访问方法
  2481. ************************************************************************/
  2482. class IHPThreadPool
  2483. {
  2484. public:
  2485. /***********************************************************************/
  2486. /***************************** 组件操作方法 *****************************/
  2487. /*
  2488. * 名称:启动线程池组件
  2489. * 描述:
  2490. *
  2491. * 参数: dwThreadCount -- 线程数量,(默认:0)
  2492. * >0 -> dwThreadCount
  2493. * =0 -> (CPU核数 * 2 + 2)
  2494. * <0 -> (CPU核数 * (-dwThreadCount))
  2495. * dwMaxQueueSize -- 任务队列最大容量(默认:0,不限制)
  2496. * enRejectedPolicy -- 任务拒绝处理策略
  2497. * TRP_CALL_FAIL(默认) :立刻返回失败
  2498. * TRP_WAIT_FOR :等待(直到成功、超时或线程池关闭等原因导致失败)
  2499. * TRP_CALLER_RUN :调用者线程直接执行
  2500. * dwStackSize -- 线程堆栈空间大小(默认:0 -> 操作系统默认)
  2501. * 返回值: TRUE -- 成功
  2502. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2503. */
  2504. virtual BOOL Start (DWORD dwThreadCount = 0, DWORD dwMaxQueueSize = 0, EnRejectedPolicy enRejectedPolicy = TRP_CALL_FAIL, DWORD dwStackSize = 0) = 0;
  2505. /*
  2506. * 名称:关闭线程池组件
  2507. * 描述:在规定时间内关闭线程池组件,如果工作线程在最大等待时间内未能正常关闭,会尝试强制关闭,这种情况下很可能会造成系统资源泄漏
  2508. *
  2509. * 参数: dwMaxWait -- 最大等待时间(毫秒,默认:INFINITE,一直等待)
  2510. * 返回值: TRUE -- 成功
  2511. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2512. */
  2513. virtual BOOL Stop (DWORD dwMaxWait = INFINITE) = 0;
  2514. /*
  2515. * 名称:提交任务
  2516. * 描述:向线程池提交异步任务
  2517. *
  2518. * 参数: fnTaskProc -- 任务处理函数
  2519. * pvArg -- 任务参数
  2520. * dwMaxWait -- 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
  2521. * 返回值: TRUE -- 成功
  2522. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2523. * 其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
  2524. */
  2525. virtual BOOL Submit (Fn_TaskProc fnTaskProc, PVOID pvArg, DWORD dwMaxWait = INFINITE) = 0;
  2526. /*
  2527. * 名称:提交 Socket 任务
  2528. * 描述:向线程池提交异步 Socket 任务
  2529. *
  2530. * 参数: pTask -- 任务参数
  2531. * dwMaxWait -- 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
  2532. * 返回值: TRUE -- 成功
  2533. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2534. * 其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
  2535. * 注意:如果提交失败,需要手工调用 Destroy_HP_SocketTaskObj() 销毁 TSocketTask 对象
  2536. */
  2537. virtual BOOL Submit (LPTSocketTask pTask, DWORD dwMaxWait = INFINITE) = 0;
  2538. /*
  2539. * 名称:调整线程池大小
  2540. * 描述:增加或减少线程池的工作线程数量
  2541. *
  2542. * 参数: dwNewThreadCount -- 线程数量
  2543. * >0 -> dwNewThreadCount
  2544. * =0 -> (CPU核数 * 2 + 2)
  2545. * <0 -> (CPU核数 * (-dwNewThreadCount))
  2546. * 返回值: TRUE -- 成功
  2547. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2548. */
  2549. virtual BOOL AdjustThreadCount(DWORD dwNewThreadCount) = 0;
  2550. /*
  2551. * 名称:等待
  2552. * 描述:等待线程池组件停止运行
  2553. *
  2554. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  2555. * 返回值: TRUE -- 成功
  2556. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2557. */
  2558. virtual BOOL Wait(DWORD dwMilliseconds = INFINITE) = 0;
  2559. public:
  2560. /***********************************************************************/
  2561. /***************************** 属性访问方法 *****************************/
  2562. /* 检查线程池组件是否已启动 */
  2563. virtual BOOL HasStarted () = 0;
  2564. /* 查看线程池组件当前状态 */
  2565. virtual EnServiceState GetState () = 0;
  2566. /* 获取当前任务等待队列大小 */
  2567. virtual DWORD GetQueueSize () = 0;
  2568. /* 获取当前正在执行的任务数量 */
  2569. virtual DWORD GetTaskCount () = 0;
  2570. /* 获取工作线程数量 */
  2571. virtual DWORD GetThreadCount () = 0;
  2572. /* 获取任务队列最大容量 */
  2573. virtual DWORD GetMaxQueueSize () = 0;
  2574. /* 获取任务拒绝处理策略 */
  2575. virtual EnRejectedPolicy GetRejectedPolicy () = 0;
  2576. public:
  2577. virtual ~IHPThreadPool() = default;
  2578. };
  2579. /************************************************************************
  2580. 名称:线程池监听器接口
  2581. 描述:定义线程池监听器的所有事件
  2582. ************************************************************************/
  2583. class IHPThreadPoolListener
  2584. {
  2585. public:
  2586. /*
  2587. * 名称:线程池启动通知
  2588. * 描述:线程池启动时监听器将收到该通知,监听器可以在通知处理方法中执行预处理工作
  2589. *
  2590. * 参数: pThreadPool -- 线程池对象
  2591. * 返回值: 无
  2592. */
  2593. virtual void OnStartup(IHPThreadPool* pThreadPool) = 0;
  2594. /*
  2595. * 名称:线程池启动关闭通知
  2596. * 描述:线程池关闭时监听器将收到该通知,监听器可以在通知处理方法中执行后处理工作
  2597. *
  2598. * 参数: pThreadPool -- 线程池对象
  2599. * 返回值: 无
  2600. */
  2601. virtual void OnShutdown(IHPThreadPool* pThreadPool) = 0;
  2602. /*
  2603. * 名称:工作线程启动通知
  2604. * 描述:工作线程启动时监听器将收到该通知,监听器可以在通知处理方法中执行线程级别预处理工作
  2605. *
  2606. * 参数: pThreadPool -- 线程池对象
  2607. * dwThreadID -- 工作线程 ID
  2608. * 返回值: 无
  2609. */
  2610. virtual void OnWorkerThreadStart(IHPThreadPool* pThreadPool, THR_ID dwThreadID) = 0;
  2611. /*
  2612. * 名称:工作线程退出通知
  2613. * 描述:工作线程退出时监听器将收到该通知,监听器可以在通知处理方法中执行线程级别后处理工作
  2614. *
  2615. * 参数: pThreadPool -- 线程池对象
  2616. * dwThreadID -- 工作线程 ID
  2617. * 返回值: 无
  2618. */
  2619. virtual void OnWorkerThreadEnd(IHPThreadPool* pThreadPool, THR_ID dwThreadID) = 0;
  2620. public:
  2621. virtual ~IHPThreadPoolListener() {};
  2622. };
  2623. /************************************************************************
  2624. 名称:线程池监听器抽象基类
  2625. 描述:定义某些事件的默认处理方法(忽略事件)
  2626. ************************************************************************/
  2627. class CHPThreadPoolListener : public IHPThreadPoolListener
  2628. {
  2629. public:
  2630. virtual void OnStartup(IHPThreadPool* pThreadPool) override {}
  2631. virtual void OnShutdown(IHPThreadPool* pThreadPool) override {}
  2632. virtual void OnWorkerThreadStart(IHPThreadPool* pThreadPool, THR_ID dwThreadID) override {}
  2633. virtual void OnWorkerThreadEnd(IHPThreadPool* pThreadPool, THR_ID dwThreadID) override {}
  2634. };
  2635. /************************************************************************
  2636. 名称:压缩器接口
  2637. 描述:定义压缩器的所有操作方法和属性访问方法
  2638. ************************************************************************/
  2639. class IHPCompressor
  2640. {
  2641. public:
  2642. /***********************************************************************/
  2643. /***************************** 组件操作方法 *****************************/
  2644. /*
  2645. * 名称:执行压缩
  2646. * 描述:可循环调用以压缩流式或分段数据
  2647. *
  2648. * 参数: pData -- 待压缩数据缓冲区
  2649. * iLength -- 待压缩数据长度
  2650. * bLast -- 是否最后一段待压缩数据
  2651. * pContext -- 压缩回调函数 Fn_CompressDataCallback 的上下文参数
  2652. *
  2653. * 返回值: TRUE -- 成功
  2654. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2655. */
  2656. virtual BOOL Process(const BYTE* pData, int iLength, BOOL bLast, PVOID pContext = nullptr) = 0;
  2657. /*
  2658. * 名称:执行压缩
  2659. * 描述:可循环调用以压缩流式或分段数据
  2660. *
  2661. * 参数: pData -- 待压缩数据缓冲区
  2662. * iLength -- 待压缩数据长度
  2663. * bLast -- 是否最后一段待压缩数据
  2664. * bFlush -- 是否强制刷新(强制刷新会降低压缩效率,但可对数据进行分段压缩)
  2665. * pContext -- 压缩回调函数 Fn_CompressDataCallback 的上下文参数
  2666. *
  2667. * 返回值: TRUE -- 成功
  2668. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2669. */
  2670. virtual BOOL ProcessEx(const BYTE* pData, int iLength, BOOL bLast, BOOL bFlush = FALSE, PVOID pContext = nullptr) = 0;
  2671. /* 重置压缩器 */
  2672. virtual BOOL Reset() = 0;
  2673. /***********************************************************************/
  2674. /***************************** 属性访问方法 *****************************/
  2675. /* 检测压缩器是否可用 */
  2676. virtual BOOL IsValid() = 0;
  2677. public:
  2678. virtual ~IHPCompressor() = default;
  2679. };
  2680. /************************************************************************
  2681. 名称:解压器接口
  2682. 描述:定义解压器的所有操作方法和属性访问方法
  2683. ************************************************************************/
  2684. class IHPDecompressor
  2685. {
  2686. public:
  2687. /***********************************************************************/
  2688. /***************************** 组件操作方法 *****************************/
  2689. /*
  2690. * 名称:执行解压
  2691. * 描述:可循环调用以解压流式或分段数据
  2692. *
  2693. * 参数: pData -- 待解压数据缓冲区
  2694. * iLength -- 待解压数据长度
  2695. * pContext -- 解压回调函数 Fn_DecompressDataCallback 的上下文参数
  2696. *
  2697. * 返回值: TRUE -- 成功
  2698. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2699. */
  2700. virtual BOOL Process(const BYTE* pData, int iLength, PVOID pContext = nullptr) = 0;
  2701. /* 重置解压器 */
  2702. virtual BOOL Reset() = 0;
  2703. public:
  2704. /***********************************************************************/
  2705. /***************************** 属性访问方法 *****************************/
  2706. /* 检测解压器是否可用 */
  2707. virtual BOOL IsValid() = 0;
  2708. public:
  2709. virtual ~IHPDecompressor() = default;
  2710. };