HPSocket4C.h 155 KB

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