/* * Copyright: JessMA Open Source (ldcsaa@gmail.com) * * Version : 3.6.1 * Author : Bruce Liang * Website : http://www.jessma.org * Project : https://github.com/ldcsaa * Blog : http://www.cnblogs.com/ldcsaa * Wiki : http://www.oschina.net/p/hp-socket * QQ Group : 75375912 * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /****************************************************************************** Module: HPSocket for C Desc: 导出纯 C 函数，让其它语言（如：C / C# / Delphi 等）能方便地使用 HPSocket Usage: 方法一： -------------------------------------------------------------------------------------- 0. （C/C++ 程序）包含 HPTypeDef.h / HPSocket4C.h 头文件 1. 调用 ::Create_HP_XxxListener() 函数创建监听器对象 2. 调用 ::Create_HP_Xxx(pListener) 函数创建 HPSocket 对象 3. 调用 ::HP_Set_FN_Xxx_OnYyy(pListener, ...) 函数设置监听器的回调函数 4. 调用相关导出函数操作 HPSocket 对象 5. ...... ...... 6. 调用 ::Destroy_HP_Xxx(pSocket) 函数销毁 HPSocket 对象 7. 调用 ::Destroy_HP_XxxListener(pListener) 函数销毁监听器对象 方法二： -------------------------------------------------------------------------------------- 1. 应用程序把需要用到的导出函数封装到特定语言的包装类中 2. 通过包装类封装后，以面向对象的方式使用 HPSocket Release: <-- 动态链接库 --> 1. x86/HPSocket4C.dll - (32位/MBCS/Release) 2. x86/HPSocket4C_D.dll - (32位/MBCS/DeBug) 3. x86/HPSocket4C_U.dll - (32位/UNICODE/Release) 4. x86/HPSocket4C_UD.dll - (32位/UNICODE/DeBug) 5. x64/HPSocket4C.dll - (64位/MBCS/Release) 6. x64/HPSocket4C_D.dll - (64位/MBCS/DeBug) 7. x64/HPSocket4C_U.dll - (64位/UNICODE/Release) 8. x64/HPSocket4C_UD.dll - (64位/UNICODE/DeBug) <-- 静态链接库 --> !!注意!!：使用 HPSocket 静态库时，需要在工程属性中定义预处理宏 -> HPSOCKET_STATIC_LIB 1. x86/static/HPSocket4C.lib - (32位/MBCS/Release) 2. x86/static/HPSocket4C_D.lib - (32位/MBCS/DeBug) 3. x86/static/HPSocket4C_U.lib - (32位/UNICODE/Release) 4. x86/static/HPSocket4C_UD.lib - (32位/UNICODE/DeBug) 5. x64/static/HPSocket4C.lib - (64位/MBCS/Release) 6. x64/static/HPSocket4C_D.lib - (64位/MBCS/DeBug) 7. x64/static/HPSocket4C_U.lib - (64位/UNICODE/Release) 8. x64/static/HPSocket4C_UD.lib - (64位/UNICODE/DeBug) ******************************************************************************/ #pragma once #include #include "HPTypeDef.h" /**************************************************/ /********** imports / exports HPSocket4C **********/ #ifdef HPSOCKET_STATIC_LIB #define HPSOCKET_API EXTERN_C #else #ifdef HPSOCKET_EXPORTS #define HPSOCKET_API EXTERN_C __declspec(dllexport) #else #define HPSOCKET_API EXTERN_C __declspec(dllimport) #endif #endif /************************************************************************ 名称：定义 Socket 对象指针类型别名 描述：把 Socket 对象指针定义为更直观的别名 ************************************************************************/ typedef PVOID HP_Object; typedef HP_Object HP_Server; typedef HP_Object HP_Agent; typedef HP_Object HP_Client; typedef HP_Object HP_TcpServer; typedef HP_Object HP_TcpAgent; typedef HP_Object HP_TcpClient; typedef HP_Object HP_PullSocket; typedef HP_Object HP_PullClient; typedef HP_Object HP_TcpPullServer; typedef HP_Object HP_TcpPullAgent; typedef HP_Object HP_TcpPullClient; typedef HP_Object HP_PackSocket; typedef HP_Object HP_PackClient; typedef HP_Object HP_TcpPackServer; typedef HP_Object HP_TcpPackAgent; typedef HP_Object HP_TcpPackClient; typedef HP_Object HP_UdpServer; typedef HP_Object HP_UdpClient; typedef HP_Object HP_UdpCast; typedef HP_Object HP_Listener; typedef HP_Object HP_ServerListener; typedef HP_Object HP_AgentListener; typedef HP_Object HP_ClientListener; typedef HP_Object HP_TcpServerListener; typedef HP_Object HP_TcpAgentListener; typedef HP_Object HP_TcpClientListener; typedef HP_Object HP_PullSocketListener; typedef HP_Object HP_PullClientListener; typedef HP_Object HP_TcpPullServerListener; typedef HP_Object HP_TcpPullAgentListener; typedef HP_Object HP_TcpPullClientListener; typedef HP_Object HP_UdpServerListener; typedef HP_Object HP_UdpClientListener; typedef HP_Object HP_UdpCastListener; typedef HP_Object HP_HttpServer; typedef HP_Object HP_HttpAgent; typedef HP_Object HP_HttpClient; typedef HP_Object HP_HttpServerListener; typedef HP_Object HP_HttpAgentListener; typedef HP_Object HP_HttpClientListener; /*****************************************************************************************************************************************************/ /****************************************************************** TCP/UDP Exports ******************************************************************/ /*****************************************************************************************************************************************************/ /****************************************************/ /***************** TCP/UDP 回调函数 ******************/ /* Server 回调函数 */ typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnPrepareListen) (UINT_PTR soListen); // 如果为 TCP 连接，pClient为 SOCKET 句柄；如果为 UDP 连接，pClient为 SOCKADDR_IN 指针； typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnAccept) (HP_CONNID dwConnID, UINT_PTR pClient); typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnHandShake) (HP_CONNID dwConnID); typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnSend) (HP_CONNID dwConnID, const BYTE* pData, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnReceive) (HP_CONNID dwConnID, const BYTE* pData, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnPullReceive) (HP_CONNID dwConnID, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnClose) (HP_CONNID dwConnID, En_HP_SocketOperation enOperation, int iErrorCode); typedef En_HP_HandleResult (__stdcall *HP_FN_Server_OnShutdown) (); /* Agent 回调函数 */ typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnPrepareConnect) (HP_CONNID dwConnID, UINT_PTR socket); typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnConnect) (HP_CONNID dwConnID); typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnHandShake) (HP_CONNID dwConnID); typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnSend) (HP_CONNID dwConnID, const BYTE* pData, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnReceive) (HP_CONNID dwConnID, const BYTE* pData, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnPullReceive) (HP_CONNID dwConnID, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnClose) (HP_CONNID dwConnID, En_HP_SocketOperation enOperation, int iErrorCode); typedef En_HP_HandleResult (__stdcall *HP_FN_Agent_OnShutdown) (); /* Client 回调函数 */ typedef En_HP_HandleResult (__stdcall *HP_FN_Client_OnPrepareConnect) (HP_Client pClient, UINT_PTR socket); typedef En_HP_HandleResult (__stdcall *HP_FN_Client_OnConnect) (HP_Client pClient); typedef En_HP_HandleResult (__stdcall *HP_FN_Client_OnHandShake) (HP_Client pClient); typedef En_HP_HandleResult (__stdcall *HP_FN_Client_OnSend) (HP_Client pClient, const BYTE* pData, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Client_OnReceive) (HP_Client pClient, const BYTE* pData, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Client_OnPullReceive) (HP_Client pClient, int iLength); typedef En_HP_HandleResult (__stdcall *HP_FN_Client_OnClose) (HP_Client pClient, En_HP_SocketOperation enOperation, int iErrorCode); /****************************************************/ /*************** TCP/UDP 对象创建函数 ****************/ // 创建 HP_TcpServer 对象 HPSOCKET_API HP_TcpServer __stdcall Create_HP_TcpServer(HP_TcpServerListener pListener); // 创建 HP_TcpAgent 对象 HPSOCKET_API HP_TcpAgent __stdcall Create_HP_TcpAgent(HP_TcpAgentListener pListener); // 创建 HP_TcpClient 对象 HPSOCKET_API HP_TcpClient __stdcall Create_HP_TcpClient(HP_TcpClientListener pListener); // 创建 HP_TcpPullServer 对象 HPSOCKET_API HP_TcpPullServer __stdcall Create_HP_TcpPullServer(HP_TcpPullServerListener pListener); // 创建 HP_TcpPullAgent 对象 HPSOCKET_API HP_TcpPullAgent __stdcall Create_HP_TcpPullAgent(HP_TcpPullAgentListener pListener); // 创建 HP_TcpPullClient 对象 HPSOCKET_API HP_TcpPullClient __stdcall Create_HP_TcpPullClient(HP_TcpPullClientListener pListener); // 创建 HP_TcpPackServer 对象 HPSOCKET_API HP_TcpPackServer __stdcall Create_HP_TcpPackServer(HP_TcpServerListener pListener); // 创建 HP_TcpPackAgent 对象 HPSOCKET_API HP_TcpPackAgent __stdcall Create_HP_TcpPackAgent(HP_TcpAgentListener pListener); // 创建 HP_TcpPackClient 对象 HPSOCKET_API HP_TcpPackClient __stdcall Create_HP_TcpPackClient(HP_TcpClientListener pListener); // 创建 HP_UdpServer 对象 HPSOCKET_API HP_UdpServer __stdcall Create_HP_UdpServer(HP_UdpServerListener pListener); // 创建 HP_UdpClient 对象 HPSOCKET_API HP_UdpClient __stdcall Create_HP_UdpClient(HP_UdpClientListener pListener); // 创建 HP_UdpCast 对象 HPSOCKET_API HP_UdpCast __stdcall Create_HP_UdpCast(HP_UdpCastListener pListener); // 销毁 HP_TcpServer 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpServer(HP_TcpServer pServer); // 销毁 HP_TcpAgent 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpAgent(HP_TcpAgent pAgent); // 销毁 HP_TcpClient 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpClient(HP_TcpClient pClient); // 销毁 HP_TcpPullServer 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPullServer(HP_TcpPullServer pServer); // 销毁 HP_TcpPullAgent 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPullAgent(HP_TcpPullAgent pAgent); // 销毁 HP_TcpPullClient 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPullClient(HP_TcpPullClient pClient); // 销毁 HP_TcpPackServer 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPackServer(HP_TcpPackServer pServer); // 销毁 HP_TcpPackAgent 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPackAgent(HP_TcpPackAgent pAgent); // 销毁 HP_TcpPackClient 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPackClient(HP_TcpPackClient pClient); // 销毁 HP_UdpServer 对象 HPSOCKET_API void __stdcall Destroy_HP_UdpServer(HP_UdpServer pServer); // 销毁 HP_UdpClient 对象 HPSOCKET_API void __stdcall Destroy_HP_UdpClient(HP_UdpClient pClient); // 销毁 HP_UdpCast 对象 HPSOCKET_API void __stdcall Destroy_HP_UdpCast(HP_UdpCast pCast); // 创建 HP_TcpServerListener 对象 HPSOCKET_API HP_TcpServerListener __stdcall Create_HP_TcpServerListener(); // 创建 HP_TcpAgentListener 对象 HPSOCKET_API HP_TcpAgentListener __stdcall Create_HP_TcpAgentListener(); // 创建 HP_TcpClientListener 对象 HPSOCKET_API HP_TcpClientListener __stdcall Create_HP_TcpClientListener(); // 创建 HP_TcpPullServerListener 对象 HPSOCKET_API HP_TcpPullServerListener __stdcall Create_HP_TcpPullServerListener(); // 创建 HP_TcpPullAgentListener 对象 HPSOCKET_API HP_TcpPullAgentListener __stdcall Create_HP_TcpPullAgentListener(); // 创建 HP_TcpPullClientListener 对象 HPSOCKET_API HP_TcpPullClientListener __stdcall Create_HP_TcpPullClientListener(); // 创建 HP_UdpServerListener 对象 HPSOCKET_API HP_UdpServerListener __stdcall Create_HP_UdpServerListener(); // 创建 HP_UdpClientListener 对象 HPSOCKET_API HP_UdpClientListener __stdcall Create_HP_UdpClientListener(); // 创建 HP_UdpCastListener 对象 HPSOCKET_API HP_UdpCastListener __stdcall Create_HP_UdpCastListener(); // 销毁 HP_TcpServerListener 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpServerListener(HP_TcpServerListener pListener); // 销毁 HP_TcpAgentListener 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpAgentListener(HP_TcpAgentListener pListener); // 销毁 HP_TcpClientListener 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpClientListener(HP_TcpClientListener pListener); // 销毁 HP_TcpPullServerListener 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPullServerListener(HP_TcpPullServerListener pListener); // 销毁 HP_TcpPullAgentListener 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPullAgentListener(HP_TcpPullAgentListener pListener); // 销毁 HP_TcpPullClientListener 对象 HPSOCKET_API void __stdcall Destroy_HP_TcpPullClientListener(HP_TcpPullClientListener pListener); // 销毁 HP_UdpServerListener 对象 HPSOCKET_API void __stdcall Destroy_HP_UdpServerListener(HP_UdpServerListener pListener); // 销毁 HP_UdpClientListener 对象 HPSOCKET_API void __stdcall Destroy_HP_UdpClientListener(HP_UdpClientListener pListener); // 销毁 HP_UdpCastListener 对象 HPSOCKET_API void __stdcall Destroy_HP_UdpCastListener(HP_UdpCastListener pListener); /**********************************************************************************/ /***************************** Server 回调函数设置方法 *****************************/ HPSOCKET_API void __stdcall HP_Set_FN_Server_OnPrepareListen(HP_ServerListener pListener , HP_FN_Server_OnPrepareListen fn); HPSOCKET_API void __stdcall HP_Set_FN_Server_OnAccept(HP_ServerListener pListener , HP_FN_Server_OnAccept fn); HPSOCKET_API void __stdcall HP_Set_FN_Server_OnHandShake(HP_ServerListener pListener , HP_FN_Server_OnHandShake fn); HPSOCKET_API void __stdcall HP_Set_FN_Server_OnSend(HP_ServerListener pListener , HP_FN_Server_OnSend fn); HPSOCKET_API void __stdcall HP_Set_FN_Server_OnReceive(HP_ServerListener pListener , HP_FN_Server_OnReceive fn); HPSOCKET_API void __stdcall HP_Set_FN_Server_OnPullReceive(HP_ServerListener pListener , HP_FN_Server_OnPullReceive fn); HPSOCKET_API void __stdcall HP_Set_FN_Server_OnClose(HP_ServerListener pListener , HP_FN_Server_OnClose fn); HPSOCKET_API void __stdcall HP_Set_FN_Server_OnShutdown(HP_ServerListener pListener , HP_FN_Server_OnShutdown fn); /**********************************************************************************/ /****************************** Agent 回调函数设置方法 *****************************/ HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnPrepareConnect(HP_AgentListener pListener , HP_FN_Agent_OnPrepareConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnConnect(HP_AgentListener pListener , HP_FN_Agent_OnConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnHandShake(HP_AgentListener pListener , HP_FN_Agent_OnHandShake fn); HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnSend(HP_AgentListener pListener , HP_FN_Agent_OnSend fn); HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnReceive(HP_AgentListener pListener , HP_FN_Agent_OnReceive fn); HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnPullReceive(HP_AgentListener pListener , HP_FN_Agent_OnPullReceive fn); HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnClose(HP_AgentListener pListener , HP_FN_Agent_OnClose fn); HPSOCKET_API void __stdcall HP_Set_FN_Agent_OnShutdown(HP_AgentListener pListener , HP_FN_Agent_OnShutdown fn); /**********************************************************************************/ /***************************** Client 回调函数设置方法 *****************************/ HPSOCKET_API void __stdcall HP_Set_FN_Client_OnPrepareConnect(HP_ClientListener pListener , HP_FN_Client_OnPrepareConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_Client_OnConnect(HP_ClientListener pListener , HP_FN_Client_OnConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_Client_OnHandShake(HP_ClientListener pListener , HP_FN_Client_OnHandShake fn); HPSOCKET_API void __stdcall HP_Set_FN_Client_OnSend(HP_ClientListener pListener , HP_FN_Client_OnSend fn); HPSOCKET_API void __stdcall HP_Set_FN_Client_OnReceive(HP_ClientListener pListener , HP_FN_Client_OnReceive fn); HPSOCKET_API void __stdcall HP_Set_FN_Client_OnPullReceive(HP_ClientListener pListener , HP_FN_Client_OnPullReceive fn); HPSOCKET_API void __stdcall HP_Set_FN_Client_OnClose(HP_ClientListener pListener , HP_FN_Client_OnClose fn); /**************************************************************************/ /***************************** Server 操作方法 *****************************/ /* * 名称：启动通信组件 * 描述：启动服务端通信组件，启动完成后可开始接收客户端连接并收发数据 * * 参数： lpszBindAddress -- 监听地址 * usPort -- 监听端口 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 HP_Server_GetLastError() 获取错误代码 */ HPSOCKET_API BOOL __stdcall HP_Server_Start(HP_Server pServer, LPCTSTR lpszBindAddress, USHORT usPort); /* * 名称：关闭通信组件 * 描述：关闭服务端通信组件，关闭完成后断开所有客户端连接并释放所有资源 * * 参数： * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 HP_Server_GetLastError() 获取错误代码 */ HPSOCKET_API BOOL __stdcall HP_Server_Stop(HP_Server pServer); /* * 名称：发送数据 * 描述：向指定连接发送数据 * * 参数： dwConnID -- 连接 ID * pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Server_Send(HP_Server pServer, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength); /* * 名称：发送数据 * 描述：向指定连接发送数据 * * 参数： dwConnID -- 连接 ID * pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * iOffset -- 发送缓冲区指针偏移量 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Server_SendPart(HP_Server pServer, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset); /* * 名称：发送多组数据 * 描述：向指定连接发送多组数据 * TCP - 顺序发送所有数据包 * UDP - 把所有数据包组合成一个数据包发送（数据包的总长度不能大于设置的 UDP 包最大长度） * * 参数： dwConnID -- 连接 ID * pBuffers -- 发送缓冲区数组 * iCount -- 发送缓冲区数目 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Server_SendPackets(HP_Server pServer, HP_CONNID dwConnID, const WSABUF pBuffers[], int iCount); /* * 名称：断开连接 * 描述：断开与某个客户端的连接 * * 参数： dwConnID -- 连接 ID * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_Server_Disconnect(HP_Server pServer, HP_CONNID dwConnID, BOOL bForce); /* * 名称：断开超时连接 * 描述：断开超过指定时长的连接 * * 参数： dwPeriod -- 时长（毫秒） * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_Server_DisconnectLongConnections(HP_Server pServer, DWORD dwPeriod, BOOL bForce); /* * 名称：断开静默连接 * 描述：断开超过指定时长的静默连接 * * 参数： dwPeriod -- 时长（毫秒） * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_Server_DisconnectSilenceConnections(HP_Server pServer, DWORD dwPeriod, BOOL bForce); /******************************************************************************/ /***************************** Server 属性访问方法 *****************************/ /* * 名称：设置连接的附加数据 * 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序只身决定 * * 参数： dwConnID -- 连接 ID * pv -- 数据 * 返回值： TRUE -- 成功 * FALSE -- 失败（无效的连接 ID） */ HPSOCKET_API BOOL __stdcall HP_Server_SetConnectionExtra(HP_Server pServer, HP_CONNID dwConnID, PVOID pExtra); /* * 名称：获取连接的附加数据 * 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序只身决定 * * 参数： dwConnID -- 连接 ID * ppv -- 数据指针 * 返回值： TRUE -- 成功 * FALSE -- 失败（无效的连接 ID） */ HPSOCKET_API BOOL __stdcall HP_Server_GetConnectionExtra(HP_Server pServer, HP_CONNID dwConnID, PVOID* ppExtra); /* 检查通信组件是否已启动 */ HPSOCKET_API BOOL __stdcall HP_Server_HasStarted(HP_Server pServer); /* 查看通信组件当前状态 */ HPSOCKET_API En_HP_ServiceState __stdcall HP_Server_GetState(HP_Server pServer); /* 获取最近一次失败操作的错误代码 */ HPSOCKET_API En_HP_SocketError __stdcall HP_Server_GetLastError(HP_Server pServer); /* 获取最近一次失败操作的错误描述 */ HPSOCKET_API LPCTSTR __stdcall HP_Server_GetLastErrorDesc(HP_Server pServer); /* 获取连接中未发出数据的长度 */ HPSOCKET_API BOOL __stdcall HP_Server_GetPendingDataLength(HP_Server pServer, HP_CONNID dwConnID, int* piPending); /* 获取客户端连接数 */ HPSOCKET_API DWORD __stdcall HP_Server_GetConnectionCount(HP_Server pServer); /* 获取所有连接的 HP_CONNID */ HPSOCKET_API BOOL __stdcall HP_Server_GetAllConnectionIDs(HP_Server pServer, HP_CONNID pIDs[], DWORD* pdwCount); /* 获取某个客户端连接时长（毫秒） */ HPSOCKET_API BOOL __stdcall HP_Server_GetConnectPeriod(HP_Server pServer, HP_CONNID dwConnID, DWORD* pdwPeriod); /* 获取某个连接静默时间（毫秒） */ HPSOCKET_API BOOL __stdcall HP_Server_GetSilencePeriod(HP_Server pServer, HP_CONNID dwConnID, DWORD* pdwPeriod); /* 获取监听 Socket 的地址信息 */ HPSOCKET_API BOOL __stdcall HP_Server_GetListenAddress(HP_Server pServer, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); /* 获取某个连接的本地地址信息 */ HPSOCKET_API BOOL __stdcall HP_Server_GetLocalAddress(HP_Server pServer, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); /* 获取某个连接的远程地址信息 */ HPSOCKET_API BOOL __stdcall HP_Server_GetRemoteAddress(HP_Server pServer, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); /* 设置数据发送策略 */ HPSOCKET_API void __stdcall HP_Server_SetSendPolicy(HP_Server pServer, En_HP_SendPolicy enSendPolicy); /* 设置 Socket 缓存对象锁定时间（毫秒，在锁定期间该 Socket 缓存对象不能被获取使用） */ HPSOCKET_API void __stdcall HP_Server_SetFreeSocketObjLockTime(HP_Server pServer, DWORD dwFreeSocketObjLockTime); /* 设置 Socket 缓存池大小（通常设置为平均并发连接数量的 1/3 - 1/2） */ HPSOCKET_API void __stdcall HP_Server_SetFreeSocketObjPool(HP_Server pServer, DWORD dwFreeSocketObjPool); /* 设置内存块缓存池大小（通常设置为 Socket 缓存池大小的 2 - 3 倍） */ HPSOCKET_API void __stdcall HP_Server_SetFreeBufferObjPool(HP_Server pServer, DWORD dwFreeBufferObjPool); /* 设置 Socket 缓存池回收阀值（通常设置为 Socket 缓存池大小的 3 倍） */ HPSOCKET_API void __stdcall HP_Server_SetFreeSocketObjHold(HP_Server pServer, DWORD dwFreeSocketObjHold); /* 设置内存块缓存池回收阀值（通常设置为内存块缓存池大小的 3 倍） */ HPSOCKET_API void __stdcall HP_Server_SetFreeBufferObjHold(HP_Server pServer, DWORD dwFreeBufferObjHold); /* 设置最大连接数（组件会根据设置值预分配内存，因此需要根据实际情况设置，不宜过大）*/ HPSOCKET_API void __stdcall HP_Server_SetMaxConnectionCount(HP_Server pServer, DWORD dwMaxConnectionCount); /* 设置工作线程数量（通常设置为 2 * CPU + 2） */ HPSOCKET_API void __stdcall HP_Server_SetWorkerThreadCount(HP_Server pServer, DWORD dwWorkerThreadCount); /* 设置是否标记静默时间（设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效，默认：TRUE） */ HPSOCKET_API void __stdcall HP_Server_SetMarkSilence(HP_Server pServer, BOOL bMarkSilence); /* 获取数据发送策略 */ HPSOCKET_API En_HP_SendPolicy __stdcall HP_Server_GetSendPolicy(HP_Server pServer); /* 获取 Socket 缓存对象锁定时间 */ HPSOCKET_API DWORD __stdcall HP_Server_GetFreeSocketObjLockTime(HP_Server pServer); /* 获取 Socket 缓存池大小 */ HPSOCKET_API DWORD __stdcall HP_Server_GetFreeSocketObjPool(HP_Server pServer); /* 获取内存块缓存池大小 */ HPSOCKET_API DWORD __stdcall HP_Server_GetFreeBufferObjPool(HP_Server pServer); /* 获取 Socket 缓存池回收阀值 */ HPSOCKET_API DWORD __stdcall HP_Server_GetFreeSocketObjHold(HP_Server pServer); /* 获取内存块缓存池回收阀值 */ HPSOCKET_API DWORD __stdcall HP_Server_GetFreeBufferObjHold(HP_Server pServer); /* 获取最大连接数 */ HPSOCKET_API DWORD __stdcall HP_Server_GetMaxConnectionCount(HP_Server pServer); /* 获取工作线程数量 */ HPSOCKET_API DWORD __stdcall HP_Server_GetWorkerThreadCount(HP_Server pServer); /* 检测是否标记静默时间 */ HPSOCKET_API BOOL __stdcall HP_Server_IsMarkSilence(HP_Server pServer); /**********************************************************************************/ /******************************* TCP Server 操作方法 *******************************/ /* * 名称：发送小文件 * 描述：向指定连接发送 4096 KB 以下的小文件 * * 参数： dwConnID -- 连接 ID * lpszFileName -- 文件路径 * pHead -- 头部附加数据 * pTail -- 尾部附加数据 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_TcpServer_SendSmallFile(HP_Server pServer, HP_CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail); /**********************************************************************************/ /***************************** TCP Server 属性访问方法 *****************************/ /* 设置监听 Socket 的等候队列大小（根据并发连接数量调整设置） */ HPSOCKET_API void __stdcall HP_TcpServer_SetSocketListenQueue(HP_TcpServer pServer, DWORD dwSocketListenQueue); /* 设置 Accept 预投递数量（根据负载调整设置，Accept 预投递数量越大则支持的并发连接请求越多） */ HPSOCKET_API void __stdcall HP_TcpServer_SetAcceptSocketCount(HP_TcpServer pServer, DWORD dwAcceptSocketCount); /* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为 1024 的倍数） */ HPSOCKET_API void __stdcall HP_TcpServer_SetSocketBufferSize(HP_TcpServer pServer, DWORD dwSocketBufferSize); /* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */ HPSOCKET_API void __stdcall HP_TcpServer_SetKeepAliveTime(HP_TcpServer pServer, DWORD dwKeepAliveTime); /* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */ HPSOCKET_API void __stdcall HP_TcpServer_SetKeepAliveInterval(HP_TcpServer pServer, DWORD dwKeepAliveInterval); /* 获取 Accept 预投递数量 */ HPSOCKET_API DWORD __stdcall HP_TcpServer_GetAcceptSocketCount(HP_TcpServer pServer); /* 获取通信数据缓冲区大小 */ HPSOCKET_API DWORD __stdcall HP_TcpServer_GetSocketBufferSize(HP_TcpServer pServer); /* 获取监听 Socket 的等候队列大小 */ HPSOCKET_API DWORD __stdcall HP_TcpServer_GetSocketListenQueue(HP_TcpServer pServer); /* 获取正常心跳包间隔 */ HPSOCKET_API DWORD __stdcall HP_TcpServer_GetKeepAliveTime(HP_TcpServer pServer); /* 获取异常心跳包间隔 */ HPSOCKET_API DWORD __stdcall HP_TcpServer_GetKeepAliveInterval(HP_TcpServer pServer); /**********************************************************************************/ /***************************** UDP Server 属性访问方法 *****************************/ /* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */ HPSOCKET_API void __stdcall HP_UdpServer_SetMaxDatagramSize(HP_UdpServer pServer, DWORD dwMaxDatagramSize); /* 获取数据报文最大长度 */ HPSOCKET_API DWORD __stdcall HP_UdpServer_GetMaxDatagramSize(HP_UdpServer pServer); /* 设置 Receive 预投递数量（根据负载调整设置，Receive 预投递数量越大则丢包概率越小） */ HPSOCKET_API void __stdcall HP_UdpServer_SetPostReceiveCount(HP_UdpServer pServer, DWORD dwPostReceiveCount); /* 获取 Receive 预投递数量 */ HPSOCKET_API DWORD __stdcall HP_UdpServer_GetPostReceiveCount(HP_UdpServer pServer); /* 设置监测包尝试次数（0 则不发送监测跳包，如果超过最大尝试次数则认为已断线） */ HPSOCKET_API void __stdcall HP_UdpServer_SetDetectAttempts(HP_UdpServer pServer, DWORD dwDetectAttempts); /* 设置监测包发送间隔（秒，0 不发送监测包） */ HPSOCKET_API void __stdcall HP_UdpServer_SetDetectInterval(HP_UdpServer pServer, DWORD dwDetectInterval); /* 获取心跳检查次数 */ HPSOCKET_API DWORD __stdcall HP_UdpServer_GetDetectAttempts(HP_UdpServer pServer); /* 获取心跳检查间隔 */ HPSOCKET_API DWORD __stdcall HP_UdpServer_GetDetectInterval(HP_UdpServer pServer); /**************************************************************************/ /***************************** Agent 操作方法 *****************************/ /* * 名称：启动通信组件 * 描述：启动通信代理组件，启动完成后可开始连接远程服务器 * * 参数： lpszBindAddress -- 绑定地址（默认：nullptr，绑定 0.0.0.0） * bAsyncConnect -- 是否采用异步 Connect * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 HP_Agent_GetLastError() 获取错误代码 */ HPSOCKET_API BOOL __stdcall HP_Agent_Start(HP_Agent pAgent, LPCTSTR lpszBindAddress, BOOL bAsyncConnect); /* * 名称：关闭通信组件 * 描述：关闭通信组件，关闭完成后断开所有连接并释放所有资源 * * 参数： * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 HP_Agent_GetLastError() 获取错误代码 */ HPSOCKET_API BOOL __stdcall HP_Agent_Stop(HP_Agent pAgent); /* * 名称：连接服务器 * 描述：连接服务器，连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件 * * 参数： lpszRemoteAddress -- 服务端地址 * usPort -- 服务端端口 * pdwConnID -- 连接 ID（默认：nullptr，不获取连接 ID） * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过函数 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Agent_Connect(HP_Agent pAgent, LPCTSTR lpszRemoteAddress, USHORT usPort, HP_CONNID* pdwConnID); /* * 名称：发送数据 * 描述：向指定连接发送数据 * * 参数： dwConnID -- 连接 ID * pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Agent_Send(HP_Agent pAgent, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength); /* * 名称：发送数据 * 描述：向指定连接发送数据 * * 参数： dwConnID -- 连接 ID * pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * iOffset -- 发送缓冲区指针偏移量 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Agent_SendPart(HP_Agent pAgent, HP_CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset); /* * 名称：发送多组数据 * 描述：向指定连接发送多组数据 * TCP - 顺序发送所有数据包 * UDP - 把所有数据包组合成一个数据包发送（数据包的总长度不能大于设置的 UDP 包最大长度） * * 参数： dwConnID -- 连接 ID * pBuffers -- 发送缓冲区数组 * iCount -- 发送缓冲区数目 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Agent_SendPackets(HP_Agent pAgent, HP_CONNID dwConnID, const WSABUF pBuffers[], int iCount); /* * 名称：断开连接 * 描述：断开某个连接 * * 参数： dwConnID -- 连接 ID * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_Agent_Disconnect(HP_Agent pAgent, HP_CONNID dwConnID, BOOL bForce); /* * 名称：断开超时连接 * 描述：断开超过指定时长的连接 * * 参数： dwPeriod -- 时长（毫秒） * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_Agent_DisconnectLongConnections(HP_Agent pAgent, DWORD dwPeriod, BOOL bForce); /* * 名称：断开静默连接 * 描述：断开超过指定时长的静默连接 * * 参数： dwPeriod -- 时长（毫秒） * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_Agent_DisconnectSilenceConnections(HP_Agent pAgent, DWORD dwPeriod, BOOL bForce); /******************************************************************************/ /***************************** Agent 属性访问方法 *****************************/ /* * 名称：设置连接的附加数据 * 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序只身决定 * * 参数： dwConnID -- 连接 ID * pv -- 数据 * 返回值： TRUE -- 成功 * FALSE -- 失败（无效的连接 ID） */ HPSOCKET_API BOOL __stdcall HP_Agent_SetConnectionExtra(HP_Agent pAgent, HP_CONNID dwConnID, PVOID pExtra); /* * 名称：获取连接的附加数据 * 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序只身决定 * * 参数： dwConnID -- 连接 ID * ppv -- 数据指针 * 返回值： TRUE -- 成功 * FALSE -- 失败（无效的连接 ID） */ HPSOCKET_API BOOL __stdcall HP_Agent_GetConnectionExtra(HP_Agent pAgent, HP_CONNID dwConnID, PVOID* ppExtra); /* 检查通信组件是否已启动 */ HPSOCKET_API BOOL __stdcall HP_Agent_HasStarted(HP_Agent pAgent); /* 查看通信组件当前状态 */ HPSOCKET_API En_HP_ServiceState __stdcall HP_Agent_GetState(HP_Agent pAgent); /* 获取连接数 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetConnectionCount(HP_Agent pAgent); /* 获取所有连接的 HP_CONNID */ HPSOCKET_API BOOL __stdcall HP_Agent_GetAllConnectionIDs(HP_Agent pAgent, HP_CONNID pIDs[], DWORD* pdwCount); /* 获取某个连接时长（毫秒） */ HPSOCKET_API BOOL __stdcall HP_Agent_GetConnectPeriod(HP_Agent pAgent, HP_CONNID dwConnID, DWORD* pdwPeriod); /* 获取某个连接静默时间（毫秒） */ HPSOCKET_API BOOL __stdcall HP_Agent_GetSilencePeriod(HP_Agent pAgent, HP_CONNID dwConnID, DWORD* pdwPeriod); /* 获取某个连接的本地地址信息 */ HPSOCKET_API BOOL __stdcall HP_Agent_GetLocalAddress(HP_Agent pAgent, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); /* 获取某个连接的远程地址信息 */ HPSOCKET_API BOOL __stdcall HP_Agent_GetRemoteAddress(HP_Agent pAgent, HP_CONNID dwConnID, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); /* 获取最近一次失败操作的错误代码 */ HPSOCKET_API En_HP_SocketError __stdcall HP_Agent_GetLastError(HP_Agent pAgent); /* 获取最近一次失败操作的错误描述 */ HPSOCKET_API LPCTSTR __stdcall HP_Agent_GetLastErrorDesc(HP_Agent pAgent); /* 获取连接中未发出数据的长度 */ HPSOCKET_API BOOL __stdcall HP_Agent_GetPendingDataLength(HP_Agent pAgent, HP_CONNID dwConnID, int* piPending); /* 设置数据发送策略 */ HPSOCKET_API void __stdcall HP_Agent_SetSendPolicy(HP_Agent pAgent, En_HP_SendPolicy enSendPolicy); /* 设置 Socket 缓存对象锁定时间（毫秒，在锁定期间该 Socket 缓存对象不能被获取使用） */ HPSOCKET_API void __stdcall HP_Agent_SetFreeSocketObjLockTime(HP_Agent pAgent, DWORD dwFreeSocketObjLockTime); /* 设置 Socket 缓存池大小（通常设置为平均并发连接数量的 1/3 - 1/2） */ HPSOCKET_API void __stdcall HP_Agent_SetFreeSocketObjPool(HP_Agent pAgent, DWORD dwFreeSocketObjPool); /* 设置内存块缓存池大小（通常设置为 Socket 缓存池大小的 2 - 3 倍） */ HPSOCKET_API void __stdcall HP_Agent_SetFreeBufferObjPool(HP_Agent pAgent, DWORD dwFreeBufferObjPool); /* 设置 Socket 缓存池回收阀值（通常设置为 Socket 缓存池大小的 3 倍） */ HPSOCKET_API void __stdcall HP_Agent_SetFreeSocketObjHold(HP_Agent pAgent, DWORD dwFreeSocketObjHold); /* 设置内存块缓存池回收阀值（通常设置为内存块缓存池大小的 3 倍） */ HPSOCKET_API void __stdcall HP_Agent_SetFreeBufferObjHold(HP_Agent pAgent, DWORD dwFreeBufferObjHold); /* 设置最大连接数（组件会根据设置值预分配内存，因此需要根据实际情况设置，不宜过大）*/ HPSOCKET_API void __stdcall HP_Agent_SetMaxConnectionCount(HP_Agent pAgent, DWORD dwMaxConnectionCount); /* 设置工作线程数量（通常设置为 2 * CPU + 2） */ HPSOCKET_API void __stdcall HP_Agent_SetWorkerThreadCount(HP_Agent pAgent, DWORD dwWorkerThreadCount); /* 设置是否标记静默时间（设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效，默认：TRUE） */ HPSOCKET_API void __stdcall HP_Agent_SetMarkSilence(HP_Agent pAgent, BOOL bMarkSilence); /* 获取数据发送策略 */ HPSOCKET_API En_HP_SendPolicy __stdcall HP_Agent_GetSendPolicy(HP_Agent pAgent); /* 获取 Socket 缓存对象锁定时间 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetFreeSocketObjLockTime(HP_Agent pAgent); /* 获取 Socket 缓存池大小 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetFreeSocketObjPool(HP_Agent pAgent); /* 获取内存块缓存池大小 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetFreeBufferObjPool(HP_Agent pAgent); /* 获取 Socket 缓存池回收阀值 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetFreeSocketObjHold(HP_Agent pAgent); /* 获取内存块缓存池回收阀值 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetFreeBufferObjHold(HP_Agent pAgent); /* 获取最大连接数 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetMaxConnectionCount(HP_Agent pAgent); /* 获取工作线程数量 */ HPSOCKET_API DWORD __stdcall HP_Agent_GetWorkerThreadCount(HP_Agent pAgent); /* 检测是否标记静默时间 */ HPSOCKET_API BOOL __stdcall HP_Agent_IsMarkSilence(HP_Agent pAgent); /**********************************************************************************/ /******************************* TCP Agent 操作方法 *******************************/ /* * 名称：发送小文件 * 描述：向指定连接发送 4096 KB 以下的小文件 * * 参数： dwConnID -- 连接 ID * lpszFileName -- 文件路径 * pHead -- 头部附加数据 * pTail -- 尾部附加数据 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_TcpAgent_SendSmallFile(HP_Agent pAgent, HP_CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail); /**********************************************************************************/ /***************************** TCP Agent 属性访问方法 *****************************/ /* 设置是否启用地址重用机制（默认：不启用） */ HPSOCKET_API void __stdcall HP_TcpAgent_SetReuseAddress(HP_TcpAgent pAgent, BOOL bReuseAddress); /* 检测是否启用地址重用机制 */ HPSOCKET_API BOOL __stdcall HP_TcpAgent_IsReuseAddress(HP_TcpAgent pAgent); /* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为 1024 的倍数） */ HPSOCKET_API void __stdcall HP_TcpAgent_SetSocketBufferSize(HP_TcpAgent pAgent, DWORD dwSocketBufferSize); /* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */ HPSOCKET_API void __stdcall HP_TcpAgent_SetKeepAliveTime(HP_TcpAgent pAgent, DWORD dwKeepAliveTime); /* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */ HPSOCKET_API void __stdcall HP_TcpAgent_SetKeepAliveInterval(HP_TcpAgent pAgent, DWORD dwKeepAliveInterval); /* 获取通信数据缓冲区大小 */ HPSOCKET_API DWORD __stdcall HP_TcpAgent_GetSocketBufferSize(HP_TcpAgent pAgent); /* 获取正常心跳包间隔 */ HPSOCKET_API DWORD __stdcall HP_TcpAgent_GetKeepAliveTime(HP_TcpAgent pAgent); /* 获取异常心跳包间隔 */ HPSOCKET_API DWORD __stdcall HP_TcpAgent_GetKeepAliveInterval(HP_TcpAgent pAgent); /******************************************************************************/ /***************************** Client 组件操作方法 *****************************/ /* * 名称：启动通信组件 * 描述：启动客户端通信组件并连接服务端，启动完成后可开始收发数据 * * 参数： lpszRemoteAddress -- 服务端地址 * usPort -- 服务端端口 * bAsyncConnect -- 是否采用异步 Connect * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 HP_Client_GetLastError() 获取错误代码 */ HPSOCKET_API BOOL __stdcall HP_Client_Start(HP_Client pClient, LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect); /* * 名称：启动通信组件（并指定绑定地址） * 描述：启动客户端通信组件并连接服务端，启动完成后可开始收发数据 * * 参数： lpszRemoteAddress -- 服务端地址 * usPort -- 服务端端口 * bAsyncConnect -- 是否采用异步 Connect * lpszBindAddress -- 绑定地址（默认：nullptr，TcpClient/UdpClient -> 不执行绑定操作，UdpCast 绑定 -> 0.0.0.0） * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 HP_Client_GetLastError() 获取错误代码 */ HPSOCKET_API BOOL __stdcall HP_Client_StartWithBindAddress(HP_Client pClient, LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect, LPCTSTR lpszBindAddress); /* * 名称：关闭通信组件 * 描述：关闭客户端通信组件，关闭完成后断开与服务端的连接并释放所有资源 * * 参数： * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 HP_Client_GetLastError() 获取错误代码 */ HPSOCKET_API BOOL __stdcall HP_Client_Stop(HP_Client pClient); /* * 名称：发送数据 * 描述：向服务端发送数据 * * 参数： pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Client_Send(HP_Client pClient, const BYTE* pBuffer, int iLength); /* * 名称：发送数据 * 描述：向服务端发送数据 * * 参数： pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * iOffset -- 发送缓冲区指针偏移量 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Client_SendPart(HP_Client pClient, const BYTE* pBuffer, int iLength, int iOffset); /* * 名称：发送多组数据 * 描述：向服务端发送多组数据 * TCP - 顺序发送所有数据包 * UDP - 把所有数据包组合成一个数据包发送（数据包的总长度不能大于设置的 UDP 包最大长度） * * 参数： pBuffers -- 发送缓冲区数组 * iCount -- 发送缓冲区数目 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_Client_SendPackets(HP_Client pClient, const WSABUF pBuffers[], int iCount); /******************************************************************************/ /***************************** Client 属性访问方法 *****************************/ /* 设置连接的附加数据 */ HPSOCKET_API void __stdcall HP_Client_SetExtra(HP_Client pClient, PVOID pExtra); /* 获取连接的附加数据 */ HPSOCKET_API PVOID __stdcall HP_Client_GetExtra(HP_Client pClient); /* 检查通信组件是否已启动 */ HPSOCKET_API BOOL __stdcall HP_Client_HasStarted(HP_Client pClient); /* 查看通信组件当前状态 */ HPSOCKET_API En_HP_ServiceState __stdcall HP_Client_GetState(HP_Client pClient); /* 获取最近一次失败操作的错误代码 */ HPSOCKET_API En_HP_SocketError __stdcall HP_Client_GetLastError(HP_Client pClient); /* 获取最近一次失败操作的错误描述 */ HPSOCKET_API LPCTSTR __stdcall HP_Client_GetLastErrorDesc(HP_Client pClient); /* 获取该组件对象的连接 ID */ HPSOCKET_API HP_CONNID __stdcall HP_Client_GetConnectionID(HP_Client pClient); /* 获取 Client Socket 的地址信息 */ HPSOCKET_API BOOL __stdcall HP_Client_GetLocalAddress(HP_Client pClient, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); /* 获取连接中未发出数据的长度 */ HPSOCKET_API BOOL __stdcall HP_Client_GetPendingDataLength(HP_Client pClient, int* piPending); /* 设置内存块缓存池大小（通常设置为 -> PUSH 模型：5 - 10；PULL 模型：10 - 20 ） */ HPSOCKET_API void __stdcall HP_Client_SetFreeBufferPoolSize(HP_Client pClient, DWORD dwFreeBufferPoolSize); /* 设置内存块缓存池回收阀值（通常设置为内存块缓存池大小的 3 倍） */ HPSOCKET_API void __stdcall HP_Client_SetFreeBufferPoolHold(HP_Client pClient, DWORD dwFreeBufferPoolHold); /* 获取内存块缓存池大小 */ HPSOCKET_API DWORD __stdcall HP_Client_GetFreeBufferPoolSize(HP_Client pClient); /* 获取内存块缓存池回收阀值 */ HPSOCKET_API DWORD __stdcall HP_Client_GetFreeBufferPoolHold(HP_Client pClient); /**********************************************************************************/ /******************************* TCP Client 操作方法 *******************************/ /* * 名称：发送小文件 * 描述：向服务端发送 4096 KB 以下的小文件 * * 参数： lpszFileName -- 文件路径 * pHead -- 头部附加数据 * pTail -- 尾部附加数据 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 SYS_GetLastError() 获取 Windows 错误代码 */ HPSOCKET_API BOOL __stdcall HP_TcpClient_SendSmallFile(HP_Client pClient, LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail); /**********************************************************************************/ /***************************** TCP Client 属性访问方法 *****************************/ /* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为：(N * 1024) - sizeof(TBufferObj)） */ HPSOCKET_API void __stdcall HP_TcpClient_SetSocketBufferSize(HP_TcpClient pClient, DWORD dwSocketBufferSize); /* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */ HPSOCKET_API void __stdcall HP_TcpClient_SetKeepAliveTime(HP_TcpClient pClient, DWORD dwKeepAliveTime); /* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */ HPSOCKET_API void __stdcall HP_TcpClient_SetKeepAliveInterval(HP_TcpClient pClient, DWORD dwKeepAliveInterval); /* 获取通信数据缓冲区大小 */ HPSOCKET_API DWORD __stdcall HP_TcpClient_GetSocketBufferSize(HP_TcpClient pClient); /* 获取正常心跳包间隔 */ HPSOCKET_API DWORD __stdcall HP_TcpClient_GetKeepAliveTime(HP_TcpClient pClient); /* 获取异常心跳包间隔 */ HPSOCKET_API DWORD __stdcall HP_TcpClient_GetKeepAliveInterval(HP_TcpClient pClient); /**********************************************************************************/ /***************************** UDP Client 属性访问方法 *****************************/ /* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */ HPSOCKET_API void __stdcall HP_UdpClient_SetMaxDatagramSize(HP_UdpClient pClient, DWORD dwMaxDatagramSize); /* 获取数据报文最大长度 */ HPSOCKET_API DWORD __stdcall HP_UdpClient_GetMaxDatagramSize(HP_UdpClient pClient); /* 设置监测包尝试次数（0 则不发送监测跳包，如果超过最大尝试次数则认为已断线） */ HPSOCKET_API void __stdcall HP_UdpClient_SetDetectAttempts(HP_UdpClient pClient, DWORD dwDetectAttempts); /* 设置监测包发送间隔（秒，0 不发送监测包） */ HPSOCKET_API void __stdcall HP_UdpClient_SetDetectInterval(HP_UdpClient pClient, DWORD dwDetectInterval); /* 获取心跳检查次数 */ HPSOCKET_API DWORD __stdcall HP_UdpClient_GetDetectAttempts(HP_UdpClient pClient); /* 获取心跳检查间隔 */ HPSOCKET_API DWORD __stdcall HP_UdpClient_GetDetectInterval(HP_UdpClient pClient); /**********************************************************************************/ /****************************** UDP Cast 属性访问方法 ******************************/ /* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */ HPSOCKET_API void __stdcall HP_UdpCast_SetMaxDatagramSize(HP_UdpCast pCast, DWORD dwMaxDatagramSize); /* 获取数据报文最大长度 */ HPSOCKET_API DWORD __stdcall HP_UdpCast_GetMaxDatagramSize(HP_UdpCast pCast); /* 获取当前数据报的远程地址信息（通常在 OnReceive 事件中调用） */ HPSOCKET_API BOOL __stdcall HP_UdpCast_GetRemoteAddress(HP_UdpCast pCast, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); /* 设置是否启用地址重用机制（默认：不启用） */ HPSOCKET_API void __stdcall HP_UdpCast_SetReuseAddress(HP_UdpCast pCast, BOOL bReuseAddress); /* 检测是否启用地址重用机制 */ HPSOCKET_API BOOL __stdcall HP_UdpCast_IsReuseAddress(HP_UdpCast pCast); /* 设置传播模式（组播或广播） */ HPSOCKET_API void __stdcall HP_UdpCast_SetCastMode(HP_UdpCast pCast, En_HP_CastMode enCastMode); /* 获取传播模式 */ HPSOCKET_API En_HP_CastMode __stdcall HP_UdpCast_GetCastMode(HP_UdpCast pCast); /* 设置组播报文的 TTL（0 - 255） */ HPSOCKET_API void __stdcall HP_UdpCast_SetMultiCastTtl(HP_UdpCast pCast, int iMCTtl); /* 获取组播报文的 TTL */ HPSOCKET_API int __stdcall HP_UdpCast_GetMultiCastTtl(HP_UdpCast pCast); /* 设置是否启用组播环路（TRUE or FALSE） */ HPSOCKET_API void __stdcall HP_UdpCast_SetMultiCastLoop(HP_UdpCast pCast, BOOL bMCLoop); /* 检测是否启用组播环路 */ HPSOCKET_API BOOL __stdcall HP_UdpCast_IsMultiCastLoop(HP_UdpCast pCast); /***************************************************************************************/ /***************************** TCP Pull Server 组件操作方法 *****************************/ /* * 名称：抓取数据 * 描述：用户通过该方法从 Socket 组件中抓取数据 * * 参数： dwConnID -- 连接 ID * pData -- 抓取缓冲区 * iLength -- 抓取数据长度 * 返回值： En_HP_FetchResult */ HPSOCKET_API En_HP_FetchResult __stdcall HP_TcpPullServer_Fetch(HP_TcpPullServer pServer, HP_CONNID dwConnID, BYTE* pData, int iLength); /* * 名称：窥探数据（不会移除缓冲区数据） * 描述：用户通过该方法从 Socket 组件中窥探数据 * * 参数： dwConnID -- 连接 ID * pData -- 窥探缓冲区 * iLength -- 窥探数据长度 * 返回值： En_HP_FetchResult */ HPSOCKET_API En_HP_FetchResult __stdcall HP_TcpPullServer_Peek(HP_TcpPullServer pServer, HP_CONNID dwConnID, BYTE* pData, int iLength); /***************************************************************************************/ /***************************** TCP Pull Server 属性访问方法 *****************************/ /***************************************************************************************/ /***************************** TCP Pull Agent 组件操作方法 *****************************/ /* * 名称：抓取数据 * 描述：用户通过该方法从 Socket 组件中抓取数据 * * 参数： dwConnID -- 连接 ID * pData -- 抓取缓冲区 * iLength -- 抓取数据长度 * 返回值： En_HP_FetchResult */ HPSOCKET_API En_HP_FetchResult __stdcall HP_TcpPullAgent_Fetch(HP_TcpPullAgent pAgent, HP_CONNID dwConnID, BYTE* pData, int iLength); /* * 名称：窥探数据（不会移除缓冲区数据） * 描述：用户通过该方法从 Socket 组件中窥探数据 * * 参数： dwConnID -- 连接 ID * pData -- 窥探缓冲区 * iLength -- 窥探数据长度 * 返回值： En_HP_FetchResult */ HPSOCKET_API En_HP_FetchResult __stdcall HP_TcpPullAgent_Peek(HP_TcpPullAgent pAgent, HP_CONNID dwConnID, BYTE* pData, int iLength); /***************************************************************************************/ /***************************** TCP Pull Agent 属性访问方法 *****************************/ /***************************************************************************************/ /***************************** TCP Pull Client 组件操作方法 *****************************/ /* * 名称：抓取数据 * 描述：用户通过该方法从 Socket 组件中抓取数据 * * 参数： dwConnID -- 连接 ID * pData -- 抓取缓冲区 * iLength -- 抓取数据长度 * 返回值： En_HP_FetchResult */ HPSOCKET_API En_HP_FetchResult __stdcall HP_TcpPullClient_Fetch(HP_TcpPullClient pClient, BYTE* pData, int iLength); /* * 名称：窥探数据（不会移除缓冲区数据） * 描述：用户通过该方法从 Socket 组件中窥探数据 * * 参数： dwConnID -- 连接 ID * pData -- 窥探缓冲区 * iLength -- 窥探数据长度 * 返回值： En_HP_FetchResult */ HPSOCKET_API En_HP_FetchResult __stdcall HP_TcpPullClient_Peek(HP_TcpPullClient pClient, BYTE* pData, int iLength); /***************************************************************************************/ /***************************** TCP Pull Client 属性访问方法 *****************************/ /***************************************************************************************/ /***************************** TCP Pack Server 组件操作方法 *****************************/ /***************************************************************************************/ /***************************** TCP Pack Server 属性访问方法 *****************************/ /* 设置数据包最大长度（有效数据包最大长度不能超过 4194303/0x3FFFFF 字节，默认：262144/0x40000） */ HPSOCKET_API void __stdcall HP_TcpPackServer_SetMaxPackSize(HP_TcpPackServer pServer, DWORD dwMaxPackSize); /* 设置包头标识（有效包头标识取值范围 0 ~ 1023/0x3FF，当包头标识为 0 时不校验包头，默认：0） */ HPSOCKET_API void __stdcall HP_TcpPackServer_SetPackHeaderFlag(HP_TcpPackServer pServer, USHORT usPackHeaderFlag); /* 获取数据包最大长度 */ HPSOCKET_API DWORD __stdcall HP_TcpPackServer_GetMaxPackSize(HP_TcpPackServer pServer); /* 获取包头标识 */ HPSOCKET_API USHORT __stdcall HP_TcpPackServer_GetPackHeaderFlag(HP_TcpPackServer pServer); /***************************************************************************************/ /***************************** TCP Pack Agent 组件操作方法 *****************************/ /***************************************************************************************/ /***************************** TCP Pack Agent 属性访问方法 *****************************/ /* 设置数据包最大长度（有效数据包最大长度不能超过 4194303/0x3FFFFF 字节，默认：262144/0x40000） */ HPSOCKET_API void __stdcall HP_TcpPackAgent_SetMaxPackSize(HP_TcpPackAgent pAgent, DWORD dwMaxPackSize); /* 设置包头标识（有效包头标识取值范围 0 ~ 1023/0x3FF，当包头标识为 0 时不校验包头，默认：0） */ HPSOCKET_API void __stdcall HP_TcpPackAgent_SetPackHeaderFlag(HP_TcpPackAgent pAgent, USHORT usPackHeaderFlag); /* 获取数据包最大长度 */ HPSOCKET_API DWORD __stdcall HP_TcpPackAgent_GetMaxPackSize(HP_TcpPackAgent pAgent); /* 获取包头标识 */ HPSOCKET_API USHORT __stdcall HP_TcpPackAgent_GetPackHeaderFlag(HP_TcpPackAgent pAgent); /***************************************************************************************/ /***************************** TCP Pack Client 组件操作方法 *****************************/ /***************************************************************************************/ /***************************** TCP Pack Client 属性访问方法 *****************************/ /* 设置数据包最大长度（有效数据包最大长度不能超过 4194303/0x3FFFFF 字节，默认：262144/0x40000） */ HPSOCKET_API void __stdcall HP_TcpPackClient_SetMaxPackSize(HP_TcpPackClient pClient, DWORD dwMaxPackSize); /* 设置包头标识（有效包头标识取值范围 0 ~ 1023/0x3FF，当包头标识为 0 时不校验包头，默认：0） */ HPSOCKET_API void __stdcall HP_TcpPackClient_SetPackHeaderFlag(HP_TcpPackClient pClient, USHORT usPackHeaderFlag); /* 获取数据包最大长度 */ HPSOCKET_API DWORD __stdcall HP_TcpPackClient_GetMaxPackSize(HP_TcpPackClient pClient); /* 获取包头标识 */ HPSOCKET_API USHORT __stdcall HP_TcpPackClient_GetPackHeaderFlag(HP_TcpPackClient pClient); /*****************************************************************************************************************************************************/ /******************************************************************** HTTP Exports *******************************************************************/ /*****************************************************************************************************************************************************/ /****************************************************/ /******************* HTTP 回调函数 *******************/ /* Complex HTTP 回调函数 */ typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnMessageBegin) (HP_CONNID dwConnID); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnRequestLine) (HP_CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnStatusLine) (HP_CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnHeader) (HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnHeadersComplete) (HP_CONNID dwConnID); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnBody) (HP_CONNID dwConnID, const BYTE* pData, int iLength); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnChunkHeader) (HP_CONNID dwConnID, int iLength); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnChunkComplete) (HP_CONNID dwConnID); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnMessageComplete) (HP_CONNID dwConnID); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnUpgrade) (HP_CONNID dwConnID, En_HP_HttpUpgradeType enUpgradeType); typedef En_HP_HttpParseResult (__stdcall *HP_FN_ComplexHttp_OnParseError) (HP_CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc); /* Single HTTP 回调函数 */ typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnMessageBegin) (HP_HttpClient pClient); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnRequestLine) (HP_HttpClient pClient, LPCSTR lpszMethod, LPCSTR lpszUrl); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnStatusLine) (HP_HttpClient pClient, USHORT usStatusCode, LPCSTR lpszDesc); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnHeader) (HP_HttpClient pClient, LPCSTR lpszName, LPCSTR lpszValue); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnHeadersComplete) (HP_HttpClient pClient); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnBody) (HP_HttpClient pClient, const BYTE* pData, int iLength); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnChunkHeader) (HP_HttpClient pClient, int iLength); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnChunkComplete) (HP_HttpClient pClient); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnMessageComplete) (HP_HttpClient pClient); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnUpgrade) (HP_HttpClient pClient, En_HP_HttpUpgradeType enUpgradeType); typedef En_HP_HttpParseResult (__stdcall *HP_FN_SingleHttp_OnParseError) (HP_HttpClient pClient, int iErrorCode, LPCSTR lpszErrorDesc); /* HTTP Server 回调函数 */ typedef HP_FN_ComplexHttp_OnMessageBegin HP_FN_HttpServer_OnMessageBegin; typedef HP_FN_ComplexHttp_OnRequestLine HP_FN_HttpServer_OnRequestLine; typedef HP_FN_ComplexHttp_OnHeader HP_FN_HttpServer_OnHeader; typedef HP_FN_ComplexHttp_OnHeadersComplete HP_FN_HttpServer_OnHeadersComplete; typedef HP_FN_ComplexHttp_OnBody HP_FN_HttpServer_OnBody; typedef HP_FN_ComplexHttp_OnChunkHeader HP_FN_HttpServer_OnChunkHeader; typedef HP_FN_ComplexHttp_OnChunkComplete HP_FN_HttpServer_OnChunkComplete; typedef HP_FN_ComplexHttp_OnMessageComplete HP_FN_HttpServer_OnMessageComplete; typedef HP_FN_ComplexHttp_OnUpgrade HP_FN_HttpServer_OnUpgrade; typedef HP_FN_ComplexHttp_OnParseError HP_FN_HttpServer_OnParseError; typedef HP_FN_Server_OnPrepareListen HP_FN_HttpServer_OnPrepareListen; typedef HP_FN_Server_OnAccept HP_FN_HttpServer_OnAccept; typedef HP_FN_Server_OnHandShake HP_FN_HttpServer_OnHandShake; typedef HP_FN_Server_OnSend HP_FN_HttpServer_OnSend; typedef HP_FN_Server_OnClose HP_FN_HttpServer_OnClose; typedef HP_FN_Server_OnShutdown HP_FN_HttpServer_OnShutdown; /* HTTP Agent 回调函数 */ typedef HP_FN_ComplexHttp_OnMessageBegin HP_FN_HttpAgent_OnMessageBegin; typedef HP_FN_ComplexHttp_OnStatusLine HP_FN_HttpAgent_OnStatusLine; typedef HP_FN_ComplexHttp_OnHeader HP_FN_HttpAgent_OnHeader; typedef HP_FN_ComplexHttp_OnHeadersComplete HP_FN_HttpAgent_OnHeadersComplete; typedef HP_FN_ComplexHttp_OnBody HP_FN_HttpAgent_OnBody; typedef HP_FN_ComplexHttp_OnChunkHeader HP_FN_HttpAgent_OnChunkHeader; typedef HP_FN_ComplexHttp_OnChunkComplete HP_FN_HttpAgent_OnChunkComplete; typedef HP_FN_ComplexHttp_OnMessageComplete HP_FN_HttpAgent_OnMessageComplete; typedef HP_FN_ComplexHttp_OnUpgrade HP_FN_HttpAgent_OnUpgrade; typedef HP_FN_ComplexHttp_OnParseError HP_FN_HttpAgent_OnParseError; typedef HP_FN_Agent_OnPrepareConnect HP_FN_HttpAgent_OnPrepareConnect; typedef HP_FN_Agent_OnConnect HP_FN_HttpAgent_OnConnect; typedef HP_FN_Agent_OnHandShake HP_FN_HttpAgent_OnHandShake; typedef HP_FN_Agent_OnSend HP_FN_HttpAgent_OnSend; typedef HP_FN_Agent_OnClose HP_FN_HttpAgent_OnClose; typedef HP_FN_Agent_OnShutdown HP_FN_HttpAgent_OnShutdown; /* HTTP Client 回调函数 */ typedef HP_FN_SingleHttp_OnMessageBegin HP_FN_HttpClient_OnMessageBegin; typedef HP_FN_SingleHttp_OnStatusLine HP_FN_HttpClient_OnStatusLine; typedef HP_FN_SingleHttp_OnHeader HP_FN_HttpClient_OnHeader; typedef HP_FN_SingleHttp_OnHeadersComplete HP_FN_HttpClient_OnHeadersComplete; typedef HP_FN_SingleHttp_OnBody HP_FN_HttpClient_OnBody; typedef HP_FN_SingleHttp_OnChunkHeader HP_FN_HttpClient_OnChunkHeader; typedef HP_FN_SingleHttp_OnChunkComplete HP_FN_HttpClient_OnChunkComplete; typedef HP_FN_SingleHttp_OnMessageComplete HP_FN_HttpClient_OnMessageComplete; typedef HP_FN_SingleHttp_OnUpgrade HP_FN_HttpClient_OnUpgrade; typedef HP_FN_SingleHttp_OnParseError HP_FN_HttpClient_OnParseError; typedef HP_FN_Client_OnPrepareConnect HP_FN_HttpClient_OnPrepareConnect; typedef HP_FN_Client_OnConnect HP_FN_HttpClient_OnConnect; typedef HP_FN_Client_OnHandShake HP_FN_HttpClient_OnHandShake; typedef HP_FN_Client_OnSend HP_FN_HttpClient_OnSend; typedef HP_FN_Client_OnClose HP_FN_HttpClient_OnClose; /****************************************************/ /***************** HTTP 对象创建函数 *****************/ // 创建 HP_HttpServer 对象 HPSOCKET_API HP_HttpServer __stdcall Create_HP_HttpServer(HP_HttpServerListener pListener); // 创建 HP_HttpAgent 对象 HPSOCKET_API HP_HttpAgent __stdcall Create_HP_HttpAgent(HP_HttpAgentListener pListener); // 创建 HP_HttpClient 对象 HPSOCKET_API HP_HttpClient __stdcall Create_HP_HttpClient(HP_HttpClientListener pListener); // 销毁 HP_HttpServer 对象 HPSOCKET_API void __stdcall Destroy_HP_HttpServer(HP_HttpServer pServer); // 销毁 HP_HttpAgent 对象 HPSOCKET_API void __stdcall Destroy_HP_HttpAgent(HP_HttpAgent pAgent); // 销毁 HP_HttpClient 对象 HPSOCKET_API void __stdcall Destroy_HP_HttpClient(HP_HttpClient pClient); // 创建 HP_HttpServerListener 对象 HPSOCKET_API HP_HttpServerListener __stdcall Create_HP_HttpServerListener(); // 创建 HP_HttpAgentListener 对象 HPSOCKET_API HP_HttpAgentListener __stdcall Create_HP_HttpAgentListener(); // 创建 HP_HttpClientListener 对象 HPSOCKET_API HP_HttpClientListener __stdcall Create_HP_HttpClientListener(); // 销毁 HP_HttpServerListener 对象 HPSOCKET_API void __stdcall Destroy_HP_HttpServerListener(HP_HttpServerListener pListener); // 销毁 HP_HttpAgentListener 对象 HPSOCKET_API void __stdcall Destroy_HP_HttpAgentListener(HP_HttpAgentListener pListener); // 销毁 HP_HttpClientListener 对象 HPSOCKET_API void __stdcall Destroy_HP_HttpClientListener(HP_HttpClientListener pListener); /**********************************************************************************/ /*************************** HTTP Server 回调函数设置方法 **************************/ HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnMessageBegin(HP_HttpServerListener pListener , HP_FN_HttpServer_OnMessageBegin fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnRequestLine(HP_HttpServerListener pListener , HP_FN_HttpServer_OnRequestLine fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnHeader(HP_HttpServerListener pListener , HP_FN_HttpServer_OnHeader fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnHeadersComplete(HP_HttpServerListener pListener , HP_FN_HttpServer_OnHeadersComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnBody(HP_HttpServerListener pListener , HP_FN_HttpServer_OnBody fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnChunkHeader(HP_HttpServerListener pListener , HP_FN_HttpServer_OnChunkHeader fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnChunkComplete(HP_HttpServerListener pListener , HP_FN_HttpServer_OnChunkComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnMessageComplete(HP_HttpServerListener pListener , HP_FN_HttpServer_OnMessageComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnUpgrade(HP_HttpServerListener pListener , HP_FN_HttpServer_OnUpgrade fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnParseError(HP_HttpServerListener pListener , HP_FN_HttpServer_OnParseError fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnPrepareListen(HP_HttpServerListener pListener , HP_FN_HttpServer_OnPrepareListen fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnAccept(HP_HttpServerListener pListener , HP_FN_HttpServer_OnAccept fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnHandShake(HP_HttpServerListener pListener , HP_FN_HttpServer_OnHandShake fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnSend(HP_HttpServerListener pListener , HP_FN_HttpServer_OnSend fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnClose(HP_HttpServerListener pListener , HP_FN_HttpServer_OnClose fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpServer_OnShutdown(HP_HttpServerListener pListener , HP_FN_HttpServer_OnShutdown fn); /**********************************************************************************/ /**************************** HTTP Agent 回调函数设置方法 **************************/ HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnMessageBegin(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnMessageBegin fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnStatusLine(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnStatusLine fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnHeader(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnHeader fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnHeadersComplete(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnHeadersComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnBody(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnBody fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnChunkHeader(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnChunkHeader fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnChunkComplete(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnChunkComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnMessageComplete(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnMessageComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnUpgrade(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnUpgrade fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnParseError(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnParseError fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnPrepareConnect(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnPrepareConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnConnect(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnHandShake(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnHandShake fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnSend(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnSend fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnClose(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnClose fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpAgent_OnShutdown(HP_HttpAgentListener pListener , HP_FN_HttpAgent_OnShutdown fn); /**********************************************************************************/ /*************************** HTTP Client 回调函数设置方法 **************************/ HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnMessageBegin(HP_HttpClientListener pListener , HP_FN_HttpClient_OnMessageBegin fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnStatusLine(HP_HttpClientListener pListener , HP_FN_HttpClient_OnStatusLine fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnHeader(HP_HttpClientListener pListener , HP_FN_HttpClient_OnHeader fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnHeadersComplete(HP_HttpClientListener pListener , HP_FN_HttpClient_OnHeadersComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnBody(HP_HttpClientListener pListener , HP_FN_HttpClient_OnBody fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnChunkHeader(HP_HttpClientListener pListener , HP_FN_HttpClient_OnChunkHeader fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnChunkComplete(HP_HttpClientListener pListener , HP_FN_HttpClient_OnChunkComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnMessageComplete(HP_HttpClientListener pListener , HP_FN_HttpClient_OnMessageComplete fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnUpgrade(HP_HttpClientListener pListener , HP_FN_HttpClient_OnUpgrade fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnParseError(HP_HttpClientListener pListener , HP_FN_HttpClient_OnParseError fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnPrepareConnect(HP_HttpClientListener pListener , HP_FN_HttpClient_OnPrepareConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnConnect(HP_HttpClientListener pListener , HP_FN_HttpClient_OnConnect fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnHandShake(HP_HttpClientListener pListener , HP_FN_HttpClient_OnHandShake fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnSend(HP_HttpClientListener pListener , HP_FN_HttpClient_OnSend fn); HPSOCKET_API void __stdcall HP_Set_FN_HttpClient_OnClose(HP_HttpClientListener pListener , HP_FN_HttpClient_OnClose fn); /**************************************************************************/ /***************************** Server 操作方法 *****************************/ /* * 名称：回复请求 * 描述：向客户端回复 HTTP 请求 * * 参数： dwConnID -- 连接 ID * usStatusCode -- HTTP 状态码 * lpszDesc -- HTTP 状态描述 * lpHeaders -- 回复请求头 * iHeaderCount -- 回复请求头数量 * pData -- 回复请求体 * iLength -- 回复请求体长度 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_HttpServer_SendResponse(HP_HttpServer pServer, HP_CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pData, int iLength); /* * 名称：释放连接 * 描述：把连接放入释放队列，等待某个时间（通过 SetReleaseDelay() 设置）关闭连接 * * 参数： dwConnID -- 连接 ID * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_HttpServer_Release(HP_HttpServer pServer, HP_CONNID dwConnID); /******************************************************************************/ /***************************** Server 属性访问方法 *****************************/ /* 设置连接释放延时（默认：3000 毫秒） */ HPSOCKET_API void __stdcall HP_HttpServer_SetReleaseDelay(HP_HttpServer pServer, DWORD dwReleaseDelay); /* 获取连接释放延时 */ HPSOCKET_API DWORD __stdcall HP_HttpServer_GetReleaseDelay(HP_HttpServer pServer); /* 获取请求行 URL 域掩码（URL 域参考：EnHttpUrlField） */ HPSOCKET_API USHORT __stdcall HP_HttpServer_GetUrlFieldSet(HP_HttpServer pServer, HP_CONNID dwConnID); /* 获取某个 URL 域值 */ HPSOCKET_API LPCSTR __stdcall HP_HttpServer_GetUrlField(HP_HttpServer pServer, HP_CONNID dwConnID, En_HP_HttpUrlField enField); /* 获取请求方法 */ HPSOCKET_API LPCSTR __stdcall HP_HttpServer_GetMethod(HP_HttpServer pServer, HP_CONNID dwConnID); /* 设置本地协议版本 */ HPSOCKET_API void __stdcall HP_HttpServer_SetLocalVersion(HP_HttpServer pServer, En_HP_HttpVersion usVersion); /* 获取本地协议版本 */ HPSOCKET_API En_HP_HttpVersion __stdcall HP_HttpServer_GetLocalVersion(HP_HttpServer pServer); /* 检查是否升级协议 */ HPSOCKET_API BOOL __stdcall HP_HttpServer_IsUpgrade(HP_HttpServer pServer, HP_CONNID dwConnID); /* 检查是否有 Keep-Alive 标识 */ HPSOCKET_API BOOL __stdcall HP_HttpServer_IsKeepAlive(HP_HttpServer pServer, HP_CONNID dwConnID); /* 获取协议版本 */ HPSOCKET_API USHORT __stdcall HP_HttpServer_GetVersion(HP_HttpServer pServer, HP_CONNID dwConnID); /* 获取内容长度 */ HPSOCKET_API ULONGLONG __stdcall HP_HttpServer_GetContentLength(HP_HttpServer pServer, HP_CONNID dwConnID); /* 获取内容类型 */ HPSOCKET_API LPCSTR __stdcall HP_HttpServer_GetContentType(HP_HttpServer pServer, HP_CONNID dwConnID); /* 获取协议升级类型 */ HPSOCKET_API En_HP_HttpUpgradeType __stdcall HP_HttpServer_GetUpgradeType(HP_HttpServer pServer, HP_CONNID dwConnID); /* 获取解析错误代码 */ HPSOCKET_API USHORT __stdcall HP_HttpServer_GetParseErrorCode(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR* lpszErrorDesc); /* 获取某个请求头（单值） */ HPSOCKET_API BOOL __stdcall HP_HttpServer_GetHeader(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue); /* 获取某个请求头（多值） */ HPSOCKET_API BOOL __stdcall HP_HttpServer_GetHeaders(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD* pdwCount); /* 获取所有请求头 */ HPSOCKET_API BOOL __stdcall HP_HttpServer_GetAllHeaders(HP_HttpServer pServer, HP_CONNID dwConnID, HP_THeader lpHeaders[], DWORD* pdwCount); /* 获取所有请求头名称 */ HPSOCKET_API BOOL __stdcall HP_HttpServer_GetAllHeaderNames(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName[], DWORD* pdwCount); /* 获取 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpServer_GetCookie(HP_HttpServer pServer, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue); /* 获取所有 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpServer_GetAllCookies(HP_HttpServer pServer, HP_CONNID dwConnID, HP_TCookie lpCookies[], DWORD* pdwCount); /**************************************************************************/ /***************************** Agent 操作方法 ******************************/ /* * 名称：发送请求 * 描述：向服务端发送 HTTP 请求 * * 参数： dwConnID -- 连接 ID * lpszMethod -- 请求方法 * lpszPath -- 请求路径 * lpHeaders -- 请求头 * iHeaderCount -- 请求头数量 * pBody -- 请求体 * iLength -- 请求体长度 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendRequest(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pData, int iLength); /* 发送 POST 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendPost(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength); /* 发送 PUT 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendPut(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength); /* 发送 PATCH 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendPatch(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength); /* 发送 GET 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendGet(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 DELETE 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendDelete(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 HEAD 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendHead(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 TRACE 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendTrace(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 OPTIONS 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendOptions(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 CONNECT 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_SendConnect(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszHost, const HP_THeader lpHeaders[], int iHeaderCount); /******************************************************************************/ /***************************** Agent 属性访问方法 ******************************/ /* 获取 HTTP 状态码 */ HPSOCKET_API USHORT __stdcall HP_HttpAgent_GetStatusCode(HP_HttpAgent pAgent, HP_CONNID dwConnID); /* 设置本地协议版本 */ HPSOCKET_API void __stdcall HP_HttpAgent_SetLocalVersion(HP_HttpAgent pAgent, En_HP_HttpVersion usVersion); /* 获取本地协议版本 */ HPSOCKET_API En_HP_HttpVersion __stdcall HP_HttpAgent_GetLocalVersion(HP_HttpAgent pAgent); /* 检查是否升级协议 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_IsUpgrade(HP_HttpAgent pAgent, HP_CONNID dwConnID); /* 检查是否有 Keep-Alive 标识 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_IsKeepAlive(HP_HttpAgent pAgent, HP_CONNID dwConnID); /* 获取协议版本 */ HPSOCKET_API USHORT __stdcall HP_HttpAgent_GetVersion(HP_HttpAgent pAgent, HP_CONNID dwConnID); /* 获取内容长度 */ HPSOCKET_API ULONGLONG __stdcall HP_HttpAgent_GetContentLength(HP_HttpAgent pAgent, HP_CONNID dwConnID); /* 获取内容类型 */ HPSOCKET_API LPCSTR __stdcall HP_HttpAgent_GetContentType(HP_HttpAgent pAgent, HP_CONNID dwConnID); /* 获取协议升级类型 */ HPSOCKET_API En_HP_HttpUpgradeType __stdcall HP_HttpAgent_GetUpgradeType(HP_HttpAgent pAgent, HP_CONNID dwConnID); /* 获取解析错误代码 */ HPSOCKET_API USHORT __stdcall HP_HttpAgent_GetParseErrorCode(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR* lpszErrorDesc); /* 获取某个请求头（单值） */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_GetHeader(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue); /* 获取某个请求头（多值） */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_GetHeaders(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD* pdwCount); /* 获取所有请求头 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_GetAllHeaders(HP_HttpAgent pAgent, HP_CONNID dwConnID, HP_THeader lpHeaders[], DWORD* pdwCount); /* 获取所有请求头名称 */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_GetAllHeaderNames(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName[], DWORD* pdwCount); /* 获取 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_GetCookie(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue); /* 获取所有 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_GetAllCookies(HP_HttpAgent pAgent, HP_CONNID dwConnID, HP_TCookie lpCookies[], DWORD* pdwCount); /* 添加 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_AddCookie(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue, BOOL bRelpace); /* 删除 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_DeleteCookie(HP_HttpAgent pAgent, HP_CONNID dwConnID, LPCSTR lpszName); /* 删除所有 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpAgent_DeleteAllCookies(HP_HttpAgent pAgent, HP_CONNID dwConnID); /**************************************************************************/ /***************************** Client 操作方法 *****************************/ /* * 名称：发送请求 * 描述：向服务端发送 HTTP 请求 * * 参数： lpszMethod -- 请求方法 * lpszPath -- 请求路径 * lpHeaders -- 请求头 * iHeaderCount -- 请求头数量 * pBody -- 请求体 * iLength -- 请求体长度 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendRequest(HP_HttpClient pClient, LPCSTR lpszMethod, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength); /* 发送 POST 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendPost(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength); /* 发送 PUT 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendPut(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength); /* 发送 PATCH 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendPatch(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength); /* 发送 GET 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendGet(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 DELETE 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendDelete(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 HEAD 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendHead(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 TRACE 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendTrace(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 OPTIONS 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendOptions(HP_HttpClient pClient, LPCSTR lpszPath, const HP_THeader lpHeaders[], int iHeaderCount); /* 发送 CONNECT 请求 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_SendConnect(HP_HttpClient pClient, LPCSTR lpszHost, const HP_THeader lpHeaders[], int iHeaderCount); /******************************************************************************/ /***************************** Client 属性访问方法 *****************************/ /* 获取 HTTP 状态码 */ HPSOCKET_API USHORT __stdcall HP_HttpClient_GetStatusCode(HP_HttpClient pClient); /* 设置本地协议版本 */ HPSOCKET_API void __stdcall HP_HttpClient_SetLocalVersion(HP_HttpClient pClient, En_HP_HttpVersion usVersion); /* 获取本地协议版本 */ HPSOCKET_API En_HP_HttpVersion __stdcall HP_HttpClient_GetLocalVersion(HP_HttpClient pClient); /* 检查是否升级协议 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_IsUpgrade(HP_HttpClient pClient); /* 检查是否有 Keep-Alive 标识 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_IsKeepAlive(HP_HttpClient pClient); /* 获取协议版本 */ HPSOCKET_API USHORT __stdcall HP_HttpClient_GetVersion(HP_HttpClient pClient); /* 获取内容长度 */ HPSOCKET_API ULONGLONG __stdcall HP_HttpClient_GetContentLength(HP_HttpClient pClient); /* 获取内容类型 */ HPSOCKET_API LPCSTR __stdcall HP_HttpClient_GetContentType(HP_HttpClient pClient); /* 获取协议升级类型 */ HPSOCKET_API En_HP_HttpUpgradeType __stdcall HP_HttpClient_GetUpgradeType(HP_HttpClient pClient); /* 获取解析错误代码 */ HPSOCKET_API USHORT __stdcall HP_HttpClient_GetParseErrorCode(HP_HttpClient pClient, LPCSTR* lpszErrorDesc); /* 获取某个请求头（单值） */ HPSOCKET_API BOOL __stdcall HP_HttpClient_GetHeader(HP_HttpClient pClient, LPCSTR lpszName, LPCSTR* lpszValue); /* 获取某个请求头（多值） */ HPSOCKET_API BOOL __stdcall HP_HttpClient_GetHeaders(HP_HttpClient pClient, LPCSTR lpszName, LPCSTR lpszValue[], DWORD* pdwCount); /* 获取所有请求头 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_GetAllHeaders(HP_HttpClient pClient, HP_THeader lpHeaders[], DWORD* pdwCount); /* 获取所有请求头名称 */ HPSOCKET_API BOOL __stdcall HP_HttpClient_GetAllHeaderNames(HP_HttpClient pClient, LPCSTR lpszName[], DWORD* pdwCount); /* 获取 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpClient_GetCookie(HP_HttpClient pClient, LPCSTR lpszName, LPCSTR* lpszValue); /* 获取所有 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpClient_GetAllCookies(HP_HttpClient pClient, HP_TCookie lpCookies[], DWORD* pdwCount); /* 添加 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpClient_AddCookie(HP_HttpClient pClient, LPCSTR lpszName, LPCSTR lpszValue, BOOL bRelpace); /* 删除 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpClient_DeleteCookie(HP_HttpClient pClient, LPCSTR lpszName); /* 删除所有 Cookie */ HPSOCKET_API BOOL __stdcall HP_HttpClient_DeleteAllCookies(HP_HttpClient pClient); /*****************************************************************************************************************************************************/ /*************************************************************** Global Function Exports *************************************************************/ /*****************************************************************************************************************************************************/ /* 获取错误描述文本 */ HPSOCKET_API LPCTSTR __stdcall HP_GetSocketErrorDesc(En_HP_SocketError enCode); /* 调用系统的 GetLastError() 方法获取系统错误代码 */ HPSOCKET_API DWORD __stdcall SYS_GetLastError(); // 调用系统的 WSAGetLastError() 方法获取系统错误代码 HPSOCKET_API int __stdcall SYS_WSAGetLastError(); // 调用系统的 setsockopt() HPSOCKET_API int __stdcall SYS_SetSocketOption(SOCKET sock, int level, int name, LPVOID val, int len); // 调用系统的 getsockopt() HPSOCKET_API int __stdcall SYS_GetSocketOption(SOCKET sock, int level, int name, LPVOID val, int* len); // 调用系统的 ioctlsocket() HPSOCKET_API int __stdcall SYS_IoctlSocket(SOCKET sock, long cmd, u_long* arg); // 调用系统的 WSAIoctl() HPSOCKET_API int __stdcall SYS_WSAIoctl(SOCKET sock, DWORD dwIoControlCode, LPVOID lpvInBuffer, DWORD cbInBuffer, LPVOID lpvOutBuffer, DWORD cbOutBuffer, LPDWORD lpcbBytesReturned); // 设置 socket 选项：IPPROTO_TCP -> TCP_NODELAY HPSOCKET_API int __stdcall SYS_SSO_NoDelay(SOCKET sock, BOOL bNoDelay); // 设置 socket 选项：SOL_SOCKET -> SO_DONTLINGER HPSOCKET_API int __stdcall SYS_SSO_DontLinger(SOCKET sock, BOOL bDont); // 设置 socket 选项：SOL_SOCKET -> SO_LINGER HPSOCKET_API int __stdcall SYS_SSO_Linger(SOCKET sock, USHORT l_onoff, USHORT l_linger); // 设置 socket 选项：SOL_SOCKET -> SO_RCVBUF HPSOCKET_API int __stdcall SYS_SSO_RecvBuffSize(SOCKET sock, int size); // 设置 socket 选项：SOL_SOCKET -> SO_SNDBUF HPSOCKET_API int __stdcall SYS_SSO_SendBuffSize(SOCKET sock, int size); // 设置 socket 选项：SOL_SOCKET -> SO_REUSEADDR HPSOCKET_API int __stdcall SYS_SSO_ReuseAddress(SOCKET sock, BOOL bReuse); // 获取 SOCKET 本地地址信息 HPSOCKET_API BOOL __stdcall SYS_GetSocketLocalAddress(SOCKET socket, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort); // 获取 SOCKET 远程地址信息 HPSOCKET_API BOOL __stdcall SYS_GetSocketRemoteAddress(SOCKET socket, TCHAR lpszAddress[], int* piAddressLen, USHORT* pusPort);