HPSocket4C.h 156 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838
  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. /******************************************************************************
  24. Module: HPSocket for C
  25. Desc: 导出纯 C 函数,让其它语言(如:C / C# / Delphi 等)能方便地使用 HPSocket
  26. Usage:
  27. 方法一:
  28. --------------------------------------------------------------------------------------
  29. 0. (C/C++ 程序)包含 HPTypeDef.h / HPSocket4C.h 头文件
  30. 1. 调用 ::Create_HP_XxxListener() 函数创建监听器对象
  31. 2. 调用 ::Create_HP_Xxx(pListener) 函数创建 HPSocket 对象
  32. 3. 调用 ::HP_Set_FN_Xxx_OnYyy(pListener, ...) 函数设置监听器的回调函数
  33. 4. 调用相关导出函数操作 HPSocket 对象
  34. 5. ...... ......
  35. 6. 调用 ::Destroy_HP_Xxx(pSocket) 函数销毁 HPSocket 对象
  36. 7. 调用 ::Destroy_HP_XxxListener(pListener) 函数销毁监听器对象
  37. 方法二:
  38. --------------------------------------------------------------------------------------
  39. 1. 应用程序把需要用到的导出函数封装到特定语言的包装类中
  40. 2. 通过包装类封装后,以面向对象的方式使用 HPSocket
  41. Release:
  42. <-- 动态链接库 -->
  43. 1. x86/HPSocket4C.dll - (32位/MBCS/Release)
  44. 2. x86/HPSocket4C_D.dll - (32位/MBCS/DeBug)
  45. 3. x86/HPSocket4C_U.dll - (32位/UNICODE/Release)
  46. 4. x86/HPSocket4C_UD.dll - (32位/UNICODE/DeBug)
  47. 5. x64/HPSocket4C.dll - (64位/MBCS/Release)
  48. 6. x64/HPSocket4C_D.dll - (64位/MBCS/DeBug)
  49. 7. x64/HPSocket4C_U.dll - (64位/UNICODE/Release)
  50. 8. x64/HPSocket4C_UD.dll - (64位/UNICODE/DeBug)
  51. <-- 静态链接库 -->
  52. !!注意!!:使用 HPSocket 静态库时,需要在工程属性中定义预处理宏 -> HPSOCKET_STATIC_LIB
  53. 1. x86/static/HPSocket4C.lib - (32位/MBCS/Release)
  54. 2. x86/static/HPSocket4C_D.lib - (32位/MBCS/DeBug)
  55. 3. x86/static/HPSocket4C_U.lib - (32位/UNICODE/Release)
  56. 4. x86/static/HPSocket4C_UD.lib - (32位/UNICODE/DeBug)
  57. 5. x64/static/HPSocket4C.lib - (64位/MBCS/Release)
  58. 6. x64/static/HPSocket4C_D.lib - (64位/MBCS/DeBug)
  59. 7. x64/static/HPSocket4C_U.lib - (64位/UNICODE/Release)
  60. 8. x64/static/HPSocket4C_UD.lib - (64位/UNICODE/DeBug)
  61. ******************************************************************************/
  62. #pragma once
  63. #include <winsock2.h>
  64. #include "HPTypeDef.h"
  65. /************************************************************************
  66. 名称:定义 Socket 对象指针类型别名
  67. 描述:把 Socket 对象指针定义为更直观的别名
  68. ************************************************************************/
  69. typedef PVOID HP_Object;
  70. typedef HP_Object HP_Server;
  71. typedef HP_Object HP_Agent;
  72. typedef HP_Object HP_Client;
  73. typedef HP_Object HP_Node;
  74. typedef HP_Object HP_TcpServer;
  75. typedef HP_Object HP_TcpAgent;
  76. typedef HP_Object HP_TcpClient;
  77. typedef HP_Object HP_PullSocket;
  78. typedef HP_Object HP_PullClient;
  79. typedef HP_Object HP_TcpPullServer;
  80. typedef HP_Object HP_TcpPullAgent;
  81. typedef HP_Object HP_TcpPullClient;
  82. typedef HP_Object HP_PackSocket;
  83. typedef HP_Object HP_PackClient;
  84. typedef HP_Object HP_TcpPackServer;
  85. typedef HP_Object HP_TcpPackAgent;
  86. typedef HP_Object HP_TcpPackClient;
  87. typedef HP_Object HP_ThreadPool;
  88. typedef HP_Object HP_Compressor;
  89. typedef HP_Object HP_Decompressor;
  90. typedef HP_Object HP_Listener;
  91. typedef HP_Object HP_ServerListener;
  92. typedef HP_Object HP_AgentListener;
  93. typedef HP_Object HP_ClientListener;
  94. typedef HP_Object HP_TcpServerListener;
  95. typedef HP_Object HP_TcpAgentListener;
  96. typedef HP_Object HP_TcpClientListener;
  97. typedef HP_Object HP_PullSocketListener;
  98. typedef HP_Object HP_PullClientListener;
  99. typedef HP_Object HP_TcpPullServerListener;
  100. typedef HP_Object HP_TcpPullAgentListener;
  101. typedef HP_Object HP_TcpPullClientListener;
  102. typedef HP_Object HP_PackSocketListener;
  103. typedef HP_Object HP_PackClientListener;
  104. typedef HP_Object HP_TcpPackServerListener;
  105. typedef HP_Object HP_TcpPackAgentListener;
  106. typedef HP_Object HP_TcpPackClientListener;
  107. typedef HP_Object HP_ThreadPoolListener;
  108. #ifdef _UDP_SUPPORT
  109. typedef HP_Object HP_UdpServer;
  110. typedef HP_Object HP_UdpClient;
  111. typedef HP_Object HP_UdpCast;
  112. typedef HP_Object HP_UdpNode;
  113. typedef HP_Object HP_UdpArqServer;
  114. typedef HP_Object HP_UdpArqClient;
  115. typedef HP_Object HP_UdpServerListener;
  116. typedef HP_Object HP_UdpClientListener;
  117. typedef HP_Object HP_UdpCastListener;
  118. typedef HP_Object HP_UdpNodeListener;
  119. typedef HP_Object HP_UdpArqServerListener;
  120. typedef HP_Object HP_UdpArqClientListener;
  121. #endif
  122. #ifdef _HTTP_SUPPORT
  123. typedef HP_Object HP_Http;
  124. typedef HP_Object HP_HttpServer;
  125. typedef HP_Object HP_HttpAgent;
  126. typedef HP_Object HP_HttpClient;
  127. typedef HP_Object HP_HttpSyncClient;
  128. typedef HP_Object HP_HttpServerListener;
  129. typedef HP_Object HP_HttpAgentListener;
  130. typedef HP_Object HP_HttpClientListener;
  131. #endif
  132. /*****************************************************************************************************************************************************/
  133. /****************************************************************** TCP/UDP Exports ******************************************************************/
  134. /*****************************************************************************************************************************************************/
  135. /****************************************************/
  136. /***************** TCP/UDP 回调函数 ******************/
  137. /* Server 回调函数 */
  138. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnPrepareListen) (HP_Server pSender, UINT_PTR soListen);
  139. // 如果为 TCP 连接,pClient为 SOCKET 句柄;如果为 UDP 连接,pClient为 SOCKADDR 指针;
  140. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnAccept) (HP_Server pSender, HP_CONNID dwConnID, UINT_PTR pClient);
  141. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnHandShake) (HP_Server pSender, HP_CONNID dwConnID);
  142. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnSend) (HP_Server pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  143. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnReceive) (HP_Server pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  144. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnPullReceive) (HP_Server pSender, HP_CONNID dwConnID, int iLength);
  145. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnClose) (HP_Server pSender, HP_CONNID dwConnID, En_HP_SocketOperation enOperation, int iErrorCode);
  146. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Server_OnShutdown) (HP_Server pSender);
  147. /* Agent 回调函数 */
  148. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnPrepareConnect) (HP_Agent pSender, HP_CONNID dwConnID, UINT_PTR socket);
  149. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnConnect) (HP_Agent pSender, HP_CONNID dwConnID);
  150. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnHandShake) (HP_Agent pSender, HP_CONNID dwConnID);
  151. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnSend) (HP_Agent pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  152. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnReceive) (HP_Agent pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  153. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnPullReceive) (HP_Agent pSender, HP_CONNID dwConnID, int iLength);
  154. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnClose) (HP_Agent pSender, HP_CONNID dwConnID, En_HP_SocketOperation enOperation, int iErrorCode);
  155. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Agent_OnShutdown) (HP_Agent pSender);
  156. /* Client 回调函数 */
  157. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Client_OnPrepareConnect) (HP_Client pSender, HP_CONNID dwConnID, UINT_PTR socket);
  158. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Client_OnConnect) (HP_Client pSender, HP_CONNID dwConnID);
  159. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Client_OnHandShake) (HP_Client pSender, HP_CONNID dwConnID);
  160. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Client_OnSend) (HP_Client pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  161. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Client_OnReceive) (HP_Client pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  162. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Client_OnPullReceive) (HP_Client pSender, HP_CONNID dwConnID, int iLength);
  163. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Client_OnClose) (HP_Client pSender, HP_CONNID dwConnID, En_HP_SocketOperation enOperation, int iErrorCode);
  164. #ifdef _UDP_SUPPORT
  165. /* UdpNode 回调函数 */
  166. typedef En_HP_HandleResult (__HP_CALL *HP_FN_UdpNode_OnPrepareListen) (HP_UdpNode pSender, UINT_PTR soListen);
  167. typedef En_HP_HandleResult (__HP_CALL *HP_FN_UdpNode_OnSend) (HP_UdpNode pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength);
  168. typedef En_HP_HandleResult (__HP_CALL *HP_FN_UdpNode_OnReceive) (HP_UdpNode pSender, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength);
  169. typedef En_HP_HandleResult (__HP_CALL *HP_FN_UdpNode_OnError) (HP_UdpNode pSender, En_HP_SocketOperation enOperation, int iErrorCode, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pData, int iLength);
  170. typedef En_HP_HandleResult (__HP_CALL *HP_FN_UdpNode_OnShutdown) (HP_UdpNode pSender);
  171. #endif
  172. /****************************************************/
  173. /*************** TCP/UDP 对象创建函数 ****************/
  174. // 创建 HP_TcpServer 对象
  175. HPSOCKET_API HP_TcpServer __HP_CALL Create_HP_TcpServer(HP_TcpServerListener pListener);
  176. // 创建 HP_TcpAgent 对象
  177. HPSOCKET_API HP_TcpAgent __HP_CALL Create_HP_TcpAgent(HP_TcpAgentListener pListener);
  178. // 创建 HP_TcpClient 对象
  179. HPSOCKET_API HP_TcpClient __HP_CALL Create_HP_TcpClient(HP_TcpClientListener pListener);
  180. // 创建 HP_TcpPullServer 对象
  181. HPSOCKET_API HP_TcpPullServer __HP_CALL Create_HP_TcpPullServer(HP_TcpPullServerListener pListener);
  182. // 创建 HP_TcpPullAgent 对象
  183. HPSOCKET_API HP_TcpPullAgent __HP_CALL Create_HP_TcpPullAgent(HP_TcpPullAgentListener pListener);
  184. // 创建 HP_TcpPullClient 对象
  185. HPSOCKET_API HP_TcpPullClient __HP_CALL Create_HP_TcpPullClient(HP_TcpPullClientListener pListener);
  186. // 创建 HP_TcpPackServer 对象
  187. HPSOCKET_API HP_TcpPackServer __HP_CALL Create_HP_TcpPackServer(HP_TcpServerListener pListener);
  188. // 创建 HP_TcpPackAgent 对象
  189. HPSOCKET_API HP_TcpPackAgent __HP_CALL Create_HP_TcpPackAgent(HP_TcpAgentListener pListener);
  190. // 创建 HP_TcpPackClient 对象
  191. HPSOCKET_API HP_TcpPackClient __HP_CALL Create_HP_TcpPackClient(HP_TcpClientListener pListener);
  192. // 销毁 HP_TcpServer 对象
  193. HPSOCKET_API void __HP_CALL Destroy_HP_TcpServer(HP_TcpServer pServer);
  194. // 销毁 HP_TcpAgent 对象
  195. HPSOCKET_API void __HP_CALL Destroy_HP_TcpAgent(HP_TcpAgent pAgent);
  196. // 销毁 HP_TcpClient 对象
  197. HPSOCKET_API void __HP_CALL Destroy_HP_TcpClient(HP_TcpClient pClient);
  198. // 销毁 HP_TcpPullServer 对象
  199. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPullServer(HP_TcpPullServer pServer);
  200. // 销毁 HP_TcpPullAgent 对象
  201. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPullAgent(HP_TcpPullAgent pAgent);
  202. // 销毁 HP_TcpPullClient 对象
  203. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPullClient(HP_TcpPullClient pClient);
  204. // 销毁 HP_TcpPackServer 对象
  205. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPackServer(HP_TcpPackServer pServer);
  206. // 销毁 HP_TcpPackAgent 对象
  207. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPackAgent(HP_TcpPackAgent pAgent);
  208. // 销毁 HP_TcpPackClient 对象
  209. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPackClient(HP_TcpPackClient pClient);
  210. // 创建 HP_TcpServerListener 对象
  211. HPSOCKET_API HP_TcpServerListener __HP_CALL Create_HP_TcpServerListener();
  212. // 创建 HP_TcpAgentListener 对象
  213. HPSOCKET_API HP_TcpAgentListener __HP_CALL Create_HP_TcpAgentListener();
  214. // 创建 HP_TcpClientListener 对象
  215. HPSOCKET_API HP_TcpClientListener __HP_CALL Create_HP_TcpClientListener();
  216. // 创建 HP_TcpPullServerListener 对象
  217. HPSOCKET_API HP_TcpPullServerListener __HP_CALL Create_HP_TcpPullServerListener();
  218. // 创建 HP_TcpPullAgentListener 对象
  219. HPSOCKET_API HP_TcpPullAgentListener __HP_CALL Create_HP_TcpPullAgentListener();
  220. // 创建 HP_TcpPullClientListener 对象
  221. HPSOCKET_API HP_TcpPullClientListener __HP_CALL Create_HP_TcpPullClientListener();
  222. // 创建 HP_TcpPackServerListener 对象
  223. HPSOCKET_API HP_TcpPackServerListener __HP_CALL Create_HP_TcpPackServerListener();
  224. // 创建 HP_TcpPackAgentListener 对象
  225. HPSOCKET_API HP_TcpPackAgentListener __HP_CALL Create_HP_TcpPackAgentListener();
  226. // 创建 HP_TcpPackClientListener 对象
  227. HPSOCKET_API HP_TcpPackClientListener __HP_CALL Create_HP_TcpPackClientListener();
  228. // 销毁 HP_TcpServerListener 对象
  229. HPSOCKET_API void __HP_CALL Destroy_HP_TcpServerListener(HP_TcpServerListener pListener);
  230. // 销毁 HP_TcpAgentListener 对象
  231. HPSOCKET_API void __HP_CALL Destroy_HP_TcpAgentListener(HP_TcpAgentListener pListener);
  232. // 销毁 HP_TcpClientListener 对象
  233. HPSOCKET_API void __HP_CALL Destroy_HP_TcpClientListener(HP_TcpClientListener pListener);
  234. // 销毁 HP_TcpPullServerListener 对象
  235. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPullServerListener(HP_TcpPullServerListener pListener);
  236. // 销毁 HP_TcpPullAgentListener 对象
  237. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPullAgentListener(HP_TcpPullAgentListener pListener);
  238. // 销毁 HP_TcpPullClientListener 对象
  239. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPullClientListener(HP_TcpPullClientListener pListener);
  240. // 销毁 HP_TcpPackServerListener 对象
  241. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPackServerListener(HP_TcpPackServerListener pListener);
  242. // 销毁 HP_TcpPackAgentListener 对象
  243. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPackAgentListener(HP_TcpPackAgentListener pListener);
  244. // 销毁 HP_TcpPackClientListener 对象
  245. HPSOCKET_API void __HP_CALL Destroy_HP_TcpPackClientListener(HP_TcpPackClientListener pListener);
  246. #ifdef _UDP_SUPPORT
  247. // 创建 HP_UdpServer 对象
  248. HPSOCKET_API HP_UdpServer __HP_CALL Create_HP_UdpServer(HP_UdpServerListener pListener);
  249. // 创建 HP_UdpClient 对象
  250. HPSOCKET_API HP_UdpClient __HP_CALL Create_HP_UdpClient(HP_UdpClientListener pListener);
  251. // 创建 HP_UdpCast 对象
  252. HPSOCKET_API HP_UdpCast __HP_CALL Create_HP_UdpCast(HP_UdpCastListener pListener);
  253. // 创建 HP_UdpNode 对象
  254. HPSOCKET_API HP_UdpNode __HP_CALL Create_HP_UdpNode(HP_UdpNodeListener pListener);
  255. // 创建 HP_UdpArqServer 对象
  256. HPSOCKET_API HP_UdpArqServer __HP_CALL Create_HP_UdpArqServer(HP_UdpServerListener pListener);
  257. // 创建 HP_UdpArqClient 对象
  258. HPSOCKET_API HP_UdpArqClient __HP_CALL Create_HP_UdpArqClient(HP_UdpClientListener pListener);
  259. // 销毁 HP_UdpServer 对象
  260. HPSOCKET_API void __HP_CALL Destroy_HP_UdpServer(HP_UdpServer pServer);
  261. // 销毁 HP_UdpClient 对象
  262. HPSOCKET_API void __HP_CALL Destroy_HP_UdpClient(HP_UdpClient pClient);
  263. // 销毁 HP_UdpCast 对象
  264. HPSOCKET_API void __HP_CALL Destroy_HP_UdpCast(HP_UdpCast pCast);
  265. // 销毁 HP_UdpNode 对象
  266. HPSOCKET_API void __HP_CALL Destroy_HP_UdpNode(HP_UdpNode pNode);
  267. // 销毁 HP_UdpArqServer 对象
  268. HPSOCKET_API void __HP_CALL Destroy_HP_UdpArqServer(HP_UdpArqServer pServer);
  269. // 销毁 HP_UdpArqClient 对象
  270. HPSOCKET_API void __HP_CALL Destroy_HP_UdpArqClient(HP_UdpArqClient pClient);
  271. // 创建 HP_UdpServerListener 对象
  272. HPSOCKET_API HP_UdpServerListener __HP_CALL Create_HP_UdpServerListener();
  273. // 创建 HP_UdpClientListener 对象
  274. HPSOCKET_API HP_UdpClientListener __HP_CALL Create_HP_UdpClientListener();
  275. // 创建 HP_UdpCastListener 对象
  276. HPSOCKET_API HP_UdpCastListener __HP_CALL Create_HP_UdpCastListener();
  277. // 创建 HP_UdpNodeListener 对象
  278. HPSOCKET_API HP_UdpNodeListener __HP_CALL Create_HP_UdpNodeListener();
  279. // 创建 HP_UdpArqServerListener 对象
  280. HPSOCKET_API HP_UdpArqServerListener __HP_CALL Create_HP_UdpArqServerListener();
  281. // 创建 HP_UdpArqClientListener 对象
  282. HPSOCKET_API HP_UdpArqClientListener __HP_CALL Create_HP_UdpArqClientListener();
  283. // 销毁 HP_UdpServerListener 对象
  284. HPSOCKET_API void __HP_CALL Destroy_HP_UdpServerListener(HP_UdpServerListener pListener);
  285. // 销毁 HP_UdpClientListener 对象
  286. HPSOCKET_API void __HP_CALL Destroy_HP_UdpClientListener(HP_UdpClientListener pListener);
  287. // 销毁 HP_UdpCastListener 对象
  288. HPSOCKET_API void __HP_CALL Destroy_HP_UdpCastListener(HP_UdpCastListener pListener);
  289. // 销毁 HP_UdpNodeListener 对象
  290. HPSOCKET_API void __HP_CALL Destroy_HP_UdpNodeListener(HP_UdpNodeListener pListener);
  291. // 销毁 HP_UdpArqServerListener 对象
  292. HPSOCKET_API void __HP_CALL Destroy_HP_UdpArqServerListener(HP_UdpArqServerListener pListener);
  293. // 销毁 HP_UdpArqClientListener 对象
  294. HPSOCKET_API void __HP_CALL Destroy_HP_UdpArqClientListener(HP_UdpArqClientListener pListener);
  295. #endif
  296. /**********************************************************************************/
  297. /***************************** Server 回调函数设置方法 *****************************/
  298. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnPrepareListen(HP_ServerListener pListener , HP_FN_Server_OnPrepareListen fn);
  299. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnAccept(HP_ServerListener pListener , HP_FN_Server_OnAccept fn);
  300. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnHandShake(HP_ServerListener pListener , HP_FN_Server_OnHandShake fn);
  301. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnSend(HP_ServerListener pListener , HP_FN_Server_OnSend fn);
  302. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnReceive(HP_ServerListener pListener , HP_FN_Server_OnReceive fn);
  303. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnPullReceive(HP_ServerListener pListener , HP_FN_Server_OnPullReceive fn);
  304. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnClose(HP_ServerListener pListener , HP_FN_Server_OnClose fn);
  305. HPSOCKET_API void __HP_CALL HP_Set_FN_Server_OnShutdown(HP_ServerListener pListener , HP_FN_Server_OnShutdown fn);
  306. /**********************************************************************************/
  307. /****************************** Agent 回调函数设置方法 *****************************/
  308. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnPrepareConnect(HP_AgentListener pListener , HP_FN_Agent_OnPrepareConnect fn);
  309. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnConnect(HP_AgentListener pListener , HP_FN_Agent_OnConnect fn);
  310. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnHandShake(HP_AgentListener pListener , HP_FN_Agent_OnHandShake fn);
  311. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnSend(HP_AgentListener pListener , HP_FN_Agent_OnSend fn);
  312. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnReceive(HP_AgentListener pListener , HP_FN_Agent_OnReceive fn);
  313. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnPullReceive(HP_AgentListener pListener , HP_FN_Agent_OnPullReceive fn);
  314. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnClose(HP_AgentListener pListener , HP_FN_Agent_OnClose fn);
  315. HPSOCKET_API void __HP_CALL HP_Set_FN_Agent_OnShutdown(HP_AgentListener pListener , HP_FN_Agent_OnShutdown fn);
  316. /**********************************************************************************/
  317. /***************************** Client 回调函数设置方法 *****************************/
  318. HPSOCKET_API void __HP_CALL HP_Set_FN_Client_OnPrepareConnect(HP_ClientListener pListener , HP_FN_Client_OnPrepareConnect fn);
  319. HPSOCKET_API void __HP_CALL HP_Set_FN_Client_OnConnect(HP_ClientListener pListener , HP_FN_Client_OnConnect fn);
  320. HPSOCKET_API void __HP_CALL HP_Set_FN_Client_OnHandShake(HP_ClientListener pListener , HP_FN_Client_OnHandShake fn);
  321. HPSOCKET_API void __HP_CALL HP_Set_FN_Client_OnSend(HP_ClientListener pListener , HP_FN_Client_OnSend fn);
  322. HPSOCKET_API void __HP_CALL HP_Set_FN_Client_OnReceive(HP_ClientListener pListener , HP_FN_Client_OnReceive fn);
  323. HPSOCKET_API void __HP_CALL HP_Set_FN_Client_OnPullReceive(HP_ClientListener pListener , HP_FN_Client_OnPullReceive fn);
  324. HPSOCKET_API void __HP_CALL HP_Set_FN_Client_OnClose(HP_ClientListener pListener , HP_FN_Client_OnClose fn);
  325. #ifdef _UDP_SUPPORT
  326. /**********************************************************************************/
  327. /***************************** UdpNode 回调函数设置方法 *****************************/
  328. HPSOCKET_API void __HP_CALL HP_Set_FN_UdpNode_OnPrepareListen(HP_UdpNodeListener pListener , HP_FN_UdpNode_OnPrepareListen fn);
  329. HPSOCKET_API void __HP_CALL HP_Set_FN_UdpNode_OnSend(HP_UdpNodeListener pListener , HP_FN_UdpNode_OnSend fn);
  330. HPSOCKET_API void __HP_CALL HP_Set_FN_UdpNode_OnReceive(HP_UdpNodeListener pListener , HP_FN_UdpNode_OnReceive fn);
  331. HPSOCKET_API void __HP_CALL HP_Set_FN_UdpNode_OnError(HP_UdpNodeListener pListener , HP_FN_UdpNode_OnError fn);
  332. HPSOCKET_API void __HP_CALL HP_Set_FN_UdpNode_OnShutdown(HP_UdpNodeListener pListener , HP_FN_UdpNode_OnShutdown fn);
  333. #endif
  334. /**************************************************************************/
  335. /***************************** Server 操作方法 *****************************/
  336. /*
  337. * 名称:启动通信组件
  338. * 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据
  339. *
  340. * 参数: lpszBindAddress -- 监听地址
  341. * usPort -- 监听端口
  342. * 返回值: TRUE -- 成功
  343. * FALSE -- 失败,可通过 HP_Server_GetLastError() 获取错误代码
  344. */
  345. HPSOCKET_API BOOL __HP_CALL HP_Server_Start(HP_Server pServer, LPCTSTR lpszBindAddress, USHORT usPort);
  346. /*
  347. * 名称:关闭通信组件
  348. * 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源
  349. *
  350. * 参数:
  351. * 返回值: TRUE -- 成功
  352. * FALSE -- 失败,可通过 HP_Server_GetLastError() 获取错误代码
  353. */
  354. HPSOCKET_API BOOL __HP_CALL HP_Server_Stop(HP_Server pServer);
  355. /*
  356. * 名称:等待
  357. * 描述:等待通信组件停止运行
  358. *
  359. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  360. * 返回值: TRUE -- 成功
  361. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  362. */
  363. HPSOCKET_API BOOL __HP_CALL HP_Server_Wait(HP_Server pServer, DWORD dwMilliseconds);
  364. /*
  365. * 名称:发送数据
  366. * 描述:向指定连接发送数据
  367. *
  368. * 参数: dwConnID -- 连接 ID
  369. * pBuffer -- 发送缓冲区
  370. * iLength -- 发送缓冲区长度
  371. * 返回值: TRUE -- 成功
  372. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  373. */
  374. HPSOCKET_API BOOL __HP_CALL HP_Server_Send(HP_Server pServer, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength);
  375. /*
  376. * 名称:发送数据
  377. * 描述:向指定连接发送数据
  378. *
  379. * 参数: dwConnID -- 连接 ID
  380. * pBuffer -- 发送缓冲区
  381. * iLength -- 发送缓冲区长度
  382. * iOffset -- 发送缓冲区指针偏移量
  383. * 返回值: TRUE -- 成功
  384. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  385. */
  386. HPSOCKET_API BOOL __HP_CALL HP_Server_SendPart(HP_Server pServer, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset);
  387. /*
  388. * 名称:发送多组数据
  389. * 描述:向指定连接发送多组数据
  390. * TCP - 顺序发送所有数据包
  391. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  392. *
  393. * 参数: dwConnID -- 连接 ID
  394. * pBuffers -- 发送缓冲区数组
  395. * iCount -- 发送缓冲区数目
  396. * 返回值: TRUE -- 成功
  397. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  398. */
  399. HPSOCKET_API BOOL __HP_CALL HP_Server_SendPackets(HP_Server pServer, HP_CONNID dwConnID, const WSABUF pBuffers[], int iCount);
  400. /*
  401. * 名称:暂停/恢复接收
  402. * 描述:暂停/恢复某个连接的数据接收工作
  403. *
  404. * 参数: dwConnID -- 连接 ID
  405. * bPause -- TRUE - 暂停, FALSE - 恢复
  406. * 返回值: TRUE -- 成功
  407. * FALSE -- 失败
  408. */
  409. HPSOCKET_API BOOL __HP_CALL HP_Server_PauseReceive(HP_Server pServer, HP_CONNID dwConnID, BOOL bPause);
  410. /*
  411. * 名称:断开连接
  412. * 描述:断开与某个客户端的连接
  413. *
  414. * 参数: dwConnID -- 连接 ID
  415. * bForce -- 是否强制断开连接
  416. * 返回值: TRUE -- 成功
  417. * FALSE -- 失败
  418. */
  419. HPSOCKET_API BOOL __HP_CALL HP_Server_Disconnect(HP_Server pServer, HP_CONNID dwConnID, BOOL bForce);
  420. /*
  421. * 名称:断开超时连接
  422. * 描述:断开超过指定时长的连接
  423. *
  424. * 参数: dwPeriod -- 时长(毫秒)
  425. * bForce -- 是否强制断开连接
  426. * 返回值: TRUE -- 成功
  427. * FALSE -- 失败
  428. */
  429. HPSOCKET_API BOOL __HP_CALL HP_Server_DisconnectLongConnections(HP_Server pServer, DWORD dwPeriod, BOOL bForce);
  430. /*
  431. * 名称:断开静默连接
  432. * 描述:断开超过指定时长的静默连接
  433. *
  434. * 参数: dwPeriod -- 时长(毫秒)
  435. * bForce -- 是否强制断开连接
  436. * 返回值: TRUE -- 成功
  437. * FALSE -- 失败
  438. */
  439. HPSOCKET_API BOOL __HP_CALL HP_Server_DisconnectSilenceConnections(HP_Server pServer, DWORD dwPeriod, BOOL bForce);
  440. /******************************************************************************/
  441. /***************************** Server 属性访问方法 *****************************/
  442. /*
  443. * 名称:设置连接的附加数据
  444. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定
  445. *
  446. * 参数: dwConnID -- 连接 ID
  447. * pv -- 数据
  448. * 返回值: TRUE -- 成功
  449. * FALSE -- 失败(无效的连接 ID)
  450. */
  451. HPSOCKET_API BOOL __HP_CALL HP_Server_SetConnectionExtra(HP_Server pServer, HP_CONNID dwConnID, PVOID pExtra);
  452. /*
  453. * 名称:获取连接的附加数据
  454. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定
  455. *
  456. * 参数: dwConnID -- 连接 ID
  457. * ppv -- 数据指针
  458. * 返回值: TRUE -- 成功
  459. * FALSE -- 失败(无效的连接 ID)
  460. */
  461. HPSOCKET_API BOOL __HP_CALL HP_Server_GetConnectionExtra(HP_Server pServer, HP_CONNID dwConnID, PVOID* ppExtra);
  462. /* 检测是否为安全连接(SSL/HTTPS) */
  463. HPSOCKET_API BOOL __HP_CALL HP_Server_IsSecure(HP_Server pServer);
  464. /* 检查通信组件是否已启动 */
  465. HPSOCKET_API BOOL __HP_CALL HP_Server_HasStarted(HP_Server pServer);
  466. /* 查看通信组件当前状态 */
  467. HPSOCKET_API En_HP_ServiceState __HP_CALL HP_Server_GetState(HP_Server pServer);
  468. /* 获取最近一次失败操作的错误代码 */
  469. HPSOCKET_API En_HP_SocketError __HP_CALL HP_Server_GetLastError(HP_Server pServer);
  470. /* 获取最近一次失败操作的错误描述 */
  471. HPSOCKET_API LPCTSTR __HP_CALL HP_Server_GetLastErrorDesc(HP_Server pServer);
  472. /* 获取连接中未发出数据的长度 */
  473. HPSOCKET_API BOOL __HP_CALL HP_Server_GetPendingDataLength(HP_Server pServer, HP_CONNID dwConnID, int* piPending);
  474. /* 获取连接的数据接收状态 */
  475. HPSOCKET_API BOOL __HP_CALL HP_Server_IsPauseReceive(HP_Server pServer, HP_CONNID dwConnID, BOOL* pbPaused);
  476. /* 检测是否有效连接 */
  477. HPSOCKET_API BOOL __HP_CALL HP_Server_IsConnected(HP_Server pServer, HP_CONNID dwConnID);
  478. /* 获取客户端连接数 */
  479. HPSOCKET_API DWORD __HP_CALL HP_Server_GetConnectionCount(HP_Server pServer);
  480. /* 获取所有连接的 HP_CONNID */
  481. HPSOCKET_API BOOL __HP_CALL HP_Server_GetAllConnectionIDs(HP_Server pServer, HP_CONNID pIDs[], DWORD* pdwCount);
  482. /* 获取某个客户端连接时长(毫秒) */
  483. HPSOCKET_API BOOL __HP_CALL HP_Server_GetConnectPeriod(HP_Server pServer, HP_CONNID dwConnID, DWORD* pdwPeriod);
  484. /* 获取某个连接静默时间(毫秒) */
  485. HPSOCKET_API BOOL __HP_CALL HP_Server_GetSilencePeriod(HP_Server pServer, HP_CONNID dwConnID, DWORD* pdwPeriod);
  486. /* 获取监听 Socket 的地址信息 */
  487. HPSOCKET_API BOOL __HP_CALL HP_Server_GetListenAddress(HP_Server pServer, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  488. /* 获取某个连接的本地地址信息 */
  489. HPSOCKET_API BOOL __HP_CALL HP_Server_GetLocalAddress(HP_Server pServer, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  490. /* 获取某个连接的远程地址信息 */
  491. HPSOCKET_API BOOL __HP_CALL HP_Server_GetRemoteAddress(HP_Server pServer, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  492. /* 设置地址重用选项 */
  493. HPSOCKET_API void __HP_CALL HP_Server_SetReuseAddressPolicy(HP_Server pServer, En_HP_ReuseAddressPolicy enReusePolicy);
  494. /* 设置数据发送策略 */
  495. HPSOCKET_API void __HP_CALL HP_Server_SetSendPolicy(HP_Server pServer, En_HP_SendPolicy enSendPolicy);
  496. /* 设置 OnSend 事件同步策略(默认:OSSP_NONE,不同步) */
  497. HPSOCKET_API void __HP_CALL HP_Server_SetOnSendSyncPolicy(HP_Server pServer, En_HP_OnSendSyncPolicy enSyncPolicy);
  498. /* 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) */
  499. HPSOCKET_API void __HP_CALL HP_Server_SetFreeSocketObjLockTime(HP_Server pServer, DWORD dwFreeSocketObjLockTime);
  500. /* 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2) */
  501. HPSOCKET_API void __HP_CALL HP_Server_SetFreeSocketObjPool(HP_Server pServer, DWORD dwFreeSocketObjPool);
  502. /* 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) */
  503. HPSOCKET_API void __HP_CALL HP_Server_SetFreeBufferObjPool(HP_Server pServer, DWORD dwFreeBufferObjPool);
  504. /* 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍) */
  505. HPSOCKET_API void __HP_CALL HP_Server_SetFreeSocketObjHold(HP_Server pServer, DWORD dwFreeSocketObjHold);
  506. /* 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) */
  507. HPSOCKET_API void __HP_CALL HP_Server_SetFreeBufferObjHold(HP_Server pServer, DWORD dwFreeBufferObjHold);
  508. /* 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)*/
  509. HPSOCKET_API void __HP_CALL HP_Server_SetMaxConnectionCount(HP_Server pServer, DWORD dwMaxConnectionCount);
  510. /* 设置工作线程数量(通常设置为 2 * CPU + 2) */
  511. HPSOCKET_API void __HP_CALL HP_Server_SetWorkerThreadCount(HP_Server pServer, DWORD dwWorkerThreadCount);
  512. /* 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE) */
  513. HPSOCKET_API void __HP_CALL HP_Server_SetMarkSilence(HP_Server pServer, BOOL bMarkSilence);
  514. /* 获取地址重用选项 */
  515. HPSOCKET_API En_HP_ReuseAddressPolicy __HP_CALL HP_Server_GetReuseAddressPolicy(HP_Server pServer);
  516. /* 获取数据发送策略 */
  517. HPSOCKET_API En_HP_SendPolicy __HP_CALL HP_Server_GetSendPolicy(HP_Server pServer);
  518. /* 获取 OnSend 事件同步策略 */
  519. HPSOCKET_API En_HP_OnSendSyncPolicy __HP_CALL HP_Server_GetOnSendSyncPolicy(HP_Server pServer);
  520. /* 获取 Socket 缓存对象锁定时间 */
  521. HPSOCKET_API DWORD __HP_CALL HP_Server_GetFreeSocketObjLockTime(HP_Server pServer);
  522. /* 获取 Socket 缓存池大小 */
  523. HPSOCKET_API DWORD __HP_CALL HP_Server_GetFreeSocketObjPool(HP_Server pServer);
  524. /* 获取内存块缓存池大小 */
  525. HPSOCKET_API DWORD __HP_CALL HP_Server_GetFreeBufferObjPool(HP_Server pServer);
  526. /* 获取 Socket 缓存池回收阀值 */
  527. HPSOCKET_API DWORD __HP_CALL HP_Server_GetFreeSocketObjHold(HP_Server pServer);
  528. /* 获取内存块缓存池回收阀值 */
  529. HPSOCKET_API DWORD __HP_CALL HP_Server_GetFreeBufferObjHold(HP_Server pServer);
  530. /* 获取最大连接数 */
  531. HPSOCKET_API DWORD __HP_CALL HP_Server_GetMaxConnectionCount(HP_Server pServer);
  532. /* 获取工作线程数量 */
  533. HPSOCKET_API DWORD __HP_CALL HP_Server_GetWorkerThreadCount(HP_Server pServer);
  534. /* 检测是否标记静默时间 */
  535. HPSOCKET_API BOOL __HP_CALL HP_Server_IsMarkSilence(HP_Server pServer);
  536. /**********************************************************************************/
  537. /******************************* TCP Server 操作方法 *******************************/
  538. /*
  539. * 名称:发送小文件
  540. * 描述:向指定连接发送 4096 KB 以下的小文件
  541. *
  542. * 参数: dwConnID -- 连接 ID
  543. * lpszFileName -- 文件路径
  544. * pHead -- 头部附加数据
  545. * pTail -- 尾部附加数据
  546. * 返回值: TRUE -- 成功
  547. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  548. */
  549. HPSOCKET_API BOOL __HP_CALL HP_TcpServer_SendSmallFile(HP_Server pServer, HP_CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail);
  550. /**********************************************************************************/
  551. /***************************** TCP Server 属性访问方法 *****************************/
  552. /* 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置) */
  553. HPSOCKET_API void __HP_CALL HP_TcpServer_SetSocketListenQueue(HP_TcpServer pServer, DWORD dwSocketListenQueue);
  554. /* 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多) */
  555. HPSOCKET_API void __HP_CALL HP_TcpServer_SetAcceptSocketCount(HP_TcpServer pServer, DWORD dwAcceptSocketCount);
  556. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) */
  557. HPSOCKET_API void __HP_CALL HP_TcpServer_SetSocketBufferSize(HP_TcpServer pServer, DWORD dwSocketBufferSize);
  558. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  559. HPSOCKET_API void __HP_CALL HP_TcpServer_SetKeepAliveTime(HP_TcpServer pServer, DWORD dwKeepAliveTime);
  560. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  561. HPSOCKET_API void __HP_CALL HP_TcpServer_SetKeepAliveInterval(HP_TcpServer pServer, DWORD dwKeepAliveInterval);
  562. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  563. HPSOCKET_API void __HP_CALL HP_TcpServer_SetNoDelay(HP_TcpServer pServer, BOOL bNoDelay);
  564. /* 获取 Accept 预投递数量 */
  565. HPSOCKET_API DWORD __HP_CALL HP_TcpServer_GetAcceptSocketCount(HP_TcpServer pServer);
  566. /* 获取通信数据缓冲区大小 */
  567. HPSOCKET_API DWORD __HP_CALL HP_TcpServer_GetSocketBufferSize(HP_TcpServer pServer);
  568. /* 获取监听 Socket 的等候队列大小 */
  569. HPSOCKET_API DWORD __HP_CALL HP_TcpServer_GetSocketListenQueue(HP_TcpServer pServer);
  570. /* 获取正常心跳包间隔 */
  571. HPSOCKET_API DWORD __HP_CALL HP_TcpServer_GetKeepAliveTime(HP_TcpServer pServer);
  572. /* 获取异常心跳包间隔 */
  573. HPSOCKET_API DWORD __HP_CALL HP_TcpServer_GetKeepAliveInterval(HP_TcpServer pServer);
  574. /* 检查是否开启 nodelay 模式 */
  575. HPSOCKET_API BOOL __HP_CALL HP_TcpServer_IsNoDelay(HP_TcpServer pServer);
  576. #ifdef _UDP_SUPPORT
  577. /**********************************************************************************/
  578. /***************************** UDP Server 属性访问方法 *****************************/
  579. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  580. HPSOCKET_API void __HP_CALL HP_UdpServer_SetMaxDatagramSize(HP_UdpServer pServer, DWORD dwMaxDatagramSize);
  581. /* 获取数据报文最大长度 */
  582. HPSOCKET_API DWORD __HP_CALL HP_UdpServer_GetMaxDatagramSize(HP_UdpServer pServer);
  583. /* 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小) */
  584. HPSOCKET_API void __HP_CALL HP_UdpServer_SetPostReceiveCount(HP_UdpServer pServer, DWORD dwPostReceiveCount);
  585. /* 获取 Receive 预投递数量 */
  586. HPSOCKET_API DWORD __HP_CALL HP_UdpServer_GetPostReceiveCount(HP_UdpServer pServer);
  587. /* 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) */
  588. HPSOCKET_API void __HP_CALL HP_UdpServer_SetDetectAttempts(HP_UdpServer pServer, DWORD dwDetectAttempts);
  589. /* 设置监测包发送间隔(毫秒,0 不发送监测包) */
  590. HPSOCKET_API void __HP_CALL HP_UdpServer_SetDetectInterval(HP_UdpServer pServer, DWORD dwDetectInterval);
  591. /* 获取心跳检查次数 */
  592. HPSOCKET_API DWORD __HP_CALL HP_UdpServer_GetDetectAttempts(HP_UdpServer pServer);
  593. /* 获取心跳检查间隔 */
  594. HPSOCKET_API DWORD __HP_CALL HP_UdpServer_GetDetectInterval(HP_UdpServer pServer);
  595. /**********************************************************************************/
  596. /*************************** UDP ARQ Server 属性访问方法 ***************************/
  597. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  598. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetNoDelay(HP_UdpArqServer pServer, BOOL bNoDelay);
  599. /* 设置是否关闭拥塞控制(默认:FALSE,不关闭) */
  600. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetTurnoffCongestCtrl(HP_UdpArqServer pServer, BOOL bTurnOff);
  601. /* 设置数据刷新间隔(毫秒,默认:60) */
  602. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetFlushInterval(HP_UdpArqServer pServer, DWORD dwFlushInterval);
  603. /* 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传) */
  604. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetResendByAcks(HP_UdpArqServer pServer, DWORD dwResendByAcks);
  605. /* 设置发送窗口大小(数据包数量,默认:128) */
  606. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetSendWndSize(HP_UdpArqServer pServer, DWORD dwSendWndSize);
  607. /* 设置接收窗口大小(数据包数量,默认:512) */
  608. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetRecvWndSize(HP_UdpArqServer pServer, DWORD dwRecvWndSize);
  609. /* 设置最小重传超时时间(毫秒,默认:30) */
  610. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetMinRto(HP_UdpArqServer pServer, DWORD dwMinRto);
  611. /* 设置快速握手次数限制(默认:5,如果为 0 则不限制) */
  612. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetFastLimit(HP_UdpArqServer pServer, DWORD dwFastLimit);
  613. /* 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致) */
  614. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetMaxTransUnit(HP_UdpArqServer pServer, DWORD dwMaxTransUnit);
  615. /* 设置最大数据包大小(默认:4096) */
  616. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetMaxMessageSize(HP_UdpArqServer pServer, DWORD dwMaxMessageSize);
  617. /* 设置握手超时时间(毫秒,默认:5000) */
  618. HPSOCKET_API void __HP_CALL HP_UdpArqServer_SetHandShakeTimeout(HP_UdpArqServer pServer, DWORD dwHandShakeTimeout);
  619. /* 检测是否开启 nodelay 模式 */
  620. HPSOCKET_API BOOL __HP_CALL HP_UdpArqServer_IsNoDelay(HP_UdpArqServer pServer);
  621. /* 检测是否关闭拥塞控制 */
  622. HPSOCKET_API BOOL __HP_CALL HP_UdpArqServer_IsTurnoffCongestCtrl(HP_UdpArqServer pServer);
  623. /* 获取数据刷新间隔 */
  624. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetFlushInterval(HP_UdpArqServer pServer);
  625. /* 获取快速重传 ACK 跨越次数 */
  626. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetResendByAcks(HP_UdpArqServer pServer);
  627. /* 获取发送窗口大小 */
  628. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetSendWndSize(HP_UdpArqServer pServer);
  629. /* 获取接收窗口大小 */
  630. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetRecvWndSize(HP_UdpArqServer pServer);
  631. /* 获取最小重传超时时间 */
  632. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetMinRto(HP_UdpArqServer pServer);
  633. /* 获取快速握手次数限制 */
  634. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetFastLimit(HP_UdpArqServer pServer);
  635. /* 获取最大传输单元 */
  636. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetMaxTransUnit(HP_UdpArqServer pServer);
  637. /* 获取最大数据包大小 */
  638. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetMaxMessageSize(HP_UdpArqServer pServer);
  639. /* 获取握手超时时间 */
  640. HPSOCKET_API DWORD __HP_CALL HP_UdpArqServer_GetHandShakeTimeout(HP_UdpArqServer pServer);
  641. /* 获取等待发送包数量 */
  642. HPSOCKET_API BOOL __HP_CALL HP_UdpArqServer_GetWaitingSendMessageCount(HP_UdpArqServer pServer, HP_CONNID dwConnID, int* piCount);
  643. #endif
  644. /**************************************************************************/
  645. /***************************** Agent 操作方法 *****************************/
  646. /*
  647. * 名称:启动通信组件
  648. * 描述:启动通信代理组件,启动完成后可开始连接远程服务器
  649. *
  650. * 参数: lpszBindAddress -- 绑定地址(默认:nullptr,绑定任意地址)
  651. * bAsyncConnect -- 是否采用异步 Connect
  652. * 返回值: TRUE -- 成功
  653. * FALSE -- 失败,可通过 HP_Agent_GetLastError() 获取错误代码
  654. */
  655. HPSOCKET_API BOOL __HP_CALL HP_Agent_Start(HP_Agent pAgent, LPCTSTR lpszBindAddress, BOOL bAsyncConnect);
  656. /*
  657. * 名称:关闭通信组件
  658. * 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源
  659. *
  660. * 参数:
  661. * 返回值: TRUE -- 成功
  662. * FALSE -- 失败,可通过 HP_Agent_GetLastError() 获取错误代码
  663. */
  664. HPSOCKET_API BOOL __HP_CALL HP_Agent_Stop(HP_Agent pAgent);
  665. /*
  666. * 名称:等待
  667. * 描述:等待通信组件停止运行
  668. *
  669. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  670. * 返回值: TRUE -- 成功
  671. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  672. */
  673. HPSOCKET_API BOOL __HP_CALL HP_Agent_Wait(HP_Agent pAgent, DWORD dwMilliseconds);
  674. /*
  675. * 名称:连接服务器
  676. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  677. *
  678. * 参数: lpszRemoteAddress -- 服务端地址
  679. * usPort -- 服务端端口
  680. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  681. * 返回值: TRUE -- 成功
  682. * FALSE -- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码
  683. */
  684. HPSOCKET_API BOOL __HP_CALL HP_Agent_Connect(HP_Agent pAgent, LPCTSTR lpszRemoteAddress, USHORT usPort, HP_CONNID* pdwConnID);
  685. /*
  686. * 名称:连接服务器
  687. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  688. *
  689. * 参数: lpszRemoteAddress -- 服务端地址
  690. * usPort -- 服务端端口
  691. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  692. * pExtra -- 连接附加数据(默认:nullptr)
  693. * 返回值: TRUE -- 成功
  694. * FALSE -- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码
  695. */
  696. HPSOCKET_API BOOL __HP_CALL HP_Agent_ConnectWithExtra(HP_Agent pAgent, LPCTSTR lpszRemoteAddress, USHORT usPort, HP_CONNID* pdwConnID, PVOID pExtra);
  697. /*
  698. * 名称:连接服务器
  699. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  700. *
  701. * 参数: lpszRemoteAddress -- 服务端地址
  702. * usPort -- 服务端端口
  703. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  704. * usLocalPort -- 本地端口(默认:0)
  705. * 返回值: TRUE -- 成功
  706. * FALSE -- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码
  707. */
  708. HPSOCKET_API BOOL __HP_CALL HP_Agent_ConnectWithLocalPort(HP_Agent pAgent, LPCTSTR lpszRemoteAddress, USHORT usPort, HP_CONNID* pdwConnID, USHORT usLocalPort);
  709. /*
  710. * 名称:连接服务器
  711. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  712. *
  713. * 参数: lpszRemoteAddress -- 服务端地址
  714. * usPort -- 服务端端口
  715. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  716. * lpszLocalAddress -- 本地地址(默认:nullptr,使用 Start() 方法中绑定的地址)
  717. * 返回值: TRUE -- 成功
  718. * FALSE -- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码
  719. */
  720. HPSOCKET_API BOOL __HP_CALL HP_Agent_ConnectWithLocalAddress(HP_Agent pAgent, LPCTSTR lpszRemoteAddress, USHORT usPort, HP_CONNID* pdwConnID, LPCTSTR lpszLocalAddress);
  721. /*
  722. * 名称:连接服务器
  723. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  724. *
  725. * 参数: lpszRemoteAddress -- 服务端地址
  726. * usPort -- 服务端端口
  727. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  728. * pExtra -- 连接附加数据(默认:nullptr)
  729. * usLocalPort -- 本地端口(默认:0)
  730. * 返回值: TRUE -- 成功
  731. * FALSE -- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码
  732. */
  733. HPSOCKET_API BOOL __HP_CALL HP_Agent_ConnectWithExtraAndLocalPort(HP_Agent pAgent, LPCTSTR lpszRemoteAddress, USHORT usPort, HP_CONNID* pdwConnID, PVOID pExtra, USHORT usLocalPort);
  734. /*
  735. * 名称:连接服务器
  736. * 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
  737. *
  738. * 参数: lpszRemoteAddress -- 服务端地址
  739. * usPort -- 服务端端口
  740. * pdwConnID -- 连接 ID(默认:nullptr,不获取连接 ID)
  741. * pExtra -- 连接附加数据(默认:nullptr)
  742. * usLocalPort -- 本地端口(默认:0)
  743. * lpszLocalAddress -- 本地地址(默认:nullptr,使用 Start() 方法中绑定的地址)
  744. * 返回值: TRUE -- 成功
  745. * FALSE -- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码
  746. */
  747. HPSOCKET_API BOOL __HP_CALL HP_Agent_ConnectWithExtraAndLocalAddressPort(HP_Agent pAgent, LPCTSTR lpszRemoteAddress, USHORT usPort, HP_CONNID* pdwConnID, PVOID pExtra, USHORT usLocalPort, LPCTSTR lpszLocalAddress);
  748. /*
  749. * 名称:发送数据
  750. * 描述:向指定连接发送数据
  751. *
  752. * 参数: dwConnID -- 连接 ID
  753. * pBuffer -- 发送缓冲区
  754. * iLength -- 发送缓冲区长度
  755. * 返回值: TRUE -- 成功
  756. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  757. */
  758. HPSOCKET_API BOOL __HP_CALL HP_Agent_Send(HP_Agent pAgent, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength);
  759. /*
  760. * 名称:发送数据
  761. * 描述:向指定连接发送数据
  762. *
  763. * 参数: dwConnID -- 连接 ID
  764. * pBuffer -- 发送缓冲区
  765. * iLength -- 发送缓冲区长度
  766. * iOffset -- 发送缓冲区指针偏移量
  767. * 返回值: TRUE -- 成功
  768. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  769. */
  770. HPSOCKET_API BOOL __HP_CALL HP_Agent_SendPart(HP_Agent pAgent, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset);
  771. /*
  772. * 名称:发送多组数据
  773. * 描述:向指定连接发送多组数据
  774. * TCP - 顺序发送所有数据包
  775. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  776. *
  777. * 参数: dwConnID -- 连接 ID
  778. * pBuffers -- 发送缓冲区数组
  779. * iCount -- 发送缓冲区数目
  780. * 返回值: TRUE -- 成功
  781. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  782. */
  783. HPSOCKET_API BOOL __HP_CALL HP_Agent_SendPackets(HP_Agent pAgent, HP_CONNID dwConnID, const WSABUF pBuffers[], int iCount);
  784. /*
  785. * 名称:暂停/恢复接收
  786. * 描述:暂停/恢复某个连接的数据接收工作
  787. *
  788. * 参数: dwConnID -- 连接 ID
  789. * bPause -- TRUE - 暂停, FALSE - 恢复
  790. * 返回值: TRUE -- 成功
  791. * FALSE -- 失败
  792. */
  793. HPSOCKET_API BOOL __HP_CALL HP_Agent_PauseReceive(HP_Agent pAgent, HP_CONNID dwConnID, BOOL bPause);
  794. /*
  795. * 名称:断开连接
  796. * 描述:断开某个连接
  797. *
  798. * 参数: dwConnID -- 连接 ID
  799. * bForce -- 是否强制断开连接
  800. * 返回值: TRUE -- 成功
  801. * FALSE -- 失败
  802. */
  803. HPSOCKET_API BOOL __HP_CALL HP_Agent_Disconnect(HP_Agent pAgent, HP_CONNID dwConnID, BOOL bForce);
  804. /*
  805. * 名称:断开超时连接
  806. * 描述:断开超过指定时长的连接
  807. *
  808. * 参数: dwPeriod -- 时长(毫秒)
  809. * bForce -- 是否强制断开连接
  810. * 返回值: TRUE -- 成功
  811. * FALSE -- 失败
  812. */
  813. HPSOCKET_API BOOL __HP_CALL HP_Agent_DisconnectLongConnections(HP_Agent pAgent, DWORD dwPeriod, BOOL bForce);
  814. /*
  815. * 名称:断开静默连接
  816. * 描述:断开超过指定时长的静默连接
  817. *
  818. * 参数: dwPeriod -- 时长(毫秒)
  819. * bForce -- 是否强制断开连接
  820. * 返回值: TRUE -- 成功
  821. * FALSE -- 失败
  822. */
  823. HPSOCKET_API BOOL __HP_CALL HP_Agent_DisconnectSilenceConnections(HP_Agent pAgent, DWORD dwPeriod, BOOL bForce);
  824. /******************************************************************************/
  825. /***************************** Agent 属性访问方法 *****************************/
  826. /*
  827. * 名称:设置连接的附加数据
  828. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定
  829. *
  830. * 参数: dwConnID -- 连接 ID
  831. * pv -- 数据
  832. * 返回值: TRUE -- 成功
  833. * FALSE -- 失败(无效的连接 ID)
  834. */
  835. HPSOCKET_API BOOL __HP_CALL HP_Agent_SetConnectionExtra(HP_Agent pAgent, HP_CONNID dwConnID, PVOID pExtra);
  836. /*
  837. * 名称:获取连接的附加数据
  838. * 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定
  839. *
  840. * 参数: dwConnID -- 连接 ID
  841. * ppv -- 数据指针
  842. * 返回值: TRUE -- 成功
  843. * FALSE -- 失败(无效的连接 ID)
  844. */
  845. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetConnectionExtra(HP_Agent pAgent, HP_CONNID dwConnID, PVOID* ppExtra);
  846. /* 检测是否为安全连接(SSL/HTTPS) */
  847. HPSOCKET_API BOOL __HP_CALL HP_Agent_IsSecure(HP_Agent pAgent);
  848. /* 检查通信组件是否已启动 */
  849. HPSOCKET_API BOOL __HP_CALL HP_Agent_HasStarted(HP_Agent pAgent);
  850. /* 查看通信组件当前状态 */
  851. HPSOCKET_API En_HP_ServiceState __HP_CALL HP_Agent_GetState(HP_Agent pAgent);
  852. /* 获取连接数 */
  853. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetConnectionCount(HP_Agent pAgent);
  854. /* 获取所有连接的 HP_CONNID */
  855. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetAllConnectionIDs(HP_Agent pAgent, HP_CONNID pIDs[], DWORD* pdwCount);
  856. /* 获取某个连接时长(毫秒) */
  857. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetConnectPeriod(HP_Agent pAgent, HP_CONNID dwConnID, DWORD* pdwPeriod);
  858. /* 获取某个连接静默时间(毫秒) */
  859. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetSilencePeriod(HP_Agent pAgent, HP_CONNID dwConnID, DWORD* pdwPeriod);
  860. /* 获取某个连接的本地地址信息 */
  861. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetLocalAddress(HP_Agent pAgent, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  862. /* 获取某个连接的远程地址信息 */
  863. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetRemoteAddress(HP_Agent pAgent, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  864. /* 获取某个连接的远程主机信息 */
  865. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetRemoteHost(HP_Agent pAgent, HP_CONNID dwConnID, TCHAR lpszHost[], int* piHostLen, USHORT* pusPort);
  866. /* 获取最近一次失败操作的错误代码 */
  867. HPSOCKET_API En_HP_SocketError __HP_CALL HP_Agent_GetLastError(HP_Agent pAgent);
  868. /* 获取最近一次失败操作的错误描述 */
  869. HPSOCKET_API LPCTSTR __HP_CALL HP_Agent_GetLastErrorDesc(HP_Agent pAgent);
  870. /* 获取连接中未发出数据的长度 */
  871. HPSOCKET_API BOOL __HP_CALL HP_Agent_GetPendingDataLength(HP_Agent pAgent, HP_CONNID dwConnID, int* piPending);
  872. /* 获取连接的数据接收状态 */
  873. HPSOCKET_API BOOL __HP_CALL HP_Agent_IsPauseReceive(HP_Agent pAgent, HP_CONNID dwConnID, BOOL* pbPaused);
  874. /* 检测是否有效连接 */
  875. HPSOCKET_API BOOL __HP_CALL HP_Agent_IsConnected(HP_Agent pAgent, HP_CONNID dwConnID);
  876. /* 设置地址重用选项 */
  877. HPSOCKET_API void __HP_CALL HP_Agent_SetReuseAddressPolicy(HP_Agent pAgent, En_HP_ReuseAddressPolicy enReusePolicy);
  878. /* 设置数据发送策略 */
  879. HPSOCKET_API void __HP_CALL HP_Agent_SetSendPolicy(HP_Agent pAgent, En_HP_SendPolicy enSendPolicy);
  880. /* 设置 OnSend 事件同步策略(默认:OSSP_NONE,不同步) */
  881. HPSOCKET_API void __HP_CALL HP_Agent_SetOnSendSyncPolicy(HP_Agent pAgent, En_HP_OnSendSyncPolicy enSyncPolicy);
  882. /* 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) */
  883. HPSOCKET_API void __HP_CALL HP_Agent_SetFreeSocketObjLockTime(HP_Agent pAgent, DWORD dwFreeSocketObjLockTime);
  884. /* 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2) */
  885. HPSOCKET_API void __HP_CALL HP_Agent_SetFreeSocketObjPool(HP_Agent pAgent, DWORD dwFreeSocketObjPool);
  886. /* 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) */
  887. HPSOCKET_API void __HP_CALL HP_Agent_SetFreeBufferObjPool(HP_Agent pAgent, DWORD dwFreeBufferObjPool);
  888. /* 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍) */
  889. HPSOCKET_API void __HP_CALL HP_Agent_SetFreeSocketObjHold(HP_Agent pAgent, DWORD dwFreeSocketObjHold);
  890. /* 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) */
  891. HPSOCKET_API void __HP_CALL HP_Agent_SetFreeBufferObjHold(HP_Agent pAgent, DWORD dwFreeBufferObjHold);
  892. /* 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)*/
  893. HPSOCKET_API void __HP_CALL HP_Agent_SetMaxConnectionCount(HP_Agent pAgent, DWORD dwMaxConnectionCount);
  894. /* 设置工作线程数量(通常设置为 2 * CPU + 2) */
  895. HPSOCKET_API void __HP_CALL HP_Agent_SetWorkerThreadCount(HP_Agent pAgent, DWORD dwWorkerThreadCount);
  896. /* 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE) */
  897. HPSOCKET_API void __HP_CALL HP_Agent_SetMarkSilence(HP_Agent pAgent, BOOL bMarkSilence);
  898. /* 获取地址重用选项 */
  899. HPSOCKET_API En_HP_ReuseAddressPolicy __HP_CALL HP_Agent_GetReuseAddressPolicy(HP_Agent pAgent);
  900. /* 获取数据发送策略 */
  901. HPSOCKET_API En_HP_SendPolicy __HP_CALL HP_Agent_GetSendPolicy(HP_Agent pAgent);
  902. /* 获取 OnSend 事件同步策略 */
  903. HPSOCKET_API En_HP_OnSendSyncPolicy __HP_CALL HP_Agent_GetOnSendSyncPolicy(HP_Agent pAgent);
  904. /* 获取 Socket 缓存对象锁定时间 */
  905. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetFreeSocketObjLockTime(HP_Agent pAgent);
  906. /* 获取 Socket 缓存池大小 */
  907. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetFreeSocketObjPool(HP_Agent pAgent);
  908. /* 获取内存块缓存池大小 */
  909. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetFreeBufferObjPool(HP_Agent pAgent);
  910. /* 获取 Socket 缓存池回收阀值 */
  911. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetFreeSocketObjHold(HP_Agent pAgent);
  912. /* 获取内存块缓存池回收阀值 */
  913. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetFreeBufferObjHold(HP_Agent pAgent);
  914. /* 获取最大连接数 */
  915. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetMaxConnectionCount(HP_Agent pAgent);
  916. /* 获取工作线程数量 */
  917. HPSOCKET_API DWORD __HP_CALL HP_Agent_GetWorkerThreadCount(HP_Agent pAgent);
  918. /* 检测是否标记静默时间 */
  919. HPSOCKET_API BOOL __HP_CALL HP_Agent_IsMarkSilence(HP_Agent pAgent);
  920. /**********************************************************************************/
  921. /******************************* TCP Agent 操作方法 *******************************/
  922. /*
  923. * 名称:发送小文件
  924. * 描述:向指定连接发送 4096 KB 以下的小文件
  925. *
  926. * 参数: dwConnID -- 连接 ID
  927. * lpszFileName -- 文件路径
  928. * pHead -- 头部附加数据
  929. * pTail -- 尾部附加数据
  930. * 返回值: TRUE -- 成功
  931. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  932. */
  933. HPSOCKET_API BOOL __HP_CALL HP_TcpAgent_SendSmallFile(HP_Agent pAgent, HP_CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail);
  934. /**********************************************************************************/
  935. /***************************** TCP Agent 属性访问方法 *****************************/
  936. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) */
  937. HPSOCKET_API void __HP_CALL HP_TcpAgent_SetSocketBufferSize(HP_TcpAgent pAgent, DWORD dwSocketBufferSize);
  938. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  939. HPSOCKET_API void __HP_CALL HP_TcpAgent_SetKeepAliveTime(HP_TcpAgent pAgent, DWORD dwKeepAliveTime);
  940. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  941. HPSOCKET_API void __HP_CALL HP_TcpAgent_SetKeepAliveInterval(HP_TcpAgent pAgent, DWORD dwKeepAliveInterval);
  942. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  943. HPSOCKET_API void __HP_CALL HP_TcpAgent_SetNoDelay(HP_TcpAgent pAgent, BOOL bNoDelay);
  944. /* 获取通信数据缓冲区大小 */
  945. HPSOCKET_API DWORD __HP_CALL HP_TcpAgent_GetSocketBufferSize(HP_TcpAgent pAgent);
  946. /* 获取正常心跳包间隔 */
  947. HPSOCKET_API DWORD __HP_CALL HP_TcpAgent_GetKeepAliveTime(HP_TcpAgent pAgent);
  948. /* 获取异常心跳包间隔 */
  949. HPSOCKET_API DWORD __HP_CALL HP_TcpAgent_GetKeepAliveInterval(HP_TcpAgent pAgent);
  950. /* 检查是否开启 nodelay 模式 */
  951. HPSOCKET_API BOOL __HP_CALL HP_TcpAgent_IsNoDelay(HP_TcpAgent pAgent);
  952. /******************************************************************************/
  953. /***************************** Client 组件操作方法 *****************************/
  954. /*
  955. * 名称:启动通信组件
  956. * 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据
  957. *
  958. * 参数: lpszRemoteAddress -- 服务端地址
  959. * usPort -- 服务端端口
  960. * bAsyncConnect -- 是否采用异步 Connect
  961. * 返回值: TRUE -- 成功
  962. * FALSE -- 失败,可通过 HP_Client_GetLastError() 获取错误代码
  963. */
  964. HPSOCKET_API BOOL __HP_CALL HP_Client_Start(HP_Client pClient, LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect);
  965. /*
  966. * 名称:启动通信组件(并指定绑定地址)
  967. * 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据
  968. *
  969. * 参数: lpszRemoteAddress -- 服务端地址
  970. * usPort -- 服务端端口
  971. * bAsyncConnect -- 是否采用异步 Connect
  972. * lpszBindAddress -- 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 任意地址)
  973. * 返回值: TRUE -- 成功
  974. * FALSE -- 失败,可通过 HP_Client_GetLastError() 获取错误代码
  975. */
  976. HPSOCKET_API BOOL __HP_CALL HP_Client_StartWithBindAddress(HP_Client pClient, LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect, LPCTSTR lpszBindAddress);
  977. /*
  978. * 名称:启动通信组件(并指定绑定地址)
  979. * 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据
  980. *
  981. * 参数: lpszRemoteAddress -- 服务端地址
  982. * usPort -- 服务端端口
  983. * bAsyncConnect -- 是否采用异步 Connect
  984. * lpszBindAddress -- 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 任意地址)
  985. * usLocalPort -- 本地端口(默认:0)
  986. * 返回值: TRUE -- 成功
  987. * FALSE -- 失败,可通过 HP_Client_GetLastError() 获取错误代码
  988. */
  989. HPSOCKET_API BOOL __HP_CALL HP_Client_StartWithBindAddressAndLocalPort(HP_Client pClient, LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect, LPCTSTR lpszBindAddress, USHORT usLocalPort);
  990. /*
  991. * 名称:关闭通信组件
  992. * 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源
  993. *
  994. * 参数:
  995. * 返回值: TRUE -- 成功
  996. * FALSE -- 失败,可通过 HP_Client_GetLastError() 获取错误代码
  997. */
  998. HPSOCKET_API BOOL __HP_CALL HP_Client_Stop(HP_Client pClient);
  999. /*
  1000. * 名称:发送数据
  1001. * 描述:向服务端发送数据
  1002. *
  1003. * 参数: pBuffer -- 发送缓冲区
  1004. * iLength -- 发送缓冲区长度
  1005. * 返回值: TRUE -- 成功
  1006. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  1007. */
  1008. HPSOCKET_API BOOL __HP_CALL HP_Client_Send(HP_Client pClient, const BYTE* pBuffer, int iLength);
  1009. /*
  1010. * 名称:发送数据
  1011. * 描述:向服务端发送数据
  1012. *
  1013. * 参数: pBuffer -- 发送缓冲区
  1014. * iLength -- 发送缓冲区长度
  1015. * iOffset -- 发送缓冲区指针偏移量
  1016. * 返回值: TRUE -- 成功
  1017. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  1018. */
  1019. HPSOCKET_API BOOL __HP_CALL HP_Client_SendPart(HP_Client pClient, const BYTE* pBuffer, int iLength, int iOffset);
  1020. /*
  1021. * 名称:发送多组数据
  1022. * 描述:向服务端发送多组数据
  1023. * TCP - 顺序发送所有数据包
  1024. * UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  1025. *
  1026. * 参数: pBuffers -- 发送缓冲区数组
  1027. * iCount -- 发送缓冲区数目
  1028. * 返回值: TRUE -- 成功
  1029. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  1030. */
  1031. HPSOCKET_API BOOL __HP_CALL HP_Client_SendPackets(HP_Client pClient, const WSABUF pBuffers[], int iCount);
  1032. /*
  1033. * 名称:暂停/恢复接收
  1034. * 描述:暂停/恢复某个连接的数据接收工作
  1035. *
  1036. * bPause -- TRUE - 暂停, FALSE - 恢复
  1037. * 返回值: TRUE -- 成功
  1038. * FALSE -- 失败
  1039. */
  1040. HPSOCKET_API BOOL __HP_CALL HP_Client_PauseReceive(HP_Client pClient, BOOL bPause);
  1041. /*
  1042. * 名称:等待
  1043. * 描述:等待通信组件停止运行
  1044. *
  1045. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  1046. * 返回值: TRUE -- 成功
  1047. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1048. */
  1049. HPSOCKET_API BOOL __HP_CALL HP_Client_Wait(HP_Client pClient, DWORD dwMilliseconds);
  1050. /******************************************************************************/
  1051. /***************************** Client 属性访问方法 *****************************/
  1052. /* 设置连接的附加数据 */
  1053. HPSOCKET_API void __HP_CALL HP_Client_SetExtra(HP_Client pClient, PVOID pExtra);
  1054. /* 获取连接的附加数据 */
  1055. HPSOCKET_API PVOID __HP_CALL HP_Client_GetExtra(HP_Client pClient);
  1056. /* 检测是否为安全连接(SSL/HTTPS) */
  1057. HPSOCKET_API BOOL __HP_CALL HP_Client_IsSecure(HP_Client pClient);
  1058. /* 检查通信组件是否已启动 */
  1059. HPSOCKET_API BOOL __HP_CALL HP_Client_HasStarted(HP_Client pClient);
  1060. /* 查看通信组件当前状态 */
  1061. HPSOCKET_API En_HP_ServiceState __HP_CALL HP_Client_GetState(HP_Client pClient);
  1062. /* 获取最近一次失败操作的错误代码 */
  1063. HPSOCKET_API En_HP_SocketError __HP_CALL HP_Client_GetLastError(HP_Client pClient);
  1064. /* 获取最近一次失败操作的错误描述 */
  1065. HPSOCKET_API LPCTSTR __HP_CALL HP_Client_GetLastErrorDesc(HP_Client pClient);
  1066. /* 获取该组件对象的连接 ID */
  1067. HPSOCKET_API HP_CONNID __HP_CALL HP_Client_GetConnectionID(HP_Client pClient);
  1068. /* 获取 Client Socket 的地址信息 */
  1069. HPSOCKET_API BOOL __HP_CALL HP_Client_GetLocalAddress(HP_Client pClient, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  1070. /* 获取连接的远程主机信息 */
  1071. HPSOCKET_API BOOL __HP_CALL HP_Client_GetRemoteHost(HP_Client pClient, TCHAR lpszHost[], int* piHostLen, USHORT* pusPort);
  1072. /* 获取连接中未发出数据的长度 */
  1073. HPSOCKET_API BOOL __HP_CALL HP_Client_GetPendingDataLength(HP_Client pClient, int* piPending);
  1074. /* 获取连接的数据接收状态 */
  1075. HPSOCKET_API BOOL __HP_CALL HP_Client_IsPauseReceive(HP_Client pClient, BOOL* pbPaused);
  1076. /* 检测是否有效连接 */
  1077. HPSOCKET_API BOOL __HP_CALL HP_Client_IsConnected(HP_Client pClient);
  1078. /* 设置地址重用选项 */
  1079. HPSOCKET_API void __HP_CALL HP_Client_SetReuseAddressPolicy(HP_Client pClient, En_HP_ReuseAddressPolicy enReusePolicy);
  1080. /* 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 ) */
  1081. HPSOCKET_API void __HP_CALL HP_Client_SetFreeBufferPoolSize(HP_Client pClient, DWORD dwFreeBufferPoolSize);
  1082. /* 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) */
  1083. HPSOCKET_API void __HP_CALL HP_Client_SetFreeBufferPoolHold(HP_Client pClient, DWORD dwFreeBufferPoolHold);
  1084. /* 获取地址重用选项 */
  1085. HPSOCKET_API En_HP_ReuseAddressPolicy __HP_CALL HP_Client_GetReuseAddressPolicy(HP_Client pClient);
  1086. /* 获取内存块缓存池大小 */
  1087. HPSOCKET_API DWORD __HP_CALL HP_Client_GetFreeBufferPoolSize(HP_Client pClient);
  1088. /* 获取内存块缓存池回收阀值 */
  1089. HPSOCKET_API DWORD __HP_CALL HP_Client_GetFreeBufferPoolHold(HP_Client pClient);
  1090. /**********************************************************************************/
  1091. /******************************* TCP Client 操作方法 *******************************/
  1092. /*
  1093. * 名称:发送小文件
  1094. * 描述:向服务端发送 4096 KB 以下的小文件
  1095. *
  1096. * 参数: lpszFileName -- 文件路径
  1097. * pHead -- 头部附加数据
  1098. * pTail -- 尾部附加数据
  1099. * 返回值: TRUE -- 成功
  1100. * FALSE -- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码
  1101. */
  1102. HPSOCKET_API BOOL __HP_CALL HP_TcpClient_SendSmallFile(HP_Client pClient, LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail);
  1103. /**********************************************************************************/
  1104. /***************************** TCP Client 属性访问方法 *****************************/
  1105. /* 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj)) */
  1106. HPSOCKET_API void __HP_CALL HP_TcpClient_SetSocketBufferSize(HP_TcpClient pClient, DWORD dwSocketBufferSize);
  1107. /* 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000) */
  1108. HPSOCKET_API void __HP_CALL HP_TcpClient_SetKeepAliveTime(HP_TcpClient pClient, DWORD dwKeepAliveTime);
  1109. /* 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) */
  1110. HPSOCKET_API void __HP_CALL HP_TcpClient_SetKeepAliveInterval(HP_TcpClient pClient, DWORD dwKeepAliveInterval);
  1111. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  1112. HPSOCKET_API void __HP_CALL HP_TcpClient_SetNoDelay(HP_TcpClient pClient, BOOL bNoDelay);
  1113. /* 获取通信数据缓冲区大小 */
  1114. HPSOCKET_API DWORD __HP_CALL HP_TcpClient_GetSocketBufferSize(HP_TcpClient pClient);
  1115. /* 获取正常心跳包间隔 */
  1116. HPSOCKET_API DWORD __HP_CALL HP_TcpClient_GetKeepAliveTime(HP_TcpClient pClient);
  1117. /* 获取异常心跳包间隔 */
  1118. HPSOCKET_API DWORD __HP_CALL HP_TcpClient_GetKeepAliveInterval(HP_TcpClient pClient);
  1119. /* 检查是否开启 nodelay 模式 */
  1120. HPSOCKET_API BOOL __HP_CALL HP_TcpClient_IsNoDelay(HP_TcpClient pClient);
  1121. #ifdef _UDP_SUPPORT
  1122. /**********************************************************************************/
  1123. /***************************** UDP Client 属性访问方法 *****************************/
  1124. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  1125. HPSOCKET_API void __HP_CALL HP_UdpClient_SetMaxDatagramSize(HP_UdpClient pClient, DWORD dwMaxDatagramSize);
  1126. /* 获取数据报文最大长度 */
  1127. HPSOCKET_API DWORD __HP_CALL HP_UdpClient_GetMaxDatagramSize(HP_UdpClient pClient);
  1128. /* 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) */
  1129. HPSOCKET_API void __HP_CALL HP_UdpClient_SetDetectAttempts(HP_UdpClient pClient, DWORD dwDetectAttempts);
  1130. /* 设置监测包发送间隔(毫秒,0 不发送监测包) */
  1131. HPSOCKET_API void __HP_CALL HP_UdpClient_SetDetectInterval(HP_UdpClient pClient, DWORD dwDetectInterval);
  1132. /* 获取心跳检查次数 */
  1133. HPSOCKET_API DWORD __HP_CALL HP_UdpClient_GetDetectAttempts(HP_UdpClient pClient);
  1134. /* 获取心跳检查间隔 */
  1135. HPSOCKET_API DWORD __HP_CALL HP_UdpClient_GetDetectInterval(HP_UdpClient pClient);
  1136. /**********************************************************************************/
  1137. /*************************** UDP ARQ Client 属性访问方法 ***************************/
  1138. /* 设置是否开启 nodelay 模式(默认:FALSE,不开启) */
  1139. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetNoDelay(HP_UdpArqClient pClient, BOOL bNoDelay);
  1140. /* 设置是否关闭拥塞控制(默认:FALSE,不关闭) */
  1141. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetTurnoffCongestCtrl(HP_UdpArqClient pClient, BOOL bTurnOff);
  1142. /* 设置数据刷新间隔(毫秒,默认:60) */
  1143. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetFlushInterval(HP_UdpArqClient pClient, DWORD dwFlushInterval);
  1144. /* 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传) */
  1145. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetResendByAcks(HP_UdpArqClient pClient, DWORD dwResendByAcks);
  1146. /* 设置发送窗口大小(数据包数量,默认:128) */
  1147. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetSendWndSize(HP_UdpArqClient pClient, DWORD dwSendWndSize);
  1148. /* 设置接收窗口大小(数据包数量,默认:512) */
  1149. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetRecvWndSize(HP_UdpArqClient pClient, DWORD dwRecvWndSize);
  1150. /* 设置最小重传超时时间(毫秒,默认:30) */
  1151. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetMinRto(HP_UdpArqClient pClient, DWORD dwMinRto);
  1152. /* 设置快速握手次数限制(默认:5,如果为 0 则不限制) */
  1153. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetFastLimit(HP_UdpArqClient pClient, DWORD dwFastLimit);
  1154. /* 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致) */
  1155. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetMaxTransUnit(HP_UdpArqClient pClient, DWORD dwMaxTransUnit);
  1156. /* 设置最大数据包大小(默认:4096) */
  1157. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetMaxMessageSize(HP_UdpArqClient pClient, DWORD dwMaxMessageSize);
  1158. /* 设置握手超时时间(毫秒,默认:5000) */
  1159. HPSOCKET_API void __HP_CALL HP_UdpArqClient_SetHandShakeTimeout(HP_UdpArqClient pClient, DWORD dwHandShakeTimeout);
  1160. /* 检测是否开启 nodelay 模式 */
  1161. HPSOCKET_API BOOL __HP_CALL HP_UdpArqClient_IsNoDelay(HP_UdpArqClient pClient);
  1162. /* 检测是否关闭拥塞控制 */
  1163. HPSOCKET_API BOOL __HP_CALL HP_UdpArqClient_IsTurnoffCongestCtrl(HP_UdpArqClient pClient);
  1164. /* 获取数据刷新间隔 */
  1165. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetFlushInterval(HP_UdpArqClient pClient);
  1166. /* 获取快速重传 ACK 跨越次数 */
  1167. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetResendByAcks(HP_UdpArqClient pClient);
  1168. /* 获取发送窗口大小 */
  1169. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetSendWndSize(HP_UdpArqClient pClient);
  1170. /* 获取接收窗口大小 */
  1171. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetRecvWndSize(HP_UdpArqClient pClient);
  1172. /* 获取最小重传超时时间 */
  1173. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetMinRto(HP_UdpArqClient pClient);
  1174. /* 获取快速握手次数限制 */
  1175. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetFastLimit(HP_UdpArqClient pClient);
  1176. /* 获取最大传输单元 */
  1177. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetMaxTransUnit(HP_UdpArqClient pClient);
  1178. /* 获取最大数据包大小 */
  1179. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetMaxMessageSize(HP_UdpArqClient pClient);
  1180. /* 获取握手超时时间 */
  1181. HPSOCKET_API DWORD __HP_CALL HP_UdpArqClient_GetHandShakeTimeout(HP_UdpArqClient pClient);
  1182. /* 获取等待发送包数量 */
  1183. HPSOCKET_API BOOL __HP_CALL HP_UdpArqClient_GetWaitingSendMessageCount(HP_UdpArqClient pClient, int* piCount);
  1184. /**********************************************************************************/
  1185. /****************************** UDP Cast 属性访问方法 ******************************/
  1186. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  1187. HPSOCKET_API void __HP_CALL HP_UdpCast_SetMaxDatagramSize(HP_UdpCast pCast, DWORD dwMaxDatagramSize);
  1188. /* 获取数据报文最大长度 */
  1189. HPSOCKET_API DWORD __HP_CALL HP_UdpCast_GetMaxDatagramSize(HP_UdpCast pCast);
  1190. /* 获取当前数据报的远程地址信息(通常在 OnReceive 事件中调用) */
  1191. HPSOCKET_API BOOL __HP_CALL HP_UdpCast_GetRemoteAddress(HP_UdpCast pCast, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  1192. /* 设置传播模式(组播或广播) */
  1193. HPSOCKET_API void __HP_CALL HP_UdpCast_SetCastMode(HP_UdpCast pCast, En_HP_CastMode enCastMode);
  1194. /* 获取传播模式 */
  1195. HPSOCKET_API En_HP_CastMode __HP_CALL HP_UdpCast_GetCastMode(HP_UdpCast pCast);
  1196. /* 设置组播报文的 TTL(0 - 255) */
  1197. HPSOCKET_API void __HP_CALL HP_UdpCast_SetMultiCastTtl(HP_UdpCast pCast, int iMCTtl);
  1198. /* 获取组播报文的 TTL */
  1199. HPSOCKET_API int __HP_CALL HP_UdpCast_GetMultiCastTtl(HP_UdpCast pCast);
  1200. /* 设置是否启用组播环路(TRUE or FALSE) */
  1201. HPSOCKET_API void __HP_CALL HP_UdpCast_SetMultiCastLoop(HP_UdpCast pCast, BOOL bMCLoop);
  1202. /* 检测是否启用组播环路 */
  1203. HPSOCKET_API BOOL __HP_CALL HP_UdpCast_IsMultiCastLoop(HP_UdpCast pCast);
  1204. /**********************************************************************************/
  1205. /****************************** UDP Node 组件操作方法 ******************************/
  1206. /*
  1207. * 名称:启动通信组件
  1208. * 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
  1209. *
  1210. * 参数: lpszBindAddress -- 绑定地址(默认:nullptr,绑定任意地址)
  1211. * usPort -- 本地端口(默认:0)
  1212. * 返回值: TRUE -- 成功
  1213. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  1214. */
  1215. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_Start(HP_UdpNode pNode, LPCTSTR lpszBindAddress, USHORT usPort);
  1216. /*
  1217. * 名称:启动通信组件
  1218. * 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
  1219. *
  1220. * 参数: lpszBindAddress -- 绑定地址(默认:nullptr,绑定任意地址)
  1221. * usPort -- 本地端口(默认:0)
  1222. * enCastMode -- 传播模式(默认:CM_UNICAST)
  1223. * lpszCastAddress -- 传播地址(默认:nullptr,当 enCaseMode 为 CM_MULTICAST 或 CM_BROADCAST 时有效)
  1224. * 返回值: TRUE -- 成功
  1225. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  1226. */
  1227. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_StartWithCast(HP_UdpNode pNode, LPCTSTR lpszBindAddress, USHORT usPort, En_HP_CastMode enCastMode, LPCTSTR lpszCastAddress);
  1228. /*
  1229. * 名称:关闭通信组件
  1230. * 描述:关闭 UDP 节点通信组件,关闭完成后释放所有资源
  1231. *
  1232. * 参数:
  1233. * 返回值: TRUE -- 成功
  1234. * FALSE -- 失败,可通过 GetLastError() 获取错误代码
  1235. */
  1236. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_Stop(HP_UdpNode pNode);
  1237. /*
  1238. * 名称:等待
  1239. * 描述:等待通信组件停止运行
  1240. *
  1241. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  1242. * 返回值: TRUE -- 成功
  1243. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1244. */
  1245. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_Wait(HP_UdpNode pNode, DWORD dwMilliseconds);
  1246. /*
  1247. * 名称:发送数据
  1248. * 描述:向指定地址发送数据
  1249. *
  1250. * 参数: lpszRemoteAddress -- 远程地址
  1251. * usRemotePort -- 远程端口
  1252. * pBuffer -- 发送缓冲区
  1253. * iLength -- 发送缓冲区长度
  1254. * 返回值: TRUE -- 成功
  1255. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1256. */
  1257. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_Send(HP_UdpNode pNode, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pBuffer, int iLength);
  1258. /*
  1259. * 名称:发送数据
  1260. * 描述:向指定地址发送数据
  1261. *
  1262. * 参数: lpszRemoteAddress -- 远程地址
  1263. * usRemotePort -- 远程端口
  1264. * pBuffer -- 发送缓冲区
  1265. * iLength -- 发送缓冲区长度
  1266. * iOffset -- 发送缓冲区指针偏移量
  1267. * 返回值: TRUE -- 成功
  1268. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1269. */
  1270. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_SendPart(HP_UdpNode pNode, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const BYTE* pBuffer, int iLength, int iOffset);
  1271. /*
  1272. * 名称:发送多组数据
  1273. * 描述:向指定地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  1274. *
  1275. * 参数: lpszRemoteAddress -- 远程地址
  1276. * usRemotePort -- 远程端口
  1277. * pBuffers -- 发送缓冲区数组
  1278. * iCount -- 发送缓冲区数目
  1279. * 返回值: TRUE -- 成功
  1280. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1281. */
  1282. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_SendPackets(HP_UdpNode pNode, LPCTSTR lpszRemoteAddress, USHORT usRemotePort, const WSABUF pBuffers[], int iCount);
  1283. /*
  1284. * 名称:发送数据
  1285. * 描述:向传播地址发送数据
  1286. *
  1287. * 参数: pBuffer -- 发送缓冲区
  1288. * iLength -- 发送缓冲区长度
  1289. * 返回值: TRUE -- 成功
  1290. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1291. */
  1292. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_SendCast(HP_UdpNode pNode, const BYTE* pBuffer, int iLength);
  1293. /*
  1294. * 名称:发送数据
  1295. * 描述:向传播地址发送数据
  1296. *
  1297. * 参数: pBuffer -- 发送缓冲区
  1298. * iLength -- 发送缓冲区长度
  1299. * iOffset -- 发送缓冲区指针偏移量
  1300. * 返回值: TRUE -- 成功
  1301. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1302. */
  1303. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_SendCastPart(HP_UdpNode pNode, const BYTE* pBuffer, int iLength, int iOffset);
  1304. /*
  1305. * 名称:发送多组数据
  1306. * 描述:向传播地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
  1307. *
  1308. * 参数: pBuffers -- 发送缓冲区数组
  1309. * iCount -- 发送缓冲区数目
  1310. * 返回值: TRUE -- 成功
  1311. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  1312. */
  1313. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_SendCastPackets(HP_UdpNode pNode, const WSABUF pBuffers[], int iCount);
  1314. /**********************************************************************************/
  1315. /****************************** UDP Node 属性访问方法 ******************************/
  1316. /* 设置附加数据 */
  1317. HPSOCKET_API void __HP_CALL HP_UdpNode_SetExtra(HP_UdpNode pNode, PVOID pExtra);
  1318. /* 获取附加数据 */
  1319. HPSOCKET_API PVOID __HP_CALL HP_UdpNode_GetExtra(HP_UdpNode pNode);
  1320. /* 检查通信组件是否已启动 */
  1321. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_HasStarted(HP_UdpNode pNode);
  1322. /* 查看通信组件当前状态 */
  1323. HPSOCKET_API En_HP_ServiceState __HP_CALL HP_UdpNode_GetState(HP_UdpNode pNode);
  1324. /* 获取最近一次失败操作的错误代码 */
  1325. HPSOCKET_API En_HP_SocketError __HP_CALL HP_UdpNode_GetLastError(HP_UdpNode pNode);
  1326. /* 获取最近一次失败操作的错误描述 */
  1327. HPSOCKET_API LPCTSTR __HP_CALL HP_UdpNode_GetLastErrorDesc(HP_UdpNode pNode);
  1328. /* 获取本节点地址 */
  1329. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_GetLocalAddress(HP_UdpNode pNode, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  1330. /* 获取本节点传播地址 */
  1331. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_GetCastAddress(HP_UdpNode pNode, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  1332. /* 获取传播模式 */
  1333. HPSOCKET_API En_HP_CastMode __HP_CALL HP_UdpNode_GetCastMode(HP_UdpNode pNode);
  1334. /* 获取未发出数据的长度 */
  1335. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_GetPendingDataLength(HP_UdpNode pNode, int* piPending);
  1336. /* 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节) */
  1337. HPSOCKET_API void __HP_CALL HP_UdpNode_SetMaxDatagramSize(HP_UdpNode pNode, DWORD dwMaxDatagramSize);
  1338. /* 获取数据报文最大长度 */
  1339. HPSOCKET_API DWORD __HP_CALL HP_UdpNode_GetMaxDatagramSize(HP_UdpNode pNode);
  1340. /* 设置组播报文的 TTL(0 - 255) */
  1341. HPSOCKET_API void __HP_CALL HP_UdpNode_SetMultiCastTtl(HP_UdpNode pNode, int iMCTtl);
  1342. /* 获取组播报文的 TTL */
  1343. HPSOCKET_API int __HP_CALL HP_UdpNode_GetMultiCastTtl(HP_UdpNode pNode);
  1344. /* 设置是否启用组播环路(TRUE or FALSE) */
  1345. HPSOCKET_API void __HP_CALL HP_UdpNode_SetMultiCastLoop(HP_UdpNode pNode, BOOL bMCLoop);
  1346. /* 检测是否启用组播环路 */
  1347. HPSOCKET_API BOOL __HP_CALL HP_UdpNode_IsMultiCastLoop(HP_UdpNode pNode);
  1348. /* 设置地址重用选项 */
  1349. HPSOCKET_API void __HP_CALL HP_UdpNode_SetReuseAddressPolicy(HP_UdpNode pNode, En_HP_ReuseAddressPolicy enReusePolicy);
  1350. /* 设置工作线程数量(通常设置为 2 * CPU + 2) */
  1351. HPSOCKET_API void __HP_CALL HP_UdpNode_SetWorkerThreadCount(HP_UdpNode pNode, DWORD dwWorkerThreadCount);
  1352. /* 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小) */
  1353. HPSOCKET_API void __HP_CALL HP_UdpNode_SetPostReceiveCount(HP_UdpNode pNode, DWORD dwPostReceiveCount);
  1354. /* 设置内存块缓存池大小 */
  1355. HPSOCKET_API void __HP_CALL HP_UdpNode_SetFreeBufferPoolSize(HP_UdpNode pNode, DWORD dwFreeBufferPoolSize);
  1356. /* 设置内存块缓存池回收阀值 */
  1357. HPSOCKET_API void __HP_CALL HP_UdpNode_SetFreeBufferPoolHold(HP_UdpNode pNode, DWORD dwFreeBufferPoolHold);
  1358. /* 获取地址重用选项 */
  1359. HPSOCKET_API En_HP_ReuseAddressPolicy __HP_CALL HP_UdpNode_GetReuseAddressPolicy(HP_UdpNode pNode);
  1360. /* 获取工作线程数量 */
  1361. HPSOCKET_API DWORD __HP_CALL HP_UdpNode_GetWorkerThreadCount(HP_UdpNode pNode);
  1362. /* 获取 Receive 预投递数量 */
  1363. HPSOCKET_API DWORD __HP_CALL HP_UdpNode_GetPostReceiveCount(HP_UdpNode pNode);
  1364. /* 获取内存块缓存池大小 */
  1365. HPSOCKET_API DWORD __HP_CALL HP_UdpNode_GetFreeBufferPoolSize(HP_UdpNode pNode);
  1366. /* 获取内存块缓存池回收阀值 */
  1367. HPSOCKET_API DWORD __HP_CALL HP_UdpNode_GetFreeBufferPoolHold(HP_UdpNode pNode);
  1368. #endif
  1369. /***************************************************************************************/
  1370. /***************************** TCP Pull Server 组件操作方法 *****************************/
  1371. /*
  1372. * 名称:抓取数据
  1373. * 描述:用户通过该方法从 Socket 组件中抓取数据
  1374. *
  1375. * 参数: dwConnID -- 连接 ID
  1376. * pData -- 抓取缓冲区
  1377. * iLength -- 抓取数据长度
  1378. * 返回值: En_HP_FetchResult
  1379. */
  1380. HPSOCKET_API En_HP_FetchResult __HP_CALL HP_TcpPullServer_Fetch(HP_TcpPullServer pServer, HP_CONNID dwConnID, BYTE* pData, int iLength);
  1381. /*
  1382. * 名称:窥探数据(不会移除缓冲区数据)
  1383. * 描述:用户通过该方法从 Socket 组件中窥探数据
  1384. *
  1385. * 参数: dwConnID -- 连接 ID
  1386. * pData -- 窥探缓冲区
  1387. * iLength -- 窥探数据长度
  1388. * 返回值: En_HP_FetchResult
  1389. */
  1390. HPSOCKET_API En_HP_FetchResult __HP_CALL HP_TcpPullServer_Peek(HP_TcpPullServer pServer, HP_CONNID dwConnID, BYTE* pData, int iLength);
  1391. /***************************************************************************************/
  1392. /***************************** TCP Pull Server 属性访问方法 *****************************/
  1393. /***************************************************************************************/
  1394. /***************************** TCP Pull Agent 组件操作方法 *****************************/
  1395. /*
  1396. * 名称:抓取数据
  1397. * 描述:用户通过该方法从 Socket 组件中抓取数据
  1398. *
  1399. * 参数: dwConnID -- 连接 ID
  1400. * pData -- 抓取缓冲区
  1401. * iLength -- 抓取数据长度
  1402. * 返回值: En_HP_FetchResult
  1403. */
  1404. HPSOCKET_API En_HP_FetchResult __HP_CALL HP_TcpPullAgent_Fetch(HP_TcpPullAgent pAgent, HP_CONNID dwConnID, BYTE* pData, int iLength);
  1405. /*
  1406. * 名称:窥探数据(不会移除缓冲区数据)
  1407. * 描述:用户通过该方法从 Socket 组件中窥探数据
  1408. *
  1409. * 参数: dwConnID -- 连接 ID
  1410. * pData -- 窥探缓冲区
  1411. * iLength -- 窥探数据长度
  1412. * 返回值: En_HP_FetchResult
  1413. */
  1414. HPSOCKET_API En_HP_FetchResult __HP_CALL HP_TcpPullAgent_Peek(HP_TcpPullAgent pAgent, HP_CONNID dwConnID, BYTE* pData, int iLength);
  1415. /***************************************************************************************/
  1416. /***************************** TCP Pull Agent 属性访问方法 *****************************/
  1417. /***************************************************************************************/
  1418. /***************************** TCP Pull Client 组件操作方法 *****************************/
  1419. /*
  1420. * 名称:抓取数据
  1421. * 描述:用户通过该方法从 Socket 组件中抓取数据
  1422. *
  1423. * 参数: dwConnID -- 连接 ID
  1424. * pData -- 抓取缓冲区
  1425. * iLength -- 抓取数据长度
  1426. * 返回值: En_HP_FetchResult
  1427. */
  1428. HPSOCKET_API En_HP_FetchResult __HP_CALL HP_TcpPullClient_Fetch(HP_TcpPullClient pClient, BYTE* pData, int iLength);
  1429. /*
  1430. * 名称:窥探数据(不会移除缓冲区数据)
  1431. * 描述:用户通过该方法从 Socket 组件中窥探数据
  1432. *
  1433. * 参数: dwConnID -- 连接 ID
  1434. * pData -- 窥探缓冲区
  1435. * iLength -- 窥探数据长度
  1436. * 返回值: En_HP_FetchResult
  1437. */
  1438. HPSOCKET_API En_HP_FetchResult __HP_CALL HP_TcpPullClient_Peek(HP_TcpPullClient pClient, BYTE* pData, int iLength);
  1439. /***************************************************************************************/
  1440. /***************************** TCP Pull Client 属性访问方法 *****************************/
  1441. /***************************************************************************************/
  1442. /***************************** TCP Pack Server 组件操作方法 *****************************/
  1443. /***************************************************************************************/
  1444. /***************************** TCP Pack Server 属性访问方法 *****************************/
  1445. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  1446. HPSOCKET_API void __HP_CALL HP_TcpPackServer_SetMaxPackSize(HP_TcpPackServer pServer, DWORD dwMaxPackSize);
  1447. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  1448. HPSOCKET_API void __HP_CALL HP_TcpPackServer_SetPackHeaderFlag(HP_TcpPackServer pServer, USHORT usPackHeaderFlag);
  1449. /* 获取数据包最大长度 */
  1450. HPSOCKET_API DWORD __HP_CALL HP_TcpPackServer_GetMaxPackSize(HP_TcpPackServer pServer);
  1451. /* 获取包头标识 */
  1452. HPSOCKET_API USHORT __HP_CALL HP_TcpPackServer_GetPackHeaderFlag(HP_TcpPackServer pServer);
  1453. /***************************************************************************************/
  1454. /***************************** TCP Pack Agent 组件操作方法 *****************************/
  1455. /***************************************************************************************/
  1456. /***************************** TCP Pack Agent 属性访问方法 *****************************/
  1457. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  1458. HPSOCKET_API void __HP_CALL HP_TcpPackAgent_SetMaxPackSize(HP_TcpPackAgent pAgent, DWORD dwMaxPackSize);
  1459. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  1460. HPSOCKET_API void __HP_CALL HP_TcpPackAgent_SetPackHeaderFlag(HP_TcpPackAgent pAgent, USHORT usPackHeaderFlag);
  1461. /* 获取数据包最大长度 */
  1462. HPSOCKET_API DWORD __HP_CALL HP_TcpPackAgent_GetMaxPackSize(HP_TcpPackAgent pAgent);
  1463. /* 获取包头标识 */
  1464. HPSOCKET_API USHORT __HP_CALL HP_TcpPackAgent_GetPackHeaderFlag(HP_TcpPackAgent pAgent);
  1465. /***************************************************************************************/
  1466. /***************************** TCP Pack Client 组件操作方法 *****************************/
  1467. /***************************************************************************************/
  1468. /***************************** TCP Pack Client 属性访问方法 *****************************/
  1469. /* 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000) */
  1470. HPSOCKET_API void __HP_CALL HP_TcpPackClient_SetMaxPackSize(HP_TcpPackClient pClient, DWORD dwMaxPackSize);
  1471. /* 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0) */
  1472. HPSOCKET_API void __HP_CALL HP_TcpPackClient_SetPackHeaderFlag(HP_TcpPackClient pClient, USHORT usPackHeaderFlag);
  1473. /* 获取数据包最大长度 */
  1474. HPSOCKET_API DWORD __HP_CALL HP_TcpPackClient_GetMaxPackSize(HP_TcpPackClient pClient);
  1475. /* 获取包头标识 */
  1476. HPSOCKET_API USHORT __HP_CALL HP_TcpPackClient_GetPackHeaderFlag(HP_TcpPackClient pClient);
  1477. /*****************************************************************************************************************************************************/
  1478. /*************************************************************** Global Function Exports *************************************************************/
  1479. /*****************************************************************************************************************************************************/
  1480. // 获取 HPSocket 版本号(4 个字节分别为:主版本号,子版本号,修正版本号,构建编号)
  1481. HPSOCKET_API DWORD __HP_CALL HP_GetHPSocketVersion();
  1482. /* 获取错误描述文本 */
  1483. HPSOCKET_API LPCTSTR __HP_CALL HP_GetSocketErrorDesc(En_HP_SocketError enCode);
  1484. /* 调用系统的 GetLastError() 方法获取系统错误代码 */
  1485. HPSOCKET_API DWORD __HP_CALL SYS_GetLastError();
  1486. // 调用系统的 WSAGetLastError() 方法获取系统错误代码
  1487. HPSOCKET_API int __HP_CALL SYS_WSAGetLastError();
  1488. // 调用系统的 setsockopt()
  1489. HPSOCKET_API int __HP_CALL SYS_SetSocketOption(SOCKET sock, int level, int name, LPVOID val, int len);
  1490. // 调用系统的 getsockopt()
  1491. HPSOCKET_API int __HP_CALL SYS_GetSocketOption(SOCKET sock, int level, int name, LPVOID val, int* len);
  1492. // 调用系统的 ioctlsocket()
  1493. HPSOCKET_API int __HP_CALL SYS_IoctlSocket(SOCKET sock, long cmd, ULONG* arg);
  1494. // 调用系统的 WSAIoctl()
  1495. HPSOCKET_API int __HP_CALL SYS_WSAIoctl(SOCKET sock, DWORD dwIoControlCode, LPVOID lpvInBuffer, DWORD cbInBuffer, LPVOID lpvOutBuffer, DWORD cbOutBuffer, LPDWORD lpcbBytesReturned);
  1496. // 设置 socket 选项:IPPROTO_TCP -> TCP_NODELAY
  1497. HPSOCKET_API int __HP_CALL SYS_SSO_NoDelay(SOCKET sock, BOOL bNoDelay);
  1498. // 设置 socket 选项:SOL_SOCKET -> SO_DONTLINGER
  1499. HPSOCKET_API int __HP_CALL SYS_SSO_DontLinger(SOCKET sock, BOOL bDont);
  1500. // 设置 socket 选项:SOL_SOCKET -> SO_LINGER
  1501. HPSOCKET_API int __HP_CALL SYS_SSO_Linger(SOCKET sock, USHORT l_onoff, USHORT l_linger);
  1502. // 设置 socket 选项:SOL_SOCKET -> SO_RCVBUF
  1503. HPSOCKET_API int __HP_CALL SYS_SSO_RecvBuffSize(SOCKET sock, int size);
  1504. // 设置 socket 选项:SOL_SOCKET -> SO_SNDBUF
  1505. HPSOCKET_API int __HP_CALL SYS_SSO_SendBuffSize(SOCKET sock, int size);
  1506. // 设置 socket 选项:SOL_SOCKET -> SO_RCVTIMEO
  1507. HPSOCKET_API int __HP_CALL SYS_SSO_RecvTimeOut(SOCKET sock, int ms);
  1508. // 设置 socket 选项:SOL_SOCKET -> SO_SNDTIMEO
  1509. HPSOCKET_API int __HP_CALL SYS_SSO_SendTimeOut(SOCKET sock, int ms);
  1510. // 设置 socket 选项:SOL_SOCKET -> SO_EXCLUSIVEADDRUSE / SO_REUSEADDR
  1511. HPSOCKET_API int __HP_CALL SYS_SSO_ReuseAddress(SOCKET sock, En_HP_ReuseAddressPolicy opt);
  1512. // 设置 socket 选项:SOL_SOCKET -> SO_EXCLUSIVEADDRUSE
  1513. HPSOCKET_API int __HP_CALL SYS_SSO_ExclusiveAddressUse(SOCKET sock, BOOL bExclusive);
  1514. // 获取 SOCKET 本地地址信息
  1515. HPSOCKET_API BOOL __HP_CALL SYS_GetSocketLocalAddress(SOCKET socket, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  1516. // 获取 SOCKET 远程地址信息
  1517. HPSOCKET_API BOOL __HP_CALL SYS_GetSocketRemoteAddress(SOCKET socket, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);
  1518. /* 枚举主机 IP 地址 */
  1519. HPSOCKET_API BOOL __HP_CALL SYS_EnumHostIPAddresses(LPCTSTR lpszHost, En_HP_IPAddrType enType, HP_LPTIPAddr** lpppIPAddr, int* piIPAddrCount);
  1520. /* 释放 HP_LPTIPAddr* */
  1521. HPSOCKET_API BOOL __HP_CALL SYS_FreeHostIPAddresses(HP_LPTIPAddr* lppIPAddr);
  1522. /* 检查字符串是否符合 IP 地址格式 */
  1523. HPSOCKET_API BOOL __HP_CALL SYS_IsIPAddress(LPCTSTR lpszAddress, En_HP_IPAddrType* penType);
  1524. /* 通过主机名获取 IP 地址 */
  1525. HPSOCKET_API BOOL __HP_CALL SYS_GetIPAddress(LPCTSTR lpszHost, TCHAR lpszIP[], int* piIPLenth, En_HP_IPAddrType* penType);
  1526. /* 64 位网络字节序转主机字节序 */
  1527. HPSOCKET_API ULONGLONG __HP_CALL SYS_NToH64(ULONGLONG value);
  1528. /* 64 位主机字节序转网络字节序 */
  1529. HPSOCKET_API ULONGLONG __HP_CALL SYS_HToN64(ULONGLONG value);
  1530. /* 短整型高低字节交换 */
  1531. HPSOCKET_API USHORT __HP_CALL SYS_SwapEndian16(USHORT value);
  1532. /* 长整型高低字节交换 */
  1533. HPSOCKET_API DWORD __HP_CALL SYS_SwapEndian32(DWORD value);
  1534. /* 检查是否小端字节序 */
  1535. HPSOCKET_API BOOL __HP_CALL SYS_IsLittleEndian();
  1536. /* 分配内存 */
  1537. HPSOCKET_API LPBYTE __HP_CALL SYS_Malloc(int size);
  1538. /* 重新分配内存 */
  1539. HPSOCKET_API LPBYTE __HP_CALL SYS_Realloc(LPBYTE p, int size);
  1540. /* 释放内存 */
  1541. HPSOCKET_API VOID __HP_CALL SYS_Free(LPBYTE p);
  1542. /* 分配内存块 */
  1543. HPSOCKET_API LPVOID __HP_CALL SYS_Calloc(int number, int size);
  1544. /* 分配栈内存 */
  1545. HPSOCKET_API LPBYTE __HP_CALL SYS_Alloca(int size);
  1546. // CP_XXX -> UNICODE
  1547. HPSOCKET_API BOOL __HP_CALL SYS_CodePageToUnicodeEx(int iCodePage, const char szSrc[], int iSrcLength, WCHAR szDest[], int* piDestLength);
  1548. // UNICODE -> CP_XXX
  1549. HPSOCKET_API BOOL __HP_CALL SYS_UnicodeToCodePageEx(int iCodePage, const WCHAR szSrc[], int iSrcLength, char szDest[], int* piDestLength);
  1550. // GBK -> UNICODE
  1551. HPSOCKET_API BOOL __HP_CALL SYS_GbkToUnicodeEx(const char szSrc[], int iSrcLength, WCHAR szDest[], int* piDestLength);
  1552. // UNICODE -> GBK
  1553. HPSOCKET_API BOOL __HP_CALL SYS_UnicodeToGbkEx(const WCHAR szSrc[], int iSrcLength, char szDest[], int* piDestLength);
  1554. // UTF8 -> UNICODE
  1555. HPSOCKET_API BOOL __HP_CALL SYS_Utf8ToUnicodeEx(const char szSrc[], int iSrcLength, WCHAR szDest[], int* piDestLength);
  1556. // UNICODE -> UTF8
  1557. HPSOCKET_API BOOL __HP_CALL SYS_UnicodeToUtf8Ex(const WCHAR szSrc[], int iSrcLength, char szDest[], int* piDestLength);
  1558. // GBK -> UTF8
  1559. HPSOCKET_API BOOL __HP_CALL SYS_GbkToUtf8Ex(const char szSrc[], int iSrcLength, char szDest[], int* piDestLength);
  1560. // UTF8 -> GBK
  1561. HPSOCKET_API BOOL __HP_CALL SYS_Utf8ToGbkEx(const char szSrc[], int iSrcLength, char szDest[], int* piDestLength);
  1562. // CP_XXX -> UNICODE
  1563. HPSOCKET_API BOOL __HP_CALL SYS_CodePageToUnicode(int iCodePage, const char szSrc[], WCHAR szDest[], int* piDestLength);
  1564. // UNICODE -> CP_XXX
  1565. HPSOCKET_API BOOL __HP_CALL SYS_UnicodeToCodePage(int iCodePage, const WCHAR szSrc[], char szDest[], int* piDestLength);
  1566. // GBK -> UNICODE
  1567. HPSOCKET_API BOOL __HP_CALL SYS_GbkToUnicode(const char szSrc[], WCHAR szDest[], int* piDestLength);
  1568. // UNICODE -> GBK
  1569. HPSOCKET_API BOOL __HP_CALL SYS_UnicodeToGbk(const WCHAR szSrc[], char szDest[], int* piDestLength);
  1570. // UTF8 -> UNICODE
  1571. HPSOCKET_API BOOL __HP_CALL SYS_Utf8ToUnicode(const char szSrc[], WCHAR szDest[], int* piDestLength);
  1572. // UNICODE -> UTF8
  1573. HPSOCKET_API BOOL __HP_CALL SYS_UnicodeToUtf8(const WCHAR szSrc[], char szDest[], int* piDestLength);
  1574. // GBK -> UTF8
  1575. HPSOCKET_API BOOL __HP_CALL SYS_GbkToUtf8(const char szSrc[], char szDest[], int* piDestLength);
  1576. // UTF8 -> GBK
  1577. HPSOCKET_API BOOL __HP_CALL SYS_Utf8ToGbk(const char szSrc[], char szDest[], int* piDestLength);
  1578. // 计算 Base64 编码后长度
  1579. HPSOCKET_API DWORD __HP_CALL SYS_GuessBase64EncodeBound(DWORD dwSrcLen);
  1580. // 计算 Base64 解码后长度
  1581. HPSOCKET_API DWORD __HP_CALL SYS_GuessBase64DecodeBound(const BYTE* lpszSrc, DWORD dwSrcLen);
  1582. // Base64 编码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1583. HPSOCKET_API int __HP_CALL SYS_Base64Encode(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1584. // Base64 解码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1585. HPSOCKET_API int __HP_CALL SYS_Base64Decode(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1586. // 计算 URL 编码后长度
  1587. HPSOCKET_API DWORD __HP_CALL SYS_GuessUrlEncodeBound(const BYTE* lpszSrc, DWORD dwSrcLen);
  1588. // 计算 URL 解码后长度
  1589. HPSOCKET_API DWORD __HP_CALL SYS_GuessUrlDecodeBound(const BYTE* lpszSrc, DWORD dwSrcLen);
  1590. // URL 编码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1591. HPSOCKET_API int __HP_CALL SYS_UrlEncode(BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1592. // URL 解码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1593. HPSOCKET_API int __HP_CALL SYS_UrlDecode(BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1594. #ifdef _ZLIB_SUPPORT
  1595. // 普通压缩(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1596. //(默认参数:iLevel -> -1,iMethod -> 8,iWindowBits -> 15,iMemLevel -> 8,iStrategy -> 0)
  1597. HPSOCKET_API int __HP_CALL SYS_Compress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1598. // 高级压缩(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1599. HPSOCKET_API int __HP_CALL SYS_CompressEx(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen, int iLevel /*= -1*/, int iMethod /*= 8*/, int iWindowBits /*= 15*/, int iMemLevel /*= 8*/, int iStrategy /*= 0*/);
  1600. // 普通解压(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1601. // (默认参数:iWindowBits -> 15)
  1602. HPSOCKET_API int __HP_CALL SYS_Uncompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1603. // 高级解压(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1604. HPSOCKET_API int __HP_CALL SYS_UncompressEx(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen, int iWindowBits /*= 15*/);
  1605. // 推测压缩结果长度
  1606. HPSOCKET_API DWORD __HP_CALL SYS_GuessCompressBound(DWORD dwSrcLen, BOOL bGZip);
  1607. // Gzip 压缩(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1608. HPSOCKET_API int __HP_CALL SYS_GZipCompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1609. // Gzip 解压(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1610. HPSOCKET_API int __HP_CALL SYS_GZipUncompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1611. // 推测 Gzip 解压结果长度(如果返回 0 或不合理值则说明输入内容并非有效的 Gzip 格式)
  1612. HPSOCKET_API DWORD __HP_CALL SYS_GZipGuessUncompressBound(const BYTE* lpszSrc, DWORD dwSrcLen);
  1613. #endif
  1614. #ifdef _BROTLI_SUPPORT
  1615. // Brotli 压缩(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1616. //(默认参数:iQuality -> 11,iWindow -> 22,iMode -> 0)
  1617. HPSOCKET_API int __HP_CALL SYS_BrotliCompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1618. // Brotli 高级压缩(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1619. HPSOCKET_API int __HP_CALL SYS_BrotliCompressEx(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen, int iQuality /*= 11*/, int iWindow /*= 22*/, int iMode /*= 0*/);
  1620. // Brotli 解压(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
  1621. HPSOCKET_API int __HP_CALL SYS_BrotliUncompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD* pdwDestLen);
  1622. // Brotli 推测压缩结果长度
  1623. HPSOCKET_API DWORD __HP_CALL SYS_BrotliGuessCompressBound(DWORD dwSrcLen);
  1624. #endif
  1625. /*****************************************************************************************************************************************************/
  1626. /******************************************************************** HTTP Exports *******************************************************************/
  1627. /*****************************************************************************************************************************************************/
  1628. #ifdef _HTTP_SUPPORT
  1629. /****************************************************/
  1630. /******************* HTTP 回调函数 *******************/
  1631. /* HTTP 回调函数 */
  1632. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnMessageBegin) (HP_Http pSender, HP_CONNID dwConnID);
  1633. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnRequestLine) (HP_Http pSender, HP_CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl);
  1634. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnStatusLine) (HP_Http pSender, HP_CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc);
  1635. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnHeader) (HP_Http pSender, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue);
  1636. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnHeadersComplete) (HP_Http pSender, HP_CONNID dwConnID);
  1637. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnBody) (HP_Http pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  1638. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnChunkHeader) (HP_Http pSender, HP_CONNID dwConnID, int iLength);
  1639. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnChunkComplete) (HP_Http pSender, HP_CONNID dwConnID);
  1640. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnMessageComplete) (HP_Http pSender, HP_CONNID dwConnID);
  1641. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnUpgrade) (HP_Http pSender, HP_CONNID dwConnID, En_HP_HttpUpgradeType enUpgradeType);
  1642. typedef En_HP_HttpParseResult (__HP_CALL *HP_FN_Http_OnParseError) (HP_Http pSender, HP_CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc);
  1643. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Http_OnWSMessageHeader) (HP_Http pSender, HP_CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen);
  1644. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Http_OnWSMessageBody) (HP_Http pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
  1645. typedef En_HP_HandleResult (__HP_CALL *HP_FN_Http_OnWSMessageComplete)(HP_Http pSender, HP_CONNID dwConnID);
  1646. /* HTTP Server 回调函数 */
  1647. typedef HP_FN_Http_OnMessageBegin HP_FN_HttpServer_OnMessageBegin;
  1648. typedef HP_FN_Http_OnRequestLine HP_FN_HttpServer_OnRequestLine;
  1649. typedef HP_FN_Http_OnHeader HP_FN_HttpServer_OnHeader;
  1650. typedef HP_FN_Http_OnHeadersComplete HP_FN_HttpServer_OnHeadersComplete;
  1651. typedef HP_FN_Http_OnBody HP_FN_HttpServer_OnBody;
  1652. typedef HP_FN_Http_OnChunkHeader HP_FN_HttpServer_OnChunkHeader;
  1653. typedef HP_FN_Http_OnChunkComplete HP_FN_HttpServer_OnChunkComplete;
  1654. typedef HP_FN_Http_OnMessageComplete HP_FN_HttpServer_OnMessageComplete;
  1655. typedef HP_FN_Http_OnUpgrade HP_FN_HttpServer_OnUpgrade;
  1656. typedef HP_FN_Http_OnParseError HP_FN_HttpServer_OnParseError;
  1657. typedef HP_FN_Http_OnWSMessageHeader HP_FN_HttpServer_OnWSMessageHeader;
  1658. typedef HP_FN_Http_OnWSMessageBody HP_FN_HttpServer_OnWSMessageBody;
  1659. typedef HP_FN_Http_OnWSMessageComplete HP_FN_HttpServer_OnWSMessageComplete;
  1660. typedef HP_FN_Server_OnPrepareListen HP_FN_HttpServer_OnPrepareListen;
  1661. typedef HP_FN_Server_OnAccept HP_FN_HttpServer_OnAccept;
  1662. typedef HP_FN_Server_OnHandShake HP_FN_HttpServer_OnHandShake;
  1663. typedef HP_FN_Server_OnReceive HP_FN_HttpServer_OnReceive;
  1664. typedef HP_FN_Server_OnSend HP_FN_HttpServer_OnSend;
  1665. typedef HP_FN_Server_OnClose HP_FN_HttpServer_OnClose;
  1666. typedef HP_FN_Server_OnShutdown HP_FN_HttpServer_OnShutdown;
  1667. /* HTTP Agent 回调函数 */
  1668. typedef HP_FN_Http_OnMessageBegin HP_FN_HttpAgent_OnMessageBegin;
  1669. typedef HP_FN_Http_OnStatusLine HP_FN_HttpAgent_OnStatusLine;
  1670. typedef HP_FN_Http_OnHeader HP_FN_HttpAgent_OnHeader;
  1671. typedef HP_FN_Http_OnHeadersComplete HP_FN_HttpAgent_OnHeadersComplete;
  1672. typedef HP_FN_Http_OnBody HP_FN_HttpAgent_OnBody;
  1673. typedef HP_FN_Http_OnChunkHeader HP_FN_HttpAgent_OnChunkHeader;
  1674. typedef HP_FN_Http_OnChunkComplete HP_FN_HttpAgent_OnChunkComplete;
  1675. typedef HP_FN_Http_OnMessageComplete HP_FN_HttpAgent_OnMessageComplete;
  1676. typedef HP_FN_Http_OnUpgrade HP_FN_HttpAgent_OnUpgrade;
  1677. typedef HP_FN_Http_OnParseError HP_FN_HttpAgent_OnParseError;
  1678. typedef HP_FN_Http_OnWSMessageHeader HP_FN_HttpAgent_OnWSMessageHeader;
  1679. typedef HP_FN_Http_OnWSMessageBody HP_FN_HttpAgent_OnWSMessageBody;
  1680. typedef HP_FN_Http_OnWSMessageComplete HP_FN_HttpAgent_OnWSMessageComplete;
  1681. typedef HP_FN_Agent_OnPrepareConnect HP_FN_HttpAgent_OnPrepareConnect;
  1682. typedef HP_FN_Agent_OnConnect HP_FN_HttpAgent_OnConnect;
  1683. typedef HP_FN_Agent_OnHandShake HP_FN_HttpAgent_OnHandShake;
  1684. typedef HP_FN_Agent_OnReceive HP_FN_HttpAgent_OnReceive;
  1685. typedef HP_FN_Agent_OnSend HP_FN_HttpAgent_OnSend;
  1686. typedef HP_FN_Agent_OnClose HP_FN_HttpAgent_OnClose;
  1687. typedef HP_FN_Agent_OnShutdown HP_FN_HttpAgent_OnShutdown;
  1688. /* HTTP Client 回调函数 */
  1689. typedef HP_FN_Http_OnMessageBegin HP_FN_HttpClient_OnMessageBegin;
  1690. typedef HP_FN_Http_OnStatusLine HP_FN_HttpClient_OnStatusLine;
  1691. typedef HP_FN_Http_OnHeader HP_FN_HttpClient_OnHeader;
  1692. typedef HP_FN_Http_OnHeadersComplete HP_FN_HttpClient_OnHeadersComplete;
  1693. typedef HP_FN_Http_OnBody HP_FN_HttpClient_OnBody;
  1694. typedef HP_FN_Http_OnChunkHeader HP_FN_HttpClient_OnChunkHeader;
  1695. typedef HP_FN_Http_OnChunkComplete HP_FN_HttpClient_OnChunkComplete;
  1696. typedef HP_FN_Http_OnMessageComplete HP_FN_HttpClient_OnMessageComplete;
  1697. typedef HP_FN_Http_OnUpgrade HP_FN_HttpClient_OnUpgrade;
  1698. typedef HP_FN_Http_OnParseError HP_FN_HttpClient_OnParseError;
  1699. typedef HP_FN_Http_OnWSMessageHeader HP_FN_HttpClient_OnWSMessageHeader;
  1700. typedef HP_FN_Http_OnWSMessageBody HP_FN_HttpClient_OnWSMessageBody;
  1701. typedef HP_FN_Http_OnWSMessageComplete HP_FN_HttpClient_OnWSMessageComplete;
  1702. typedef HP_FN_Client_OnPrepareConnect HP_FN_HttpClient_OnPrepareConnect;
  1703. typedef HP_FN_Client_OnConnect HP_FN_HttpClient_OnConnect;
  1704. typedef HP_FN_Client_OnHandShake HP_FN_HttpClient_OnHandShake;
  1705. typedef HP_FN_Client_OnReceive HP_FN_HttpClient_OnReceive;
  1706. typedef HP_FN_Client_OnSend HP_FN_HttpClient_OnSend;
  1707. typedef HP_FN_Client_OnClose HP_FN_HttpClient_OnClose;
  1708. /****************************************************/
  1709. /***************** HTTP 对象创建函数 *****************/
  1710. // 创建 HP_HttpServer 对象
  1711. HPSOCKET_API HP_HttpServer __HP_CALL Create_HP_HttpServer(HP_HttpServerListener pListener);
  1712. // 创建 HP_HttpAgent 对象
  1713. HPSOCKET_API HP_HttpAgent __HP_CALL Create_HP_HttpAgent(HP_HttpAgentListener pListener);
  1714. // 创建 HP_HttpClient 对象
  1715. HPSOCKET_API HP_HttpClient __HP_CALL Create_HP_HttpClient(HP_HttpClientListener pListener);
  1716. // 创建 HP_HttpSyncClient 对象(pListener 参数可传入 nullptr)
  1717. HPSOCKET_API HP_HttpSyncClient __HP_CALL Create_HP_HttpSyncClient(HP_HttpClientListener pListener /*= nullptr*/);
  1718. // 销毁 HP_HttpServer 对象
  1719. HPSOCKET_API void __HP_CALL Destroy_HP_HttpServer(HP_HttpServer pServer);
  1720. // 销毁 HP_HttpAgent 对象
  1721. HPSOCKET_API void __HP_CALL Destroy_HP_HttpAgent(HP_HttpAgent pAgent);
  1722. // 销毁 HP_HttpClient 对象
  1723. HPSOCKET_API void __HP_CALL Destroy_HP_HttpClient(HP_HttpClient pClient);
  1724. // 销毁 HP_HttpSyncClient 对象
  1725. HPSOCKET_API void __HP_CALL Destroy_HP_HttpSyncClient(HP_HttpSyncClient pClient);
  1726. // 创建 HP_HttpServerListener 对象
  1727. HPSOCKET_API HP_HttpServerListener __HP_CALL Create_HP_HttpServerListener();
  1728. // 创建 HP_HttpAgentListener 对象
  1729. HPSOCKET_API HP_HttpAgentListener __HP_CALL Create_HP_HttpAgentListener();
  1730. // 创建 HP_HttpClientListener 对象
  1731. HPSOCKET_API HP_HttpClientListener __HP_CALL Create_HP_HttpClientListener();
  1732. // 销毁 HP_HttpServerListener 对象
  1733. HPSOCKET_API void __HP_CALL Destroy_HP_HttpServerListener(HP_HttpServerListener pListener);
  1734. // 销毁 HP_HttpAgentListener 对象
  1735. HPSOCKET_API void __HP_CALL Destroy_HP_HttpAgentListener(HP_HttpAgentListener pListener);
  1736. // 销毁 HP_HttpClientListener 对象
  1737. HPSOCKET_API void __HP_CALL Destroy_HP_HttpClientListener(HP_HttpClientListener pListener);
  1738. /**********************************************************************************/
  1739. /*************************** HTTP Server 回调函数设置方法 **************************/
  1740. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnMessageBegin(HP_HttpServerListener pListener , HP_FN_HttpServer_OnMessageBegin fn);
  1741. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnRequestLine(HP_HttpServerListener pListener , HP_FN_HttpServer_OnRequestLine fn);
  1742. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnHeader(HP_HttpServerListener pListener , HP_FN_HttpServer_OnHeader fn);
  1743. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnHeadersComplete(HP_HttpServerListener pListener , HP_FN_HttpServer_OnHeadersComplete fn);
  1744. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnBody(HP_HttpServerListener pListener , HP_FN_HttpServer_OnBody fn);
  1745. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnChunkHeader(HP_HttpServerListener pListener , HP_FN_HttpServer_OnChunkHeader fn);
  1746. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnChunkComplete(HP_HttpServerListener pListener , HP_FN_HttpServer_OnChunkComplete fn);
  1747. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnMessageComplete(HP_HttpServerListener pListener , HP_FN_HttpServer_OnMessageComplete fn);
  1748. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnUpgrade(HP_HttpServerListener pListener , HP_FN_HttpServer_OnUpgrade fn);
  1749. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnParseError(HP_HttpServerListener pListener , HP_FN_HttpServer_OnParseError fn);
  1750. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnWSMessageHeader(HP_HttpServerListener pListener , HP_FN_HttpServer_OnWSMessageHeader fn);
  1751. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnWSMessageBody(HP_HttpServerListener pListener , HP_FN_HttpServer_OnWSMessageBody fn);
  1752. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnWSMessageComplete(HP_HttpServerListener pListener, HP_FN_HttpServer_OnWSMessageComplete fn);
  1753. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnPrepareListen(HP_HttpServerListener pListener , HP_FN_HttpServer_OnPrepareListen fn);
  1754. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnAccept(HP_HttpServerListener pListener , HP_FN_HttpServer_OnAccept fn);
  1755. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnHandShake(HP_HttpServerListener pListener , HP_FN_HttpServer_OnHandShake fn);
  1756. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnReceive(HP_HttpServerListener pListener , HP_FN_HttpServer_OnReceive fn);
  1757. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnSend(HP_HttpServerListener pListener , HP_FN_HttpServer_OnSend fn);
  1758. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnClose(HP_HttpServerListener pListener , HP_FN_HttpServer_OnClose fn);
  1759. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpServer_OnShutdown(HP_HttpServerListener pListener , HP_FN_HttpServer_OnShutdown fn);
  1760. /**********************************************************************************/
  1761. /**************************** HTTP Agent 回调函数设置方法 **************************/
  1762. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnMessageBegin(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnMessageBegin fn);
  1763. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnStatusLine(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnStatusLine fn);
  1764. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnHeader(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnHeader fn);
  1765. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnHeadersComplete(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnHeadersComplete fn);
  1766. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnBody(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnBody fn);
  1767. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnChunkHeader(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnChunkHeader fn);
  1768. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnChunkComplete(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnChunkComplete fn);
  1769. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnMessageComplete(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnMessageComplete fn);
  1770. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnUpgrade(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnUpgrade fn);
  1771. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnParseError(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnParseError fn);
  1772. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnWSMessageHeader(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnWSMessageHeader fn);
  1773. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnWSMessageBody(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnWSMessageBody fn);
  1774. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnWSMessageComplete(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnWSMessageComplete fn);
  1775. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnPrepareConnect(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnPrepareConnect fn);
  1776. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnConnect(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnConnect fn);
  1777. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnHandShake(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnHandShake fn);
  1778. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnReceive(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnReceive fn);
  1779. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnSend(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnSend fn);
  1780. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnClose(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnClose fn);
  1781. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpAgent_OnShutdown(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnShutdown fn);
  1782. /**********************************************************************************/
  1783. /*************************** HTTP Client 回调函数设置方法 **************************/
  1784. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnMessageBegin(HP_HttpClientListener pListener , HP_FN_HttpClient_OnMessageBegin fn);
  1785. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnStatusLine(HP_HttpClientListener pListener , HP_FN_HttpClient_OnStatusLine fn);
  1786. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnHeader(HP_HttpClientListener pListener , HP_FN_HttpClient_OnHeader fn);
  1787. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnHeadersComplete(HP_HttpClientListener pListener , HP_FN_HttpClient_OnHeadersComplete fn);
  1788. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnBody(HP_HttpClientListener pListener , HP_FN_HttpClient_OnBody fn);
  1789. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnChunkHeader(HP_HttpClientListener pListener , HP_FN_HttpClient_OnChunkHeader fn);
  1790. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnChunkComplete(HP_HttpClientListener pListener , HP_FN_HttpClient_OnChunkComplete fn);
  1791. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnMessageComplete(HP_HttpClientListener pListener , HP_FN_HttpClient_OnMessageComplete fn);
  1792. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnUpgrade(HP_HttpClientListener pListener , HP_FN_HttpClient_OnUpgrade fn);
  1793. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnParseError(HP_HttpClientListener pListener , HP_FN_HttpClient_OnParseError fn);
  1794. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnWSMessageHeader(HP_HttpClientListener pListener , HP_FN_HttpClient_OnWSMessageHeader fn);
  1795. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnWSMessageBody(HP_HttpClientListener pListener , HP_FN_HttpClient_OnWSMessageBody fn);
  1796. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnWSMessageComplete(HP_HttpClientListener pListener, HP_FN_HttpClient_OnWSMessageComplete fn);
  1797. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnPrepareConnect(HP_HttpClientListener pListener , HP_FN_HttpClient_OnPrepareConnect fn);
  1798. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnConnect(HP_HttpClientListener pListener , HP_FN_HttpClient_OnConnect fn);
  1799. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnHandShake(HP_HttpClientListener pListener , HP_FN_HttpClient_OnHandShake fn);
  1800. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnReceive(HP_HttpClientListener pListener , HP_FN_HttpClient_OnReceive fn);
  1801. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnSend(HP_HttpClientListener pListener , HP_FN_HttpClient_OnSend fn);
  1802. HPSOCKET_API void __HP_CALL HP_Set_FN_HttpClient_OnClose(HP_HttpClientListener pListener , HP_FN_HttpClient_OnClose fn);
  1803. /**************************************************************************/
  1804. /*************************** HTTP Server 操作方法 **************************/
  1805. /*
  1806. * 名称:回复请求
  1807. * 描述:向客户端回复 HTTP 请求
  1808. *
  1809. * 参数: dwConnID -- 连接 ID
  1810. * usStatusCode -- HTTP 状态码
  1811. * lpszDesc -- HTTP 状态描述
  1812. * lpHeaders -- 回复请求头
  1813. * iHeaderCount -- 回复请求头数量
  1814. * pData -- 回复请求体
  1815. * iLength -- 回复请求体长度
  1816. * 返回值: TRUE -- 成功
  1817. * FALSE -- 失败
  1818. */
  1819. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_SendResponse(HP_HttpServer pServer, HP_CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pData, int iLength);
  1820. /*
  1821. * 名称:发送本地文件
  1822. * 描述:向指定连接发送 4096 KB 以下的小文件
  1823. *
  1824. * 参数: dwConnID -- 连接 ID
  1825. * lpszFileName -- 文件路径
  1826. * usStatusCode -- HTTP 状态码
  1827. * lpszDesc -- HTTP 状态描述
  1828. * lpHeaders -- 回复请求头
  1829. * iHeaderCount -- 回复请求头数量
  1830. * 返回值: TRUE -- 成功
  1831. * FALSE -- 失败
  1832. */
  1833. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_SendLocalFile(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszFileName, USHORT usStatusCode, LPCSTR lpszDesc, const HP_THeader lpHeaders[], int iHeaderCount);
  1834. /*
  1835. * 名称:发送 Chunked 数据分片
  1836. * 描述:向对端发送 Chunked 数据分片
  1837. *
  1838. * 参数: dwConnID -- 连接 ID
  1839. * pData -- Chunked 数据分片
  1840. * iLength -- 数据分片长度(为 0 表示结束分片)
  1841. * lpszExtensions -- 扩展属性(默认:nullptr)
  1842. * 返回值: TRUE -- 成功
  1843. * FALSE -- 失败
  1844. */
  1845. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_SendChunkData(HP_HttpServer pServer, HP_CONNID dwConnID, const BYTE* pData /*= nullptr*/, int iLength /*= 0*/, LPCSTR lpszExtensions /*= nullptr*/);
  1846. /*
  1847. * 名称:发送 WebSocket 消息
  1848. * 描述:向对端端发送 WebSocket 消息
  1849. *
  1850. * 参数: dwConnID -- 连接 ID
  1851. * bFinal -- 是否结束帧
  1852. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  1853. * iOperationCode -- 操作码:0x0 - 0xF
  1854. * pData -- 消息体数据缓冲区
  1855. * iLength -- 消息体数据长度
  1856. * ullBodyLen -- 消息总长度
  1857. * ullBodyLen = 0 -> 消息总长度为 iLength
  1858. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  1859. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  1860. * ullBodyLen < iLength -> 错误参数,发送失败
  1861. * 返回值: TRUE -- 成功
  1862. * FALSE -- 失败
  1863. */
  1864. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_SendWSMessage(HP_HttpServer pServer, HP_CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE* pData, int iLength, ULONGLONG ullBodyLen);
  1865. /*
  1866. * 名称:释放连接
  1867. * 描述:把连接放入释放队列,等待某个时间(通过 SetReleaseDelay() 设置)关闭连接
  1868. *
  1869. * 参数: dwConnID -- 连接 ID
  1870. * 返回值: TRUE -- 成功
  1871. * FALSE -- 失败
  1872. */
  1873. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_Release(HP_HttpServer pServer, HP_CONNID dwConnID);
  1874. /*
  1875. * 名称:启动 HTTP 通信
  1876. * 描述:当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信
  1877. *
  1878. * 返回值: TRUE -- 成功
  1879. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  1880. */
  1881. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_StartHttp(HP_HttpServer pServer, HP_CONNID dwConnID);
  1882. /******************************************************************************/
  1883. /*************************** HTTP Server 属性访问方法 **************************/
  1884. /* 设置连接释放延时(默认:3000 毫秒) */
  1885. HPSOCKET_API void __HP_CALL HP_HttpServer_SetReleaseDelay(HP_HttpServer pServer, DWORD dwReleaseDelay);
  1886. /* 获取连接释放延时 */
  1887. HPSOCKET_API DWORD __HP_CALL HP_HttpServer_GetReleaseDelay(HP_HttpServer pServer);
  1888. /* 获取请求行 URL 域掩码(URL 域参考:EnHttpUrlField) */
  1889. HPSOCKET_API USHORT __HP_CALL HP_HttpServer_GetUrlFieldSet(HP_HttpServer pServer, HP_CONNID dwConnID);
  1890. /* 获取某个 URL 域值 */
  1891. HPSOCKET_API LPCSTR __HP_CALL HP_HttpServer_GetUrlField(HP_HttpServer pServer, HP_CONNID dwConnID, En_HP_HttpUrlField enField);
  1892. /* 获取请求方法 */
  1893. HPSOCKET_API LPCSTR __HP_CALL HP_HttpServer_GetMethod(HP_HttpServer pServer, HP_CONNID dwConnID);
  1894. /* 设置本地协议版本 */
  1895. HPSOCKET_API void __HP_CALL HP_HttpServer_SetLocalVersion(HP_HttpServer pServer, En_HP_HttpVersion usVersion);
  1896. /* 获取本地协议版本 */
  1897. HPSOCKET_API En_HP_HttpVersion __HP_CALL HP_HttpServer_GetLocalVersion(HP_HttpServer pServer);
  1898. /* 检查是否升级协议 */
  1899. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_IsUpgrade(HP_HttpServer pServer, HP_CONNID dwConnID);
  1900. /* 检查是否有 Keep-Alive 标识 */
  1901. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_IsKeepAlive(HP_HttpServer pServer, HP_CONNID dwConnID);
  1902. /* 获取协议版本 */
  1903. HPSOCKET_API USHORT __HP_CALL HP_HttpServer_GetVersion(HP_HttpServer pServer, HP_CONNID dwConnID);
  1904. /* 获取主机 */
  1905. HPSOCKET_API LPCSTR __HP_CALL HP_HttpServer_GetHost(HP_HttpServer pServer, HP_CONNID dwConnID);
  1906. /* 获取内容长度 */
  1907. HPSOCKET_API ULONGLONG __HP_CALL HP_HttpServer_GetContentLength(HP_HttpServer pServer, HP_CONNID dwConnID);
  1908. /* 获取内容类型 */
  1909. HPSOCKET_API LPCSTR __HP_CALL HP_HttpServer_GetContentType(HP_HttpServer pServer, HP_CONNID dwConnID);
  1910. /* 获取内容编码 */
  1911. HPSOCKET_API LPCSTR __HP_CALL HP_HttpServer_GetContentEncoding(HP_HttpServer pServer, HP_CONNID dwConnID);
  1912. /* 获取传输编码 */
  1913. HPSOCKET_API LPCSTR __HP_CALL HP_HttpServer_GetTransferEncoding(HP_HttpServer pServer, HP_CONNID dwConnID);
  1914. /* 获取协议升级类型 */
  1915. HPSOCKET_API En_HP_HttpUpgradeType __HP_CALL HP_HttpServer_GetUpgradeType(HP_HttpServer pServer, HP_CONNID dwConnID);
  1916. /* 获取解析错误代码 */
  1917. HPSOCKET_API USHORT __HP_CALL HP_HttpServer_GetParseErrorCode(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR* lpszErrorDesc);
  1918. /* 获取某个请求头(单值) */
  1919. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_GetHeader(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue);
  1920. /* 获取某个请求头(多值) */
  1921. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_GetHeaders(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD* pdwCount);
  1922. /* 获取所有请求头 */
  1923. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_GetAllHeaders(HP_HttpServer pServer, HP_CONNID dwConnID, HP_THeader lpHeaders[], DWORD* pdwCount);
  1924. /* 获取所有请求头名称 */
  1925. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_GetAllHeaderNames(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName[], DWORD* pdwCount);
  1926. /* 获取 Cookie */
  1927. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_GetCookie(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue);
  1928. /* 获取所有 Cookie */
  1929. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_GetAllCookies(HP_HttpServer pServer, HP_CONNID dwConnID, HP_TCookie lpCookies[], DWORD* pdwCount);
  1930. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  1931. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_GetWSMessageState(HP_HttpServer pServer, HP_CONNID dwConnID, BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain);
  1932. /* 设置 HTTP 启动方式(默认:TRUE,自动启动) */
  1933. HPSOCKET_API void __HP_CALL HP_HttpServer_SetHttpAutoStart(HP_HttpServer pServer, BOOL bAutoStart);
  1934. /* 获取 HTTP 启动方式 */
  1935. HPSOCKET_API BOOL __HP_CALL HP_HttpServer_IsHttpAutoStart(HP_HttpServer pServer);
  1936. /**************************************************************************/
  1937. /*************************** HTTP Agent 操作方法 ***************************/
  1938. /*
  1939. * 名称:发送请求
  1940. * 描述:向服务端发送 HTTP 请求
  1941. *
  1942. * 参数: dwConnID -- 连接 ID
  1943. * lpszMethod -- 请求方法
  1944. * lpszPath -- 请求路径
  1945. * lpHeaders -- 请求头
  1946. * iHeaderCount -- 请求头数量
  1947. * pBody -- 请求体
  1948. * iLength -- 请求体长度
  1949. * 返回值: TRUE -- 成功
  1950. * FALSE -- 失败
  1951. */
  1952. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendRequest(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pData, int iLength);
  1953. /*
  1954. * 名称:发送本地文件
  1955. * 描述:向指定连接发送 4096 KB 以下的小文件
  1956. *
  1957. * 参数: dwConnID -- 连接 ID
  1958. * lpszFileName -- 文件路径
  1959. * lpszMethod -- 请求方法
  1960. * lpszPath -- 请求路径
  1961. * lpHeaders -- 请求头
  1962. * iHeaderCount -- 请求头数量
  1963. * 返回值: TRUE -- 成功
  1964. * FALSE -- 失败
  1965. */
  1966. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendLocalFile(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  1967. /*
  1968. * 名称:发送 Chunked 数据分片
  1969. * 描述:向对端发送 Chunked 数据分片
  1970. *
  1971. * 参数: dwConnID -- 连接 ID
  1972. * pData -- Chunked 数据分片
  1973. * iLength -- 数据分片长度(为 0 表示结束分片)
  1974. * lpszExtensions -- 扩展属性(默认:nullptr)
  1975. * 返回值: TRUE -- 成功
  1976. * FALSE -- 失败
  1977. */
  1978. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendChunkData(HP_HttpAgent pAgent, HP_CONNID dwConnID, const BYTE* pData /*= nullptr*/, int iLength /*= 0*/, LPCSTR lpszExtensions /*= nullptr*/);
  1979. /* 发送 POST 请求 */
  1980. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendPost(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength);
  1981. /* 发送 PUT 请求 */
  1982. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendPut(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength);
  1983. /* 发送 PATCH 请求 */
  1984. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendPatch(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength);
  1985. /* 发送 GET 请求 */
  1986. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendGet(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  1987. /* 发送 DELETE 请求 */
  1988. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendDelete(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  1989. /* 发送 HEAD 请求 */
  1990. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendHead(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  1991. /* 发送 TRACE 请求 */
  1992. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendTrace(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  1993. /* 发送 OPTIONS 请求 */
  1994. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendOptions(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  1995. /* 发送 CONNECT 请求 */
  1996. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendConnect(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszHost, const HP_THeader lpHeaders[], int iHeaderCount);
  1997. /*
  1998. * 名称:发送 WebSocket 消息
  1999. * 描述:向对端端发送 WebSocket 消息
  2000. *
  2001. * 参数: dwConnID -- 连接 ID
  2002. * bFinal -- 是否结束帧
  2003. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  2004. * iOperationCode -- 操作码:0x0 - 0xF
  2005. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  2006. * pData -- 消息体数据缓冲区
  2007. * iLength -- 消息体数据长度
  2008. * ullBodyLen -- 消息总长度
  2009. * ullBodyLen = 0 -> 消息总长度为 iLength
  2010. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  2011. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  2012. * ullBodyLen < iLength -> 错误参数,发送失败
  2013. * 返回值: TRUE -- 成功
  2014. * FALSE -- 失败
  2015. */
  2016. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_SendWSMessage(HP_HttpAgent pAgent, HP_CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], const BYTE* pData, int iLength, ULONGLONG ullBodyLen);
  2017. /*
  2018. * 名称:启动 HTTP 通信
  2019. * 描述:当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信
  2020. *
  2021. * 返回值: TRUE -- 成功
  2022. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  2023. */
  2024. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_StartHttp(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2025. /******************************************************************************/
  2026. /*************************** HTTP Agent 属性访问方法 ***************************/
  2027. /* 获取 HTTP 状态码 */
  2028. HPSOCKET_API USHORT __HP_CALL HP_HttpAgent_GetStatusCode(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2029. /* 设置本地协议版本 */
  2030. HPSOCKET_API void __HP_CALL HP_HttpAgent_SetLocalVersion(HP_HttpAgent pAgent, En_HP_HttpVersion usVersion);
  2031. /* 获取本地协议版本 */
  2032. HPSOCKET_API En_HP_HttpVersion __HP_CALL HP_HttpAgent_GetLocalVersion(HP_HttpAgent pAgent);
  2033. /* 检查是否升级协议 */
  2034. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_IsUpgrade(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2035. /* 检查是否有 Keep-Alive 标识 */
  2036. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_IsKeepAlive(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2037. /* 获取协议版本 */
  2038. HPSOCKET_API USHORT __HP_CALL HP_HttpAgent_GetVersion(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2039. /* 获取内容长度 */
  2040. HPSOCKET_API ULONGLONG __HP_CALL HP_HttpAgent_GetContentLength(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2041. /* 获取内容类型 */
  2042. HPSOCKET_API LPCSTR __HP_CALL HP_HttpAgent_GetContentType(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2043. /* 获取内容编码 */
  2044. HPSOCKET_API LPCSTR __HP_CALL HP_HttpAgent_GetContentEncoding(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2045. /* 获取传输编码 */
  2046. HPSOCKET_API LPCSTR __HP_CALL HP_HttpAgent_GetTransferEncoding(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2047. /* 获取协议升级类型 */
  2048. HPSOCKET_API En_HP_HttpUpgradeType __HP_CALL HP_HttpAgent_GetUpgradeType(HP_HttpAgent pAgent, HP_CONNID dwConnID);
  2049. /* 获取解析错误代码 */
  2050. HPSOCKET_API USHORT __HP_CALL HP_HttpAgent_GetParseErrorCode(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR* lpszErrorDesc);
  2051. /* 获取某个请求头(单值) */
  2052. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_GetHeader(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue);
  2053. /* 获取某个请求头(多值) */
  2054. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_GetHeaders(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD* pdwCount);
  2055. /* 获取所有请求头 */
  2056. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_GetAllHeaders(HP_HttpAgent pAgent, HP_CONNID dwConnID, HP_THeader lpHeaders[], DWORD* pdwCount);
  2057. /* 获取所有请求头名称 */
  2058. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_GetAllHeaderNames(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName[], DWORD* pdwCount);
  2059. /* 设置是否使用 Cookie */
  2060. HPSOCKET_API void __HP_CALL HP_HttpAgent_SetUseCookie(HP_HttpAgent pAgent, BOOL bUseCookie);
  2061. /* 检查是否使用 Cookie */
  2062. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_IsUseCookie(HP_HttpAgent pAgent);
  2063. /* 获取 Cookie */
  2064. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_GetCookie(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue);
  2065. /* 获取所有 Cookie */
  2066. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_GetAllCookies(HP_HttpAgent pAgent, HP_CONNID dwConnID, HP_TCookie lpCookies[], DWORD* pdwCount);
  2067. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  2068. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_GetWSMessageState(HP_HttpAgent pAgent, HP_CONNID dwConnID, BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain);
  2069. /* 设置 HTTP 启动方式(默认:TRUE,自动启动) */
  2070. HPSOCKET_API void __HP_CALL HP_HttpAgent_SetHttpAutoStart(HP_HttpAgent pAgent, BOOL bAutoStart);
  2071. /* 获取 HTTP 启动方式 */
  2072. HPSOCKET_API BOOL __HP_CALL HP_HttpAgent_IsHttpAutoStart(HP_HttpAgent pAgent);
  2073. /**************************************************************************/
  2074. /*************************** HTTP Client 操作方法 **************************/
  2075. /*
  2076. * 名称:发送请求
  2077. * 描述:向服务端发送 HTTP 请求
  2078. *
  2079. * 参数: lpszMethod -- 请求方法
  2080. * lpszPath -- 请求路径
  2081. * lpHeaders -- 请求头
  2082. * iHeaderCount -- 请求头数量
  2083. * pBody -- 请求体
  2084. * iLength -- 请求体长度
  2085. * 返回值: TRUE -- 成功
  2086. * FALSE -- 失败
  2087. */
  2088. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendRequest(HP_HttpClient pClient, LPCSTR lpszMethod, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength);
  2089. /*
  2090. * 名称:发送本地文件
  2091. * 描述:向指定连接发送 4096 KB 以下的小文件
  2092. *
  2093. * 参数: dwConnID -- 连接 ID
  2094. * lpszFileName -- 文件路径
  2095. * lpszMethod -- 请求方法
  2096. * lpszPath -- 请求路径
  2097. * lpHeaders -- 请求头
  2098. * iHeaderCount -- 请求头数量
  2099. * 返回值: TRUE -- 成功
  2100. * FALSE -- 失败
  2101. */
  2102. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendLocalFile(HP_HttpClient pClient, LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  2103. /*
  2104. * 名称:发送 Chunked 数据分片
  2105. * 描述:向对端发送 Chunked 数据分片
  2106. *
  2107. * 参数: pData -- Chunked 数据分片
  2108. * iLength -- 数据分片长度(为 0 表示结束分片)
  2109. * lpszExtensions -- 扩展属性(默认:nullptr)
  2110. * 返回值: TRUE -- 成功
  2111. * FALSE -- 失败
  2112. */
  2113. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendChunkData(HP_HttpClient pClient, const BYTE* pData /*= nullptr*/, int iLength /*= 0*/, LPCSTR lpszExtensions /*= nullptr*/);
  2114. /* 发送 POST 请求 */
  2115. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendPost(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength);
  2116. /* 发送 PUT 请求 */
  2117. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendPut(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength);
  2118. /* 发送 PATCH 请求 */
  2119. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendPatch(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength);
  2120. /* 发送 GET 请求 */
  2121. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendGet(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  2122. /* 发送 DELETE 请求 */
  2123. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendDelete(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  2124. /* 发送 HEAD 请求 */
  2125. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendHead(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  2126. /* 发送 TRACE 请求 */
  2127. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendTrace(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  2128. /* 发送 OPTIONS 请求 */
  2129. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendOptions(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount);
  2130. /* 发送 CONNECT 请求 */
  2131. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendConnect(HP_HttpClient pClient, LPCSTR lpszHost, const HP_THeader lpHeaders[], int iHeaderCount);
  2132. /*
  2133. * 名称:发送 WebSocket 消息
  2134. * 描述:向对端端发送 WebSocket 消息
  2135. *
  2136. * 参数: bFinal -- 是否结束帧
  2137. * iReserved -- RSV1/RSV2/RSV3 各 1 位
  2138. * iOperationCode -- 操作码:0x0 - 0xF
  2139. * lpszMask -- 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
  2140. * pData -- 消息体数据缓冲区
  2141. * iLength -- 消息体数据长度
  2142. * ullBodyLen -- 消息总长度
  2143. * ullBodyLen = 0 -> 消息总长度为 iLength
  2144. * ullBodyLen = iLength -> 消息总长度为 ullBodyLen
  2145. * ullBodyLen > iLength -> 消息总长度为 ullBodyLen,后续消息体长度为 ullBOdyLen - iLength,后续消息体通过底层方法 Send() / SendPackets() 发送
  2146. * ullBodyLen < iLength -> 错误参数,发送失败
  2147. * 返回值: TRUE -- 成功
  2148. * FALSE -- 失败
  2149. */
  2150. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_SendWSMessage(HP_HttpClient pClient, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], const BYTE* pData, int iLength, ULONGLONG ullBodyLen);
  2151. /*
  2152. * 名称:启动 HTTP 通信
  2153. * 描述:当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信
  2154. *
  2155. * 返回值: TRUE -- 成功
  2156. * FALSE -- 失败,可通过 SYS_GetLastError() 获取失败原因
  2157. */
  2158. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_StartHttp(HP_HttpClient pClient);
  2159. /******************************************************************************/
  2160. /*************************** HTTP Client 属性访问方法 **************************/
  2161. /* 获取 HTTP 状态码 */
  2162. HPSOCKET_API USHORT __HP_CALL HP_HttpClient_GetStatusCode(HP_HttpClient pClient);
  2163. /* 设置本地协议版本 */
  2164. HPSOCKET_API void __HP_CALL HP_HttpClient_SetLocalVersion(HP_HttpClient pClient, En_HP_HttpVersion usVersion);
  2165. /* 获取本地协议版本 */
  2166. HPSOCKET_API En_HP_HttpVersion __HP_CALL HP_HttpClient_GetLocalVersion(HP_HttpClient pClient);
  2167. /* 检查是否升级协议 */
  2168. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_IsUpgrade(HP_HttpClient pClient);
  2169. /* 检查是否有 Keep-Alive 标识 */
  2170. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_IsKeepAlive(HP_HttpClient pClient);
  2171. /* 获取协议版本 */
  2172. HPSOCKET_API USHORT __HP_CALL HP_HttpClient_GetVersion(HP_HttpClient pClient);
  2173. /* 获取内容长度 */
  2174. HPSOCKET_API ULONGLONG __HP_CALL HP_HttpClient_GetContentLength(HP_HttpClient pClient);
  2175. /* 获取内容类型 */
  2176. HPSOCKET_API LPCSTR __HP_CALL HP_HttpClient_GetContentType(HP_HttpClient pClient);
  2177. /* 获取内容编码 */
  2178. HPSOCKET_API LPCSTR __HP_CALL HP_HttpClient_GetContentEncoding(HP_HttpClient pClient);
  2179. /* 获取传输编码 */
  2180. HPSOCKET_API LPCSTR __HP_CALL HP_HttpClient_GetTransferEncoding(HP_HttpClient pClient);
  2181. /* 获取协议升级类型 */
  2182. HPSOCKET_API En_HP_HttpUpgradeType __HP_CALL HP_HttpClient_GetUpgradeType(HP_HttpClient pClient);
  2183. /* 获取解析错误代码 */
  2184. HPSOCKET_API USHORT __HP_CALL HP_HttpClient_GetParseErrorCode(HP_HttpClient pClient, LPCSTR* lpszErrorDesc);
  2185. /* 获取某个请求头(单值) */
  2186. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_GetHeader(HP_HttpClient pClient, LPCSTR lpszName, LPCSTR* lpszValue);
  2187. /* 获取某个请求头(多值) */
  2188. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_GetHeaders(HP_HttpClient pClient, LPCSTR lpszName, LPCSTR lpszValue[], DWORD* pdwCount);
  2189. /* 获取所有请求头 */
  2190. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_GetAllHeaders(HP_HttpClient pClient, HP_THeader lpHeaders[], DWORD* pdwCount);
  2191. /* 获取所有请求头名称 */
  2192. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_GetAllHeaderNames(HP_HttpClient pClient, LPCSTR lpszName[], DWORD* pdwCount);
  2193. /* 设置是否使用 Cookie */
  2194. HPSOCKET_API void __HP_CALL HP_HttpClient_SetUseCookie(HP_HttpClient pClient, BOOL bUseCookie);
  2195. /* 检查是否使用 Cookie */
  2196. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_IsUseCookie(HP_HttpClient pClient);
  2197. /* 获取 Cookie */
  2198. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_GetCookie(HP_HttpClient pClient, LPCSTR lpszName, LPCSTR* lpszValue);
  2199. /* 获取所有 Cookie */
  2200. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_GetAllCookies(HP_HttpClient pClient, HP_TCookie lpCookies[], DWORD* pdwCount);
  2201. /* 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段 */
  2202. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_GetWSMessageState(HP_HttpClient pClient, BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain);
  2203. /* 设置 HTTP 启动方式(默认:TRUE,自动启动) */
  2204. HPSOCKET_API void __HP_CALL HP_HttpClient_SetHttpAutoStart(HP_HttpClient pClient, BOOL bAutoStart);
  2205. /* 获取 HTTP 启动方式 */
  2206. HPSOCKET_API BOOL __HP_CALL HP_HttpClient_IsHttpAutoStart(HP_HttpClient pClient);
  2207. /**************************************************************************/
  2208. /************************ HTTP Sync Client 操作方法 ************************/
  2209. /*
  2210. * 名称:发送 URL 请求
  2211. * 描述:向服务端发送 HTTP URL 请求
  2212. *
  2213. * 参数: lpszMethod -- 请求方法
  2214. * lpszUrl -- 请求 URL
  2215. * lpHeaders -- 请求头
  2216. * iHeaderCount -- 请求头数量
  2217. * pBody -- 请求体
  2218. * iLength -- 请求体长度
  2219. * bForceReconnect -- 强制重新连接(默认:FALSE,当请求 URL 的主机和端口与现有连接一致时,重用现有连接)
  2220. * 返回值: TRUE -- 成功
  2221. * FALSE -- 失败
  2222. */
  2223. HPSOCKET_API BOOL __HP_CALL HP_HttpSyncClient_OpenUrl(HP_HttpSyncClient pClient, LPCSTR lpszMethod, LPCSTR lpszUrl, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength, BOOL bForceReconnect);
  2224. /*
  2225. * 名称:清除请求结果
  2226. * 描述:清除上一次请求的响应头和响应体等结果信息(该方法会在每次发送请求前自动调用)
  2227. *
  2228. * 参数:
  2229. * 返回值: TRUE -- 成功
  2230. * FALSE -- 失败
  2231. */
  2232. HPSOCKET_API BOOL __HP_CALL HP_HttpSyncClient_CleanupRequestResult(HP_HttpSyncClient pClient);
  2233. /******************************************************************************/
  2234. /************************ HTTP Sync Client 属性访问方法 ************************/
  2235. /* 设置连接超时(毫秒,0:系统默认超时,默认:5000) */
  2236. HPSOCKET_API void __HP_CALL HP_HttpSyncClient_SetConnectTimeout(HP_HttpSyncClient pClient, DWORD dwConnectTimeout);
  2237. /* 设置请求超时(毫秒,0:无限等待,默认:10000) */
  2238. HPSOCKET_API void __HP_CALL HP_HttpSyncClient_SetRequestTimeout(HP_HttpSyncClient pClient, DWORD dwRequestTimeout);
  2239. /* 获取连接超时 */
  2240. HPSOCKET_API DWORD __HP_CALL HP_HttpSyncClient_GetConnectTimeout(HP_HttpSyncClient pClient);
  2241. /* 获取请求超时 */
  2242. HPSOCKET_API DWORD __HP_CALL HP_HttpSyncClient_GetRequestTimeout(HP_HttpSyncClient pClient);
  2243. /* 获取响应体 */
  2244. HPSOCKET_API BOOL __HP_CALL HP_HttpSyncClient_GetResponseBody(HP_HttpSyncClient pClient, LPCBYTE* lpszBody, int* piLength);
  2245. /**************************************************************************/
  2246. /*************************** HTTP Cookie 管理方法 **************************/
  2247. /* 从文件加载 Cookie */
  2248. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_MGR_LoadFromFile(LPCSTR lpszFile, BOOL bKeepExists /*= TRUE*/);
  2249. /* 保存 Cookie 到文件 */
  2250. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_MGR_SaveToFile(LPCSTR lpszFile, BOOL bKeepExists /*= TRUE*/);
  2251. /* 清理 Cookie */
  2252. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_MGR_ClearCookies(LPCSTR lpszDomain /*= nullptr*/, LPCSTR lpszPath /*= nullptr*/);
  2253. /* 清理过期 Cookie */
  2254. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_MGR_RemoveExpiredCookies(LPCSTR lpszDomain /*= nullptr*/, LPCSTR lpszPath /*= nullptr*/);
  2255. /* 设置 Cookie */
  2256. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_MGR_SetCookie(LPCSTR lpszName, LPCSTR lpszValue, LPCSTR lpszDomain, LPCSTR lpszPath, int iMaxAge /*= -1*/, BOOL bHttpOnly /*= FALSE*/, BOOL bSecure /*= FALSE*/, int enSameSite /*= 0*/, BOOL bOnlyUpdateValueIfExists /*= TRUE*/);
  2257. /* 删除 Cookie */
  2258. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_MGR_DeleteCookie(LPCSTR lpszDomain, LPCSTR lpszPath, LPCSTR lpszName);
  2259. /* 设置是否允许第三方 Cookie */
  2260. HPSOCKET_API void __HP_CALL HP_HttpCookie_MGR_SetEnableThirdPartyCookie(BOOL bEnableThirdPartyCookie /*= TRUE*/);
  2261. /* 检查是否允许第三方 Cookie */
  2262. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_MGR_IsEnableThirdPartyCookie();
  2263. /* Cookie expires 字符串转换为整数 */
  2264. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_HLP_ParseExpires(LPCSTR lpszExpires, __time64_t* ptmExpires);
  2265. /* 整数转换为 Cookie expires 字符串 */
  2266. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_HLP_MakeExpiresStr(char lpszBuff[], int* piBuffLen, __time64_t tmExpires);
  2267. /* 生成 Cookie 字符串 */
  2268. HPSOCKET_API BOOL __HP_CALL HP_HttpCookie_HLP_ToString(char lpszBuff[], int* piBuffLen, LPCSTR lpszName, LPCSTR lpszValue, LPCSTR lpszDomain, LPCSTR lpszPath, int iMaxAge /*= -1*/, BOOL bHttpOnly /*= FALSE*/, BOOL bSecure /*= FALSE*/, int enSameSite /*= 0*/);
  2269. /* 获取当前 UTC 时间 */
  2270. HPSOCKET_API __time64_t __HP_CALL HP_HttpCookie_HLP_CurrentUTCTime();
  2271. /* Max-Age -> expires */
  2272. HPSOCKET_API __time64_t __HP_CALL HP_HttpCookie_HLP_MaxAgeToExpires(int iMaxAge);
  2273. /* expires -> Max-Age */
  2274. HPSOCKET_API int __HP_CALL HP_HttpCookie_HLP_ExpiresToMaxAge(__time64_t tmExpires);
  2275. /*****************************************************************************************************************************************************/
  2276. /************************************************************* HTTP Global Function Exports **********************************************************/
  2277. /*****************************************************************************************************************************************************/
  2278. #endif
  2279. /*****************************************************************************************************************************************************/
  2280. /**************************************************************** Thread Pool Exports ****************************************************************/
  2281. /*****************************************************************************************************************************************************/
  2282. /* Thread Pool 回调函数 */
  2283. typedef void (__HP_CALL *HP_FN_ThreadPool_OnStartup) (HP_ThreadPool pThreadPool);
  2284. typedef void (__HP_CALL *HP_FN_ThreadPool_OnShutdown) (HP_ThreadPool pThreadPool);
  2285. typedef void (__HP_CALL *HP_FN_ThreadPool_OnWorkerThreadStart) (HP_ThreadPool pThreadPool, THR_ID dwThreadID);
  2286. typedef void (__HP_CALL *HP_FN_ThreadPool_OnWorkerThreadEnd) (HP_ThreadPool pThreadPool, THR_ID dwThreadID);
  2287. /**********************************************************************************/
  2288. /************************** Thread Pool 回调函数设置方法 ***************************/
  2289. HPSOCKET_API void __HP_CALL HP_Set_FN_ThreadPool_OnStartup(HP_ThreadPoolListener pListener , HP_FN_ThreadPool_OnStartup fn);
  2290. HPSOCKET_API void __HP_CALL HP_Set_FN_ThreadPool_OnShutdown(HP_ThreadPoolListener pListener , HP_FN_ThreadPool_OnShutdown fn);
  2291. HPSOCKET_API void __HP_CALL HP_Set_FN_ThreadPool_OnWorkerThreadStart(HP_ThreadPoolListener pListener , HP_FN_ThreadPool_OnWorkerThreadStart fn);
  2292. HPSOCKET_API void __HP_CALL HP_Set_FN_ThreadPool_OnWorkerThreadEnd(HP_ThreadPoolListener pListener , HP_FN_ThreadPool_OnWorkerThreadEnd fn);
  2293. /****************************************************/
  2294. /******************* 对象创建函数 ********************/
  2295. // 创建 IHPThreadPoolListener 对象
  2296. HPSOCKET_API HP_ThreadPoolListener __HP_CALL Create_HP_ThreadPoolListener();
  2297. // 销毁 IHPThreadPoolListener 对象
  2298. HPSOCKET_API void __HP_CALL Destroy_HP_ThreadPoolListener(HP_ThreadPoolListener pListener);
  2299. // 创建 IHPThreadPool 对象(pListener 参数可传入 nullptr)
  2300. HPSOCKET_API HP_ThreadPool __HP_CALL Create_HP_ThreadPool(HP_ThreadPoolListener pListener /*= nullptr*/);
  2301. // 销毁 IHPThreadPool 对象
  2302. HPSOCKET_API void __HP_CALL Destroy_HP_ThreadPool(HP_ThreadPool pThreadPool);
  2303. /*
  2304. * 名称:创建 TSocketTask 对象
  2305. * 描述:创建任务对象,该对象最终需由 HP_Destroy_SocketTaskObj() 销毁
  2306. *
  2307. * 参数: fnTaskProc -- 任务处理函数
  2308. * pSender -- 发起对象
  2309. * dwConnID -- 连接 ID
  2310. * pBuffer -- 数据缓冲区
  2311. * iBuffLen -- 数据缓冲区长度
  2312. * enBuffType -- 数据缓冲区类型(默认:TBT_COPY)
  2313. * TBT_COPY :(深拷贝)pBuffer 复制到 TSocketTask 对象。此后 TSocketTask 对象与 pBuffer 不再有任何关联
  2314. * -> 适用于 pBuffer 不大或 pBuffer 生命周期不受控的场景
  2315. * TBT_REFER :(浅拷贝)pBuffer 不复制到 TSocketTask 对象,需确保 TSocketTask 对象生命周期内 pBuffer 必须有效
  2316. * -> 适用于 pBuffer 较大或 pBuffer 可重用,并且 pBuffer 生命周期受控的场景
  2317. * TBT_ATTACH :(附属)执行浅拷贝,但 TSocketTask 对象会获得 pBuffer 的所有权,并负责释放 pBuffer,避免多次缓冲区拷贝
  2318. * -> 注意:pBuffer 必须由 SYS_Malloc()/SYS_Calloc() 函数分配才能使用本类型,否则可能会发生内存访问错误
  2319. * wParam -- 自定义参数
  2320. * lParam -- 自定义参数
  2321. * 返回值: HP_LPTSocketTask
  2322. */
  2323. HPSOCKET_API HP_LPTSocketTask __HP_CALL Create_HP_SocketTaskObj(Fn_SocketTaskProc fnTaskProc, PVOID pSender, HP_CONNID dwConnID, LPCBYTE pBuffer, INT iBuffLen, En_HP_TaskBufferType enBuffType /*= TBT_COPY*/, WPARAM wParam /*= 0*/, LPARAM lParam /*= 0*/);
  2324. // 销毁 TSocketTask 对象
  2325. HPSOCKET_API void __HP_CALL Destroy_HP_SocketTaskObj(HP_LPTSocketTask pTask);
  2326. /***********************************************************************/
  2327. /***************************** 组件操作方法 *****************************/
  2328. /*
  2329. * 名称:启动线程池组件
  2330. * 描述:
  2331. *
  2332. * 参数: dwThreadCount -- 线程数量,(默认:0)
  2333. * >0 -> dwThreadCount
  2334. * =0 -> (CPU核数 * 2 + 2)
  2335. * <0 -> (CPU核数 * (-dwThreadCount))
  2336. * dwMaxQueueSize -- 任务队列最大容量(默认:0,不限制)
  2337. * enRejectedPolicy -- 任务拒绝处理策略
  2338. * TRP_CALL_FAIL(默认) :立刻返回失败
  2339. * TRP_WAIT_FOR :等待(直到成功、超时或线程池关闭等原因导致失败)
  2340. * TRP_CALLER_RUN :调用者线程直接执行
  2341. * dwStackSize -- 线程堆栈空间大小(默认:0 -> 操作系统默认)
  2342. * 返回值: TRUE -- 成功
  2343. * FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
  2344. */
  2345. HPSOCKET_API BOOL __HP_CALL HP_ThreadPool_Start(HP_ThreadPool pThreadPool, DWORD dwThreadCount /*= 0*/, DWORD dwMaxQueueSize /*= 0*/, En_HP_RejectedPolicy enRejectedPolicy /*= TRP_CALL_FAIL*/, DWORD dwStackSize /*= 0*/);
  2346. /*
  2347. * 名称:关闭线程池组件
  2348. * 描述:在规定时间内关闭线程池组件,如果工作线程在最大等待时间内未能正常关闭,会尝试强制关闭,这种情况下很可能会造成系统资源泄漏
  2349. *
  2350. * 参数: dwMaxWait -- 最大等待时间(毫秒,默认:INFINITE,一直等待)
  2351. * 返回值: TRUE -- 成功
  2352. * FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
  2353. */
  2354. HPSOCKET_API BOOL __HP_CALL HP_ThreadPool_Stop(HP_ThreadPool pThreadPool, DWORD dwMaxWait /*= INFINITE*/);
  2355. /*
  2356. * 名称:提交任务
  2357. * 描述:向线程池提交异步任务
  2358. *
  2359. * 参数: fnTaskProc -- 任务处理函数
  2360. * pvArg -- 任务参数
  2361. * dwMaxWait -- 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
  2362. * 返回值: TRUE -- 成功
  2363. * FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
  2364. * 其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
  2365. */
  2366. HPSOCKET_API BOOL __HP_CALL HP_ThreadPool_Submit(HP_ThreadPool pThreadPool, HP_Fn_TaskProc fnTaskProc, PVOID pvArg, DWORD dwMaxWait /*= INFINITE*/);
  2367. /*
  2368. * 名称:提交 Socket 任务
  2369. * 描述:向线程池提交异步 Socket 任务
  2370. *
  2371. * 参数: pTask -- 任务参数
  2372. * dwMaxWait -- 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
  2373. * 返回值: TRUE -- 成功
  2374. * FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
  2375. * 其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
  2376. * 注意:如果提交失败,需要手工调用 Destroy_HP_SocketTaskObj() 销毁 TSocketTask 对象
  2377. */
  2378. HPSOCKET_API BOOL __HP_CALL HP_ThreadPool_Submit_Task(HP_ThreadPool pThreadPool, HP_LPTSocketTask pTask, DWORD dwMaxWait /*= INFINITE*/);
  2379. /*
  2380. * 名称:调整线程池大小
  2381. * 描述:增加或减少线程池的工作线程数量
  2382. *
  2383. * 参数: dwNewThreadCount -- 线程数量
  2384. * >0 -> dwNewThreadCount
  2385. * =0 -> (CPU核数 * 2 + 2)
  2386. * <0 -> (CPU核数 * (-dwNewThreadCount))
  2387. * 返回值: TRUE -- 成功
  2388. * FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
  2389. */
  2390. HPSOCKET_API BOOL __HP_CALL HP_ThreadPool_AdjustThreadCount(HP_ThreadPool pThreadPool, DWORD dwNewThreadCount);
  2391. /*
  2392. * 名称:等待
  2393. * 描述:等待线程池组件停止运行
  2394. *
  2395. * 参数: dwMilliseconds -- 超时时间(毫秒,默认:-1,永不超时)
  2396. * 返回值: TRUE -- 成功
  2397. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2398. */
  2399. HPSOCKET_API BOOL __HP_CALL HP_ThreadPool_Wait(HP_ThreadPool pThreadPool, DWORD dwMilliseconds);
  2400. /***********************************************************************/
  2401. /***************************** 属性访问方法 *****************************/
  2402. /* 检查线程池组件是否已启动 */
  2403. HPSOCKET_API BOOL __HP_CALL HP_ThreadPool_HasStarted(HP_ThreadPool pThreadPool);
  2404. /* 查看线程池组件当前状态 */
  2405. HPSOCKET_API En_HP_ServiceState __HP_CALL HP_ThreadPool_GetState(HP_ThreadPool pThreadPool);
  2406. /* 获取当前任务等待队列大小 */
  2407. HPSOCKET_API DWORD __HP_CALL HP_ThreadPool_GetQueueSize(HP_ThreadPool pThreadPool);
  2408. /* 获取当前正在执行的任务数量 */
  2409. HPSOCKET_API DWORD __HP_CALL HP_ThreadPool_GetTaskCount(HP_ThreadPool pThreadPool);
  2410. /* 获取工作线程数量 */
  2411. HPSOCKET_API DWORD __HP_CALL HP_ThreadPool_GetThreadCount(HP_ThreadPool pThreadPool);
  2412. /* 获取任务队列最大容量 */
  2413. HPSOCKET_API DWORD __HP_CALL HP_ThreadPool_GetMaxQueueSize(HP_ThreadPool pThreadPool);
  2414. /* 获取任务拒绝处理策略 */
  2415. HPSOCKET_API En_HP_RejectedPolicy __HP_CALL HP_ThreadPool_GetRejectedPolicy(HP_ThreadPool pThreadPool);
  2416. /*****************************************************************************************************************************************************/
  2417. /********************************************************* Compressor / Decompressor Exports *********************************************************/
  2418. /*****************************************************************************************************************************************************/
  2419. /****************************************************/
  2420. /******************* 对象创建函数 ********************/
  2421. /* 销毁压缩器对象 */
  2422. HPSOCKET_API void __HP_CALL Destroy_HP_Compressor(HP_Compressor pCompressor);
  2423. /* 销毁解压器对象 */
  2424. HPSOCKET_API void __HP_CALL Destroy_HP_Decompressor(HP_Decompressor pDecompressor);
  2425. #ifdef _ZLIB_SUPPORT
  2426. /* 创建 ZLib 压缩器对象 */
  2427. // (默认参数:iWindowBits = 15, iLevel = -1, iMethod = 8, iMemLevel = 8, iStrategy = 0, dwBuffSize = 16 * 1024)
  2428. HPSOCKET_API HP_Compressor __HP_CALL Create_HP_ZLibCompressor(HP_Fn_CompressDataCallback fnCallback);
  2429. /* 创建 ZLib 压缩器对象 */
  2430. HPSOCKET_API HP_Compressor __HP_CALL Create_HP_ZLibCompressorEx(HP_Fn_CompressDataCallback fnCallback, int iWindowBits /*= 15*/, int iLevel /*= -1*/, int iMethod /*= 8*/, int iMemLevel /*= 8*/, int iStrategy /*= 0*/, DWORD dwBuffSize /*= 16 * 1024*/);
  2431. /* 创建 GZip 压缩器对象 */
  2432. // (默认参数:iLevel = -1, iMethod = 8, iMemLevel = 8, iStrategy = 0, dwBuffSize = 16 * 1024)
  2433. HPSOCKET_API HP_Compressor __HP_CALL Create_HP_GZipCompressor(HP_Fn_CompressDataCallback fnCallback);
  2434. /* 创建 GZip 压缩器对象 */
  2435. HPSOCKET_API HP_Compressor __HP_CALL Create_HP_GZipCompressorEx(HP_Fn_CompressDataCallback fnCallback, int iLevel /*= -1*/, int iMethod /*= 8*/, int iMemLevel /*= 8*/, int iStrategy /*= 0*/, DWORD dwBuffSize /*= 16 * 1024*/);
  2436. /* 创建 ZLib 解压器对象 */
  2437. // (默认参数:iWindowBits = 15, dwBuffSize = 16 * 1024)
  2438. HPSOCKET_API HP_Decompressor __HP_CALL Create_HP_ZLibDecompressor(HP_Fn_DecompressDataCallback fnCallback);
  2439. /* 创建 ZLib 解压器对象 */
  2440. HPSOCKET_API HP_Decompressor __HP_CALL Create_HP_ZLibDecompressorEx(HP_Fn_DecompressDataCallback fnCallback, int iWindowBits /*= 15*/, DWORD dwBuffSize /*= 16 * 1024*/);
  2441. /* 创建 GZip 解压器对象 */
  2442. // (默认参数:dwBuffSize = 16 * 1024)
  2443. HPSOCKET_API HP_Decompressor __HP_CALL Create_HP_GZipDecompressor(HP_Fn_DecompressDataCallback fnCallback);
  2444. /* 创建 GZip 解压器对象 */
  2445. HPSOCKET_API HP_Decompressor __HP_CALL Create_HP_GZipDecompressorEx(HP_Fn_DecompressDataCallback fnCallback, DWORD dwBuffSize /*= 16 * 1024*/);
  2446. #endif
  2447. #ifdef _BROTLI_SUPPORT
  2448. /* 创建 Brotli 压缩器对象 */
  2449. //(默认参数:iQuality = 11,iWindow = 22,iMode = 0, dwBuffSize = 16 * 1024)
  2450. HPSOCKET_API HP_Compressor __HP_CALL Create_HP_BrotliCompressor(HP_Fn_CompressDataCallback fnCallback);
  2451. /* 创建 Brotli 压缩器对象 */
  2452. HPSOCKET_API HP_Compressor __HP_CALL Create_HP_BrotliCompressorEx(HP_Fn_CompressDataCallback fnCallback, int iQuality /*= 11*/, int iWindow /*= 22*/, int iMode /*= 0*/, DWORD dwBuffSize /*= 16 * 1024*/);
  2453. /* 创建 Brotli 解压器对象 */
  2454. // (默认参数:dwBuffSize = 16 * 1024)
  2455. HPSOCKET_API HP_Decompressor __HP_CALL Create_HP_BrotliDecompressor(HP_Fn_DecompressDataCallback fnCallback);
  2456. /* 创建 Brotli 解压器对象 */
  2457. HPSOCKET_API HP_Decompressor __HP_CALL Create_HP_BrotliDecompressorEx(HP_Fn_DecompressDataCallback fnCallback, DWORD dwBuffSize /*= 16 * 1024*/);
  2458. #endif
  2459. /***********************************************************************/
  2460. /***************************** 组件操作方法 *****************************/
  2461. /*
  2462. * 名称:执行压缩
  2463. * 描述:可循环调用以压缩流式或分段数据
  2464. *
  2465. * 参数: pData -- 待压缩数据缓冲区
  2466. * iLength -- 待压缩数据长度
  2467. * bLast -- 是否最后一段待压缩数据
  2468. * pContext -- 压缩回调函数 Fn_CompressDataCallback 的上下文参数
  2469. *
  2470. * 返回值: TRUE -- 成功
  2471. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2472. */
  2473. HPSOCKET_API BOOL __HP_CALL HP_Compressor_Process(HP_Compressor pCompressor, const BYTE* pData, int iLength, BOOL bLast, PVOID pContext /*= nullptr*/);
  2474. /*
  2475. * 名称:执行压缩
  2476. * 描述:可循环调用以压缩流式或分段数据
  2477. *
  2478. * 参数: pData -- 待压缩数据缓冲区
  2479. * iLength -- 待压缩数据长度
  2480. * bLast -- 是否最后一段待压缩数据
  2481. * bFlush -- 是否强制刷新(强制刷新会降低压缩效率,但可对数据进行分段压缩)
  2482. * pContext -- 压缩回调函数 Fn_CompressDataCallback 的上下文参数
  2483. *
  2484. * 返回值: TRUE -- 成功
  2485. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2486. */
  2487. HPSOCKET_API BOOL __HP_CALL HP_Compressor_ProcessEx(HP_Compressor pCompressor, const BYTE* pData, int iLength, BOOL bLast, BOOL bFlush /*= FALSE*/, PVOID pContext /*= nullptr*/);
  2488. /* 重置压缩器 */
  2489. HPSOCKET_API BOOL __HP_CALL HP_Compressor_Reset(HP_Compressor pCompressor);
  2490. /*
  2491. * 名称:执行解压
  2492. * 描述:可循环调用以解压流式或分段数据
  2493. *
  2494. * 参数: pData -- 待解压数据缓冲区
  2495. * iLength -- 待解压数据长度
  2496. * pContext -- 解压回调函数 Fn_DecompressDataCallback 的上下文参数
  2497. *
  2498. * 返回值: TRUE -- 成功
  2499. * FALSE -- 失败,可通过 SYS_GetLastError() 获取错误代码
  2500. */
  2501. HPSOCKET_API BOOL __HP_CALL HP_Decompressor_Process(HP_Decompressor pDecompressor, const BYTE* pData, int iLength, PVOID pContext /*= nullptr*/);
  2502. /* 重置解压器 */
  2503. HPSOCKET_API BOOL __HP_CALL HP_Decompressor_Reset(HP_Decompressor pDecompressor);
  2504. /***********************************************************************/
  2505. /***************************** 属性访问方法 *****************************/
  2506. /* 检测压缩器是否可用 */
  2507. HPSOCKET_API BOOL __HP_CALL HP_Compressor_IsValid(HP_Compressor pCompressor);
  2508. /* 检测解压器是否可用 */
  2509. HPSOCKET_API BOOL __HP_CALL HP_Decompressor_IsValid(HP_Decompressor pDecompressor);