模块名称:WS客户端
模块作者:
模块版本:1.0
模块 MD5:db59e501455580f7cb32e8772b28bb1a
模块大小:1.61 MB
版权声明:
模块描述:WS客户端
模块备注:
WS客户端
引用支持库:
系统核心支持库 5.7|krnln|d09f2340818511d396f6aaf844c7e325
特殊功能支持库 3.1|spec|A512548E76954B6E92C21055517615B0
数据操作支持库一 2.0|dp1|4BB4003860154917BC7D8230BF4FA58A
------------------------------
.子程序 _HP_A2W, 字节集, ,
.参数 Ansi, 文本型, ,
.子程序 _HP_Base64Decode, 字节集, ,
.参数 byte, 字节集, ,
.子程序 _HP_Base64Encode, 字节集, ,
.参数 byte, 字节集, ,
.子程序 _HP_Compress, 字节集, , 普通压缩
.参数 szSrc, 字节集, ,
.子程序 _HP_CompressEx, 字节集, , 高级压缩
.参数 szSrc, 字节集, ,
.参数 iLevel, 整数型, 可空 , 默认:-1
.参数 iMethod, 整数型, 可空 , 默认:8
.参数 iWindowBits, 整数型, 可空 , 默认:15
.参数 iMemLevel, 整数型, 可空 , 默认:8
.参数 iStrategy, 整数型, 可空 , 默认:0
.子程序 _HP_EnumHostIPAddresse, 整数型, , /* 枚举主机 IP 地址 */
.参数 lpszHost, 文本型, ,
.参数 TipArray, TIPAddr, 参考 数组,
.子程序 _HP_GbkToUtf8, 文本型, ,
.参数 gbk, 文本型, ,
.子程序 _HP_GetByte, 字节型, , 获取指针下字节型值
.参数 Ptr, 整数型, ,
.参数 dev, 整数型, ,
.子程序 _HP_GetBytesLength, 整数型, , 取字节集长度
.参数 bytes, 字节集, ,
.子程序 _HP_GetBytesPtr, 整数型, , 取字节集指针
.参数 bytes, 字节集, 参考 ,
.子程序 _HP_GetDword, 整数型, , 获取指针下整数型值
.参数 Ptr, 整数型, ,
.参数 dev, 整数型, ,
.子程序 _HP_GetIPAddress, 文本型, ,
.参数 lpHost, 文本型, ,
.子程序 _HP_GZipCompress, 字节集, , Gzip 压缩
.参数 szSrc, 字节集, ,
.子程序 _HP_GZipUncompress, 字节集, , GZip 解压
.参数 szSrc, 字节集, ,
.子程序 _HP_IsIPAddress, 逻辑型, , /* 检查字符串是否符合 IP 地址格式 */
.参数 lpszAddress, 文本型, ,
.子程序 _HP_Max, 整数型, , 两数取最大
.参数 a, 整数型, ,
.参数 b, 整数型, ,
.子程序 _HP_Min, 整数型, , 两数取最小
.参数 a, 整数型, ,
.参数 b, 整数型, ,
.子程序 _HP_SetByte, , , 设置指针下字节型值
.参数 Ptr, 整数型, ,
.参数 dev, 整数型, ,
.参数 byte, 字节型, ,
.子程序 _HP_SetDword, , , 设置指针下整数型值
.参数 Ptr, 整数型, ,
.参数 dev, 整数型, ,
.参数 val, 整数型, ,
.子程序 _HP_SSL_RemoveThreadLocalState, , , 名称:清理线程局部环境 SSL 资源 描述:任何一个操作 SSL 的线程,通信结束时都需要清理线程局部环境 SSL 资源,无,/
.参数 dwThreadID, 整数型, , 线程 ID(0:当前线程)
.子程序 _HP_Uncompress, 字节集, , 普通解压
.参数 szSrc, 字节集, ,
.子程序 _HP_UncompressEx, 字节集, , 高级解压
.参数 szSrc, 字节集, ,
.参数 iWindowBits, 整数型, 可空 , 默认:15
.子程序 _HP_UrlDecode, 文本型, ,
.参数 lpszSrc, 文本型, ,
.参数 utf8, 逻辑型, 可空 ,
.子程序 _HP_UrlEncode, 文本型, ,
.参数 szSrc, 文本型, ,
.参数 utf8, 逻辑型, 可空 ,
.子程序 _HP_Utf8ToGbk, 文本型, ,
.参数 utf8, 文本型, ,
.子程序 _HP_W2A, 文本型, ,
.参数 Unicode, 字节集, ,
.子程序 GetHttpDefaultStatusCodeDesc, 文本型, , 获取HTTP状态码文本描述
.参数 enCode, 整数型, ,
.子程序 SysGetNumberOfProcessors, 整数型, , 获取CPU核心数
.子程序 客户端_断开, 逻辑型, ,
.参数 dwConnID, 整数型, ,
.参数 强制, 逻辑型, 可空 ,
.子程序 客户端_发送消息体数据, , ,
.参数 dwConnID, 整数型, ,
.参数 data, 文本型, ,
.参数 结束包, 逻辑型, 可空 ,
.参数 通讯协议, 字节型, 可空 , iReserved RSV1, RSV2, RSV3: 分别都是1位,如果双方之间没有约定自定义协议,那么这几位的值都必须为0,否则必须断掉WebSocket连接
.参数 掩码, 字节集, 可空 ,
.参数 ullBodyLen, 长整数型, 可空 ,
.子程序 客户端_发送消息体文本, 逻辑型, ,
.参数 dwConnID, 整数型, ,
.参数 data, 文本型, ,
.参数 结束包, 逻辑型, 可空 ,
.参数 通讯协议, 字节型, 可空 , iReserved RSV1, RSV2, RSV3: 分别都是1位,如果双方之间没有约定自定义协议,那么这几位的值都必须为0,否则必须断掉WebSocket连接
.参数 掩码, 字节集, 可空 ,
.参数 ullBodyLen, 长整数型, 可空 ,
.子程序 客户端_连接, 整数型, ,
.参数 要连接的URL地址, 文本型, ,
.参数 erro, 文本型, 参考 可空 ,
.参数 指定本地出口地址, 文本型, 可空 , 指定本地出口地址(多IP出口才用到) (默认:0.0.0.0 )
.参数 指定本地端口, 整数型, 可空 , 本地端口(默认:0 自动)
.子程序 客户端_取回数据, 字节集, ,
.参数 pSender, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 客户端_取回文本, 文本型, ,
.参数 pSender, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 客户端_取回消息状态, 逻辑型, ,
.参数 dwConnID, 整数型, , 客户端_连接() 返回的连接ID
.参数 lpbFinal, 逻辑型, 参考 可空 , 请提供变量来接收 是否结束帧
.参数 lpiReserved, 字节型, 参考 可空 , 请提供变量来接收 RSV1/RSV2/RSV3 各 1 位
.参数 lpiOperationCode, 字节型, 参考 , 请提供变量来接收 操作码:0x0 - 0xF (0=连续消息分片 1=文本消息分片 2=二进制消息分片 8=连接关闭 9=心跳Ping 10=心跳Pong)
.参数 lpszMask, 整数型, 参考 可空 , 请提供变量来接收 掩码:指针到字节集,长度=4
.参数 lpullBodyLen, 长整数型, 参考 可空 , 请提供变量来接收 消息总长度
.参数 lpullBodyRemain, 长整数型, 参考 可空 , 请提供变量来接收
.子程序 客户端_全局绑定事件, , ,
.参数 连接成功, 子程序指针, 可空 ,
.参数 连接断开, 子程序指针, 可空 ,
.参数 消息到达, 子程序指针, 可空 ,
.参数 连接错误, 子程序指针, 可空 ,
.子程序 客户端_全局初始化, 逻辑型, ,
.参数 bSSL, 逻辑型, ,
.参数 线程数, 整数型, 可空 ,
.参数 连接数, 整数型, 可空 ,
.参数 绑定地址, 文本型, 可空 ,
.参数 异步模式, 逻辑型, 可空 , 默认异步
.子程序 客户端_全局销毁, , ,
.子程序 模块初始化_421, , ,
.子程序 自动绑定协议, , ,
.数据类型 TIPAddr, 公开, IP 地址条目结构体
.成员 type, 整数型, , , #IPT_ 开头常量
.成员 address, 文本型, , ,
.数据类型 TNVPair, 公开, 描述:字符串名值对结构体
.成员 name, 文本型, , ,
.成员 value, 文本型, , ,
.数据类型 TSocketTask, 公开, Socket 任务结构体,封装 Socket 任务相关数据结构
.成员 fnTaskProc, 整数型, , , 任务入口函数
.成员 pSender, 整数型, , , 发起对象
.成员 dwConnID, 整数型, , , 连接 ID
.成员 pBuffer, 整数型, , , 数据缓冲区
.成员 iBuffLen, 整数型, , , 数据缓冲区长度
.成员 bufType, 逻辑型, , , 缓冲区类型
.成员 wParam, 整数型, , , 自定义参数
.成员 lParam, 整数型, , , 自定义参数
.数据类型 WSABUF, 公开,
.成员 len, 整数型, , ,
.成员 buf, 字节集, , ,
.程序集 IAgent, , 公开
.子程序 CleanupSSLContext, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 Connect, 逻辑型, , 名称:连接服务器 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取连接数
.参数 hAgent, 整数型, ,
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个连接时长(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hAgent, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hAgent, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hAgent, 整数型, ,
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hAgent, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hAgent, 整数型, ,
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hAgent, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hAgent, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hAgent, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hAgent, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 获取地址重用选项, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hAgent, 整数型, ,
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接数, 整数型, , GetConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接时长, 逻辑型, , GetConnectPeriod(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hAgent, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hAgent, 整数型, ,
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hAgent, 整数型, ,
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hAgent, 整数型, ,
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hAgent, 整数型, ,
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hAgent, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hAgent, 整数型, ,
.子程序 连接服务器, 逻辑型, , 名称:Connect 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 清理通信组件SSL运行环境, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IBufferPtr, , 公开
.子程序 Attach, , , 只能附加本类 This() 返回的数据
.参数 ptr, 整数型, , 指针
.子程序 Bytes, 字节集, , 返回字节集
.子程序 Cat, , , 添加字节集数据
.参数 bytes, 字节集, , 字节集数据
.子程序 Cat_Ptr, , , 添加数据指针
.参数 ptr, 整数型, , 数据指针
.参数 size, 整数型, , 数据长度
.子程序 Free, , , 释放数据
.子程序 Get, 整数型, , 获取数据指针
.参数 dev, 整数型, 可空 , 偏移
.子程序 IsValid, 逻辑型, , 是否有数据
.子程序 Malloc, 整数型, , 申请内存
.参数 size, 整数型, , 内存大小
.参数 zero, 逻辑型, 可空 , 是否清零
.子程序 New, 逻辑型, , 创建一个新指针
.子程序 Realloc, 整数型, , 重置数据大小
.参数 size, 整数型, , 内存大小
.参数 zero, 逻辑型, 可空 , 是否清零
.子程序 Release, , , 释放指针,最后一定要自己执行
.子程序 Size, 整数型, , 返回数据大小
.子程序 This, 整数型, , 返回本类数据,返回0表示没有数据
.子程序 创建一个新指针, 逻辑型, , New
.子程序 返回本类数据返回0表示没有数据, 整数型, , 返回本类数据,返回0表示没有数据
.子程序 返回数据大小, 整数型, , Size
.子程序 返回字节集, 字节集, , Bytes
.子程序 获取数据指针, 整数型, , Get
.参数 dev, 整数型, 可空 , 偏移
.子程序 申请内存, 整数型, , Malloc
.参数 size, 整数型, , 内存大小
.参数 zero, 逻辑型, 可空 , 是否清零
.子程序 是否有数据, 逻辑型, , IsValid
.子程序 释放数据, , , Free
.子程序 释放指针, , , Release,最后一定要自己执行
.子程序 添加数据指针, , , Cat_Ptr
.参数 ptr, 整数型, , 数据指针
.参数 size, 整数型, , 数据长度
.子程序 添加字节集数据, , , Cat
.参数 bytes, 字节集, , 字节集数据
.子程序 只能附加本类This, , , 只能附加本类 This() 返回的数据
.参数 ptr, 整数型, , 指针
.子程序 重置数据大小, 整数型, , Realloc
.参数 size, 整数型, , 内存大小
.参数 zero, 逻辑型, 可空 , 是否清零
.程序集 IClient, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IHttpAgent, , 公开
.子程序 CleanupSSLContext, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 Connect, 逻辑型, , 名称:连接服务器 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 Create, 整数型, , 创建 HP_HttpAgent 或 HP_HttpsAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 HttpAgentListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_HttpAgent 或 HP_HttpsAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 HttpAgentListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetAllCookies, 逻辑型, , 获取所有 Cookie
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetAllHeaderNames, 逻辑型, , 获取所有请求头名称
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 GetAllHeaders, 逻辑型, , 取得所有HTTP返回协议头
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetConnectionCount, 整数型, , 获取连接数
.参数 hAgent, 整数型, ,
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个连接时长(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetContentEncoding, 文本型, , 获取内容编码
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 GetContentLength, 长整数型, , 获取内容长度
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 GetContentType, 文本型, , 获取内容类型
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 GetCookie, 文本型, , 获取 Cookie
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetHeader, 文本型, , 获取某个请求头(单值)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetHeaders, 逻辑型, , 获取某个请求头(多值)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hAgent, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hAgent, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 GetLocalVersion, 整数型, , 获取本地协议版本
.参数 hAgent, 整数型, ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hAgent, 整数型, ,
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hAgent, 整数型, , 服务句柄
.子程序 GetParseErrorCode, 短整数, , 获取解析错误代码
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hAgent, 整数型, ,
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 GetStatusCode, 短整数, , 获取 HTTP 状态码
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 GetTransferEncoding, 文本型, , 获取传输编码
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 GetUpgradeType, 整数型, , 获取协议升级类型
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 GetVersion, 短整数, , 获取协议版本
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hAgent, 整数型, ,
.子程序 GetWSMessageState, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hAgent, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsHttpAutoStart, 逻辑型, , 获取 HTTP 启动方式
.参数 hAgent, 整数型, ,
.子程序 IsKeepAlive, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hAgent, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hAgent, 整数型, ,
.子程序 IsUpgrade, 逻辑型, , 检查是否升级协议
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 IsUseCookie, 逻辑型, , 检查是否使用 Cookie
.参数 hAgent, 整数型, ,
.子程序 OnBody, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnChunkComplete, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnChunkHeader, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHeader, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 OnHeadersComplete, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageBegin, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageComplete, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnParseError, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 OnStatusLine, 逻辑型, , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,dwConnID 整数,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 OnUpgrade, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 OnWSMessageBody, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnWSMessageComplete, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnWSMessageHeader, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendChunkData, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 SendConnect, 逻辑型, , 发送 Connect 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendDelete, 逻辑型, , 发送 DELETE 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendGet, 逻辑型, , 发送 GET 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendHead, 逻辑型, , 发送 Head 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendLocalFile, 逻辑型, , 名称:发送本地文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.子程序 SendOptions, 逻辑型, , 发送 Options 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendPatch, 逻辑型, , 发送 PATCH 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendPost, 逻辑型, , 发送 POST 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendPut, 逻辑型, , 发送 PUT 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendRequest, 逻辑型, , 名称:发送请求 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.参数 pData, 字节集, 可空 ,
.子程序 SendTrace, 逻辑型, , 发送 Trace 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendWSMessage, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, 可空 , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetHttpAutoStart, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hAgent, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 SetLocalVersion, , , 设置本地协议版本
.参数 hAgent, 整数型, ,
.参数 usVersion, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 SetUseCookie, , , 设置是否使用 Cookie
.参数 hAgent, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 StartHttp, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接ID
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_Chunked报文头事件, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 绑定_Chunked报文完成事件, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_WebSocket数据包体事件, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_WebSocket数据包头事件, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 绑定_WebSocket数据包完成事件, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_解析错误事件, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 绑定_开始解析事件, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_请求体报文事件, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_请求头事件, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 绑定_请求头完成事件, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_升级协议事件, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_完成解析事件, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_状态行解析完成事件, 逻辑型, , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,dwConnID 整数,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_HttpAgent或HP_HttpsAgent对象, 整数型, , 创建 HP_HttpAgent 或 HP_HttpsAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HttpAgentListener对象, 整数型, , 创建 HttpAgentListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送Chunked数据分片, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 发送Connect请求, 逻辑型, , 发送 Connect 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送DELETE请求, 逻辑型, , 发送 DELETE 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送GET请求, 逻辑型, , 发送 GET 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送Head请求, 逻辑型, , 发送 Head 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送Options请求, 逻辑型, , 发送 Options 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送PATCH请求, 逻辑型, , 发送 PATCH 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送POST请求, 逻辑型, , 发送 POST 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送PUT请求, 逻辑型, , 发送 PUT 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送Trace请求, 逻辑型, , 发送 Trace 请求
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送WebSocket消息, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, 可空 , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 发送本地文件, 逻辑型, , 名称:SendLocalFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送请求, 逻辑型, , 名称:SendRequest 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.参数 pData, 字节集, 可空 ,
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 获取Cookie, 文本型, , 获取 Cookie
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取HTTP启动方式, 逻辑型, , 获取 HTTP 启动方式
.参数 hAgent, 整数型, ,
.子程序 获取HTTP状态码, 短整数, , 获取 HTTP 状态码
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 获取本地协议版本, 整数型, , GetLocalVersion
.参数 hAgent, 整数型, ,
.子程序 获取传输编码, 文本型, , GetTransferEncoding
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 获取当前WebSocket消息状态, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 获取地址重用选项, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hAgent, 整数型, ,
.子程序 获取解析错误代码, 短整数, , GetParseErrorCode
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接数, 整数型, , GetConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接时长, 逻辑型, , GetConnectPeriod(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个请求头_单值, 文本型, , 获取某个请求头(单值)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取某个请求头_多值, 逻辑型, , 获取某个请求头(多值)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hAgent, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hAgent, 整数型, ,
.子程序 获取内容编码, 文本型, , GetContentEncoding
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 获取内容类型, 文本型, , GetContentType
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 获取内容长度, 长整数型, , GetContentLength
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hAgent, 整数型, ,
.子程序 获取所有Cookie, 逻辑型, , 获取所有 Cookie
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取所有请求头名称, 逻辑型, , GetAllHeaderNames
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hAgent, 整数型, ,
.子程序 获取协议版本, 短整数, , GetVersion
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 获取协议升级类型, 整数型, , GetUpgradeType
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hAgent, 整数型, ,
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hAgent, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查是否升级协议, 逻辑型, , IsUpgrade
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 检查是否使用Cookie, 逻辑型, , 检查是否使用 Cookie
.参数 hAgent, 整数型, ,
.子程序 检查是否有Keep_Alive标识, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hAgent, 整数型, ,
.子程序 连接服务器, 逻辑型, , 名称:Connect 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 启动HTTP通信当通信组件设置为非自动启动HTTP通信时, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接ID
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 清理通信组件SSL运行环境, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 取得所有HTTP返回协议头, 逻辑型, , GetAllHeaders
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 设置HTTP启动方式, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hAgent, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置本地协议版本, , , SetLocalVersion
.参数 hAgent, 整数型, ,
.参数 usVersion, 整数型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置是否使用Cookie, , , 设置是否使用 Cookie
.参数 hAgent, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 销毁HP_HttpAgent或HP_HttpsAgent对象, , , 销毁 HP_HttpAgent 或 HP_HttpsAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HttpAgentListener对象, , , 销毁 HttpAgentListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IHttpClient, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_HttpClient 或 HP_HttpsClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 HttpClientListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_HttpClient 或 HP_HttpsClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 HttpClientListener 对象
.子程序 GetAllCookies, 逻辑型, , 获取所有 Cookie
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetAllHeaderNames, 逻辑型, , 获取所有请求头名称
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 GetAllHeaders, 逻辑型, , 取得所有HTTP返回协议头
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetContentEncoding, 文本型, , 获取内容编码
.参数 hClient, 整数型, ,
.子程序 GetContentLength, 长整数型, , 获取内容长度
.参数 hClient, 整数型, ,
.子程序 GetContentType, 文本型, , 获取内容类型
.参数 hClient, 整数型, ,
.子程序 GetCookie, 文本型, , 获取 Cookie
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetHeader, 文本型, , 获取某个请求头(单值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetHeaders, 逻辑型, , 获取某个请求头(多值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalVersion, 整数型, , 获取本地协议版本
.参数 hClient, 整数型, ,
.子程序 GetParseErrorCode, 短整数, , 获取解析错误代码
.参数 hClient, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetStatusCode, 短整数, , 获取 HTTP 状态码
.参数 hClient, 整数型, ,
.子程序 GetTransferEncoding, 文本型, , 获取传输编码
.参数 hClient, 整数型, ,
.子程序 GetUpgradeType, 整数型, , 获取协议升级类型
.参数 hClient, 整数型, ,
.子程序 GetVersion, 短整数, , 获取协议版本
.参数 hClient, 整数型, ,
.子程序 GetWSMessageState, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hClient, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsHttpAutoStart, 逻辑型, , 获取 HTTP 启动方式
.参数 hClient, 整数型, ,
.子程序 IsKeepAlive, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 IsUpgrade, 逻辑型, , 检查是否升级协议
.参数 hClient, 整数型, ,
.子程序 IsUseCookie, 逻辑型, , 检查是否使用 Cookie
.参数 hClient, 整数型, ,
.子程序 OnBody, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnChunkComplete, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnChunkHeader, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHeader, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 OnHeadersComplete, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageBegin, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageComplete, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnParseError, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnStatusLine, 逻辑型, , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,dwConnID 整数,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 OnUpgrade, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 OnWSMessageBody, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnWSMessageComplete, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnWSMessageHeader, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendChunkData, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 hClient, 整数型, ,
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 SendConnect, 逻辑型, , 发送 Connect 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendDelete, 逻辑型, , 发送 DELETE 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendGet, 逻辑型, , 发送 GET 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendHead, 逻辑型, , 发送 Head 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendLocalFile, 逻辑型, , 名称:发送本地文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.子程序 SendOptions, 逻辑型, , 发送 Options 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendPatch, 逻辑型, , 发送 PATCH 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendPost, 逻辑型, , 发送 POST 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendPut, 逻辑型, , 发送 PUT 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendRequest, 逻辑型, , 名称:发送请求 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.参数 pData, 字节集, 可空 ,
.子程序 SendTrace, 逻辑型, , 发送 Trace 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendWSMessage, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, 可空 , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetHttpAutoStart, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hClient, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 SetLocalVersion, , , 设置本地协议版本
.参数 hClient, 整数型, ,
.参数 usVersion, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 SetUseCookie, , , 设置是否使用 Cookie
.参数 hClient, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartHttp, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_Chunked报文头事件, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 绑定_Chunked报文完成事件, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_WebSocket数据包体事件, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_WebSocket数据包头事件, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 绑定_WebSocket数据包完成事件, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_解析错误事件, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 绑定_开始解析事件, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_请求体报文事件, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_请求头事件, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 绑定_请求头完成事件, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_升级协议事件, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_完成解析事件, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_状态行解析完成事件, 逻辑型, , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,dwConnID 整数,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_HttpClient或HP_HttpsClient对象, 整数型, , 创建 HP_HttpClient 或 HP_HttpsClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HttpClientListener对象, 整数型, , 创建 HttpClientListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送Chunked数据分片, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 hClient, 整数型, ,
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 发送Connect请求, 逻辑型, , 发送 Connect 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送DELETE请求, 逻辑型, , 发送 DELETE 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送GET请求, 逻辑型, , 发送 GET 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送Head请求, 逻辑型, , 发送 Head 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送Options请求, 逻辑型, , 发送 Options 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送PATCH请求, 逻辑型, , 发送 PATCH 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送POST请求, 逻辑型, , 发送 POST 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送PUT请求, 逻辑型, , 发送 PUT 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送Trace请求, 逻辑型, , 发送 Trace 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送WebSocket消息, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, 可空 , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 发送本地文件, 逻辑型, , 名称:SendLocalFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送请求, 逻辑型, , 名称:SendRequest 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.参数 pData, 字节集, 可空 ,
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取Cookie, 文本型, , 获取 Cookie
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取HTTP启动方式, 逻辑型, , 获取 HTTP 启动方式
.参数 hClient, 整数型, ,
.子程序 获取HTTP状态码, 短整数, , 获取 HTTP 状态码
.参数 hClient, 整数型, ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取本地协议版本, 整数型, , GetLocalVersion
.参数 hClient, 整数型, ,
.子程序 获取传输编码, 文本型, , GetTransferEncoding
.参数 hClient, 整数型, ,
.子程序 获取当前WebSocket消息状态, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hClient, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取解析错误代码, 短整数, , GetParseErrorCode
.参数 hClient, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个请求头_单值, 文本型, , 获取某个请求头(单值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取某个请求头_多值, 逻辑型, , 获取某个请求头(多值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取内容编码, 文本型, , GetContentEncoding
.参数 hClient, 整数型, ,
.子程序 获取内容类型, 文本型, , GetContentType
.参数 hClient, 整数型, ,
.子程序 获取内容长度, 长整数型, , GetContentLength
.参数 hClient, 整数型, ,
.子程序 获取所有Cookie, 逻辑型, , 获取所有 Cookie
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 获取所有请求头名称, 逻辑型, , GetAllHeaderNames
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取协议版本, 短整数, , GetVersion
.参数 hClient, 整数型, ,
.子程序 获取协议升级类型, 整数型, , GetUpgradeType
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查是否升级协议, 逻辑型, , IsUpgrade
.参数 hClient, 整数型, ,
.子程序 检查是否使用Cookie, 逻辑型, , 检查是否使用 Cookie
.参数 hClient, 整数型, ,
.子程序 检查是否有Keep_Alive标识, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动HTTP通信当通信组件设置为非自动启动HTTP通信时, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 取得所有HTTP返回协议头, 逻辑型, , GetAllHeaders
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 设置HTTP启动方式, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hClient, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置本地协议版本, , , SetLocalVersion
.参数 hClient, 整数型, ,
.参数 usVersion, 整数型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置是否使用Cookie, , , 设置是否使用 Cookie
.参数 hClient, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 销毁HP_HttpClient或HP_HttpsClient对象, , , 销毁 HP_HttpClient 或 HP_HttpsClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HttpClientListener对象, , , 销毁 HttpClientListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IHttpCookie, , 公开
.子程序 Cookieexpires字符串转换为整数, 逻辑型, , Cookie expires 字符串转换为整数
.参数 lpszExpires, 文本型, , expires 字符串
.参数 ptmExpires, 长整数型, 参考 , expires 整数
.子程序 HLP_CurrentUTCTime, 长整数型, , 获取当前 UTC 时间
.子程序 HLP_ExpiresToMaxAge, 整数型, , Max-Age -> expires
.参数 tmExpires, 长整数型, ,
.子程序 HLP_MakeExpiresStr, 逻辑型, , 整数转换为 Cookie expires 字符串
.参数 tmExpires, 长整数型, , expires 整数
.参数 lpszExpires, 文本型, 参考 , 字符串缓冲区
.子程序 HLP_MaxAgeToExpires, 长整数型, , Max-Age -> expires
.参数 iMaxAge, 整数型, , 生命周期: > 0 –> 存活秒数; = 0 –> 立刻删除, < 0 –> 到应用程序结束
.子程序 HLP_ParseExpires, 逻辑型, , Cookie expires 字符串转换为整数
.参数 lpszExpires, 文本型, , expires 字符串
.参数 ptmExpires, 长整数型, 参考 , expires 整数
.子程序 HLP_ToString, 逻辑型, , 生成 Cookie 字符串
.参数 lpszBuff, 文本型, 参考 , 字符串缓冲区
.参数 lpszName, 文本型, , 名称
.参数 lpszValue, 文本型, , 值
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.参数 iMaxAge, 整数型, , 生命周期: > 0 –> 存活秒数; = 0 –> 立刻删除, < 0 –> 到应用程序结束
.参数 bHttpOnly, 逻辑型, , 是否有 HttpOnly 属性
.参数 bSecure, 逻辑型, , 是否有 secure 属性
.参数 enSameSite, 整数型, , SameSite 属性: 0 –> 无; 1 –> Strict; 2 –> LA
.子程序 MGR_ClearCookies, 逻辑型, , 清理 Cookie
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.子程序 MGR_DeleteCookie, 逻辑型, , 删除 Cookie
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.参数 lpszName, 文本型, , 名称
.子程序 MGR_IsEnableThirdPartyCookie, 逻辑型, , 检查是否允许第三方 Cookie
.子程序 MGR_LoadFromFile, 逻辑型, , 从文件加载 Cookie
.参数 lpszFile, 文本型, ,
.参数 bKeepExists, 逻辑型, , 保持存在
.子程序 MGR_RemoveExpiredCookies, 逻辑型, , 清理过期 Cookie
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.子程序 MGR_SaveToFile, 逻辑型, , 保存 Cookie 到文件
.参数 lpszFile, 文本型, ,
.参数 bKeepExists, 逻辑型, , 保持存在
.子程序 MGR_SetCookie, 逻辑型, , 设置 Cookie
.参数 lpszName, 文本型, , 名称
.参数 lpszValue, 文本型, , 值
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.参数 iMaxAge, 整数型, , 生命周期: > 0 –> 存活秒数; = 0 –> 立刻删除, < 0 –> 到应用程序结束
.参数 bHttpOnly, 逻辑型, , 是否有 HttpOnly 属性
.参数 bSecure, 逻辑型, , 是否有 secure 属性
.参数 enSameSite, 整数型, , SameSite 属性: 0 –> 无; 1 –> Strict; 2 –> LAX
.参数 bOnlyUpdateValueIfExists, 逻辑型, , 如果 Cookie 已存在是否只更新 Cookie 值
.子程序 MGR_SetEnableThirdPartyCookie, , , 设置是否允许第三方 Cookie
.参数 bEnableThirdPartyCookie, 逻辑型, ,
.子程序 保存Cookie到文件, 逻辑型, , 保存 Cookie 到文件
.参数 lpszFile, 文本型, ,
.参数 bKeepExists, 逻辑型, , 保持存在
.子程序 从文件加载Cookie, 逻辑型, , 从文件加载 Cookie
.参数 lpszFile, 文本型, ,
.参数 bKeepExists, 逻辑型, , 保持存在
.子程序 获取当前UTC时间, 长整数型, , 获取当前 UTC 时间
.子程序 检查是否允许第三方Cookie, 逻辑型, , 检查是否允许第三方 Cookie
.子程序 清理Cookie, 逻辑型, , 清理 Cookie
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.子程序 清理过期Cookie, 逻辑型, , 清理过期 Cookie
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.子程序 删除Cookie, 逻辑型, , 删除 Cookie
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.参数 lpszName, 文本型, , 名称
.子程序 设置Cookie, 逻辑型, , 设置 Cookie
.参数 lpszName, 文本型, , 名称
.参数 lpszValue, 文本型, , 值
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.参数 iMaxAge, 整数型, , 生命周期: > 0 –> 存活秒数; = 0 –> 立刻删除, < 0 –> 到应用程序结束
.参数 bHttpOnly, 逻辑型, , 是否有 HttpOnly 属性
.参数 bSecure, 逻辑型, , 是否有 secure 属性
.参数 enSameSite, 整数型, , SameSite 属性: 0 –> 无; 1 –> Strict; 2 –> LAX
.参数 bOnlyUpdateValueIfExists, 逻辑型, , 如果 Cookie 已存在是否只更新 Cookie 值
.子程序 设置是否允许第三方Cookie, , , 设置是否允许第三方 Cookie
.参数 bEnableThirdPartyCookie, 逻辑型, ,
.子程序 生成Cookie字符串, 逻辑型, , 生成 Cookie 字符串
.参数 lpszBuff, 文本型, 参考 , 字符串缓冲区
.参数 lpszName, 文本型, , 名称
.参数 lpszValue, 文本型, , 值
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.参数 iMaxAge, 整数型, , 生命周期: > 0 –> 存活秒数; = 0 –> 立刻删除, < 0 –> 到应用程序结束
.参数 bHttpOnly, 逻辑型, , 是否有 HttpOnly 属性
.参数 bSecure, 逻辑型, , 是否有 secure 属性
.参数 enSameSite, 整数型, , SameSite 属性: 0 –> 无; 1 –> Strict; 2 –> LA
.子程序 整数转换为Cookieexpires字符串, 逻辑型, , 整数转换为 Cookie expires 字符串
.参数 tmExpires, 长整数型, , expires 整数
.参数 lpszExpires, 文本型, 参考 , 字符串缓冲区
.程序集 IHttpServer, , 公开
.子程序 AddSSLContext, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 AddSSLContextByMemory, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 api_no, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 api_ok, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 BindSSLServerName, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 Create, 整数型, , 创建 HP_HttpServer 或 HP_HttpsServer 对象,并创建 HttpServerListener 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 HttpServerListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_HttpServer 或 HP_HttpsServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 HttpServerListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetAllCookies, 逻辑型, , 获取所有 Cookie
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetAllHeaderNames, 逻辑型, , 获取所有请求头名称
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 GetAllHeaders, 逻辑型, , 取得所有HTTP返回协议头
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetConnectionCount, 整数型, , 获取客户端连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个客户端连接时长(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetContentEncoding, 文本型, , 获取内容编码
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetContentLength, 长整数型, , 获取内容长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetContentType, 文本型, , 获取内容类型
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetCookie, 文本型, , 获取 Cookie
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetHeader, 文本型, , 获取某个请求头(单值)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetHeaders, 逻辑型, , 获取某个请求头(多值)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 GetHost, 文本型, , 获取主机
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hServer, 整数型, , 服务句柄
.子程序 GetListenAddress, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalVersion, 整数型, , 获取本地协议版本
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMethod, 文本型, , 获取请求方法
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetParseErrorCode, 短整数, , 获取解析错误代码
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetReleaseDelay, 整数型, , 获取连接释放延时
.参数 hServer, 整数型, , 服务句柄
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetTransferEncoding, 文本型, , 获取传输编码
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetUpgradeType, 整数型, , 获取协议升级类型
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetUrlField, 文本型, , 获取某个 URL 域值
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 enField, 整数型, ,
.子程序 GetUrlFieldSet, 短整数, , 获取请求行 URL 域掩码(URL 域参考:EnHttpUrlField)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetVersion, 短整数, , 获取协议版本
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetWSMessageState, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hServer, 整数型, , 服务句柄
.子程序 http重定向, 逻辑型, , 支持301 302 303 307
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 状态码, 字节型, , 不写30 支持30开头 301(字节49)永久跳转 302临时跳转 303对于POST请求,它表示请求已经被处理 307(字节55)Temporary Redirect,对于POST请求,表示请求还没有被处理,客户端应该跳转后重新发起POST请求
.参数 跳转地址, 字节集, , 需要自行添加http://
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsHttpAutoStart, 逻辑型, , 获取 HTTP 启动方式
.参数 hServer, 整数型, ,
.子程序 IsKeepAlive, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hServer, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hServer, 整数型, ,
.子程序 IsUpgrade, 逻辑型, , 检查是否升级协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 OnAccept, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnAccept, 逻辑型, , 【必须】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnBody, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnChunkComplete, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnChunkHeader, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHeader, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 OnHeadersComplete, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageBegin, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageComplete, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnParseError, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnRequestLine, 逻辑型, , 【可选】绑定请求行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnRequestLine(pSender 整数型,dwConnID 整数型,lpszMethod 文本型,lpszUrl 文本型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 OnUpgrade, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 OnWSMessageBody, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnWSMessageComplete, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnWSMessageHeader, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Release, 逻辑型, , 名称:释放连接 描述:把连接放入释放队列,等待某个时间(通过 SetReleaseDelay() 设置)关闭连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendChunkData, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 SendLocalFile, 逻辑型, , 名称:发送本地文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, 可空 , HTTP 状态描述
.参数 lpHeaders, TNVPair, 可空 数组, 回复请求头
.子程序 SendLocalFileEx, 逻辑型, , 名称:发送本地文件 描述:向指定连接发送 理论最大0xFFFFFFFFFFFFFFFF 大小的文件,请不要在组件任意事件中使用本方法,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, 可空 , HTTP 状态描述
.参数 lpHeaders, TNVPair, 参考 可空 数组, 回复请求头,请不要加 Content-Length 这个头
.参数 bforceEx, 逻辑型, 可空 , 强制走大文件
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendResponse, 逻辑型, , 名称:回复请求 描述:向客户端回复 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, 可空 , HTTP 状态描述,空为默认
.参数 lpHeaders, TNVPair, 参考 可空 数组, 回复请求头
.参数 pData, 字节集, 可空 , 回复请求体
.子程序 SendWSMessage, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetHttpAutoStart, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hServer, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 SetLocalVersion, , , 设置本地协议版本
.参数 hServer, 整数型, , 服务句柄
.参数 usVersion, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetReleaseDelay, , , 设置连接释放延时(默认:3000 毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwReleaseDelay, 整数型, ,
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 StartHttp, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接ID
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_Chunked报文头事件, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 绑定_Chunked报文完成事件, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_WebSocket数据包体事件, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_WebSocket数据包头事件, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 绑定_WebSocket数据包完成事件, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_监听事件, 逻辑型, , 【可选】绑定监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【必须】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_解析错误事件, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 绑定_开始解析事件, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 绑定_请求体报文事件, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_请求头事件, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 绑定_请求头完成事件, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_请求行解析完成事件, 逻辑型, , 【可选】绑定请求行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnRequestLine(pSender 整数型,dwConnID 整数型,lpszMethod 文本型,lpszUrl 文本型)
.子程序 绑定_升级协议事件, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_完成解析事件, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定SNI主机域名, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 创建HP_HttpServer或HP_HttpsServer对象, 整数型, , 创建 HP_HttpServer 或 HP_HttpsServer 对象,并创建 HttpServerListener 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HttpServerListener对象, 整数型, , 创建 HttpServerListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送Chunked数据分片, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 发送WebSocket消息, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 发送本地文件, 逻辑型, , 名称:SendLocalFileEx 描述:向指定连接发送 理论最大0xFFFFFFFFFFFFFFFF 大小的文件,请不要在组件任意事件中使用本方法,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, 可空 , HTTP 状态描述
.参数 lpHeaders, TNVPair, 参考 可空 数组, 回复请求头,请不要加 Content-Length 这个头
.参数 bforceEx, 逻辑型, 可空 , 强制走大文件
.子程序 发送本地文件4096, 逻辑型, , 名称:SendLocalFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, 可空 , HTTP 状态描述
.参数 lpHeaders, TNVPair, 可空 数组, 回复请求头
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 回复请求, 逻辑型, , 名称:SendResponse 描述:向客户端回复 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, 可空 , HTTP 状态描述,空为默认
.参数 lpHeaders, TNVPair, 参考 可空 数组, 回复请求头
.参数 pData, 字节集, 可空 , 回复请求体
.子程序 获取Cookie, 文本型, , 获取 Cookie
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取HTTP启动方式, 逻辑型, , 获取 HTTP 启动方式
.参数 hServer, 整数型, ,
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 获取本地协议版本, 整数型, , GetLocalVersion
.参数 hServer, 整数型, , 服务句柄
.子程序 获取传输编码, 文本型, , GetTransferEncoding
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取当前WebSocket消息状态, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取监听Socket的地址信息, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取解析错误代码, 短整数, , GetParseErrorCode
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 获取客户端连接数, 整数型, , GetConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接释放延时, 整数型, , GetReleaseDelay
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个URL域值, 文本型, , 获取某个 URL 域值
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 enField, 整数型, ,
.子程序 获取某个客户端连接时长, 逻辑型, , GetConnectPeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个请求头_单值, 文本型, , 获取某个请求头(单值)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取某个请求头_多值, 逻辑型, , 获取某个请求头(多值)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内容编码, 文本型, , GetContentEncoding
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取内容类型, 文本型, , GetContentType
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取内容长度, 长整数型, , GetContentLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取请求方法, 文本型, , GetMethod
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取请求行URL域掩码, 短整数, , 获取请求行 URL 域掩码(URL 域参考:EnHttpUrlField)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.子程序 获取所有Cookie, 逻辑型, , 获取所有 Cookie
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取所有请求头名称, 逻辑型, , GetAllHeaderNames
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hServer, 整数型, ,
.子程序 获取协议版本, 短整数, , GetVersion
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取协议升级类型, 整数型, , GetUpgradeType
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取主机, 文本型, , GetHost
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查是否升级协议, 逻辑型, , IsUpgrade
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 检查是否有Keep_Alive标识, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hServer, 整数型, , 服务句柄
.子程序 启动HTTP通信当通信组件设置为非自动启动HTTP通信时, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接ID
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 取得所有HTTP返回协议头, 逻辑型, , GetAllHeaders
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 设置HTTP启动方式, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hServer, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置本地协议版本, , , SetLocalVersion
.参数 hServer, 整数型, , 服务句柄
.参数 usVersion, 整数型, ,
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置连接释放延时, , , SetReleaseDelay(默认:3000 毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwReleaseDelay, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 释放连接, 逻辑型, , 名称:Release 描述:把连接放入释放队列,等待某个时间(通过 SetReleaseDelay() 设置)关闭连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 销毁HP_HttpServer或HP_HttpsServer对象, , , 销毁 HP_HttpServer 或 HP_HttpsServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HttpServerListener对象, , , 销毁 HttpServerListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 增加SNI主机证书, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 增加SNI主机证书Ex, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.程序集 IHttpSyncClient, , 公开
.子程序 CleanupRequestResult, 逻辑型, , 名称:清除请求结果 描述:清除上一次请求的响应头和响应体等结果信息(该方法会在每次发送请求前自动调用),TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_HttpClient 或 HP_HttpsClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Create, 整数型, , 创建 HP_HttpClient 或 HP_HttpsClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 HttpClientListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 HttpClientListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_HttpClient 或 HP_HttpsClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Destroy, , , 销毁 HP_HttpClient 或 HP_HttpsClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 HttpClientListener 对象
.子程序 DestroyListener, , , 销毁 HttpClientListener 对象
.子程序 GetAllCookies, 逻辑型, , 获取所有 Cookie
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetAllHeaderNames, 逻辑型, , 获取所有请求头名称
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 GetAllHeaders, 逻辑型, , 取得所有HTTP返回协议头
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetConnectTimeout, 整数型, , 获取连接超时
.参数 hClient, 整数型, ,
.子程序 GetContentEncoding, 文本型, , 获取内容编码
.参数 hClient, 整数型, ,
.子程序 GetContentLength, 长整数型, , 获取内容长度
.参数 hClient, 整数型, ,
.子程序 GetContentType, 文本型, , 获取内容类型
.参数 hClient, 整数型, ,
.子程序 GetCookie, 文本型, , 获取 Cookie
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetHeader, 文本型, , 获取某个请求头(单值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 GetHeaders, 逻辑型, , 获取某个请求头(多值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalVersion, 整数型, , 获取本地协议版本
.参数 hClient, 整数型, ,
.子程序 GetParseErrorCode, 短整数, , 获取解析错误代码
.参数 hClient, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetRequestTimeout, 整数型, , 获取请求超时
.参数 hClient, 整数型, ,
.子程序 GetResponseBody, 字节集, , 获取响应体
.参数 hClient, 整数型, ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetStatusCode, 短整数, , 获取 HTTP 状态码
.参数 hClient, 整数型, ,
.子程序 GetTransferEncoding, 文本型, , 获取传输编码
.参数 hClient, 整数型, ,
.子程序 GetUpgradeType, 整数型, , 获取协议升级类型
.参数 hClient, 整数型, ,
.子程序 GetVersion, 短整数, , 获取协议版本
.参数 hClient, 整数型, ,
.子程序 GetWSMessageState, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hClient, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsHttpAutoStart, 逻辑型, , 获取 HTTP 启动方式
.参数 hClient, 整数型, ,
.子程序 IsKeepAlive, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 IsUpgrade, 逻辑型, , 检查是否升级协议
.参数 hClient, 整数型, ,
.子程序 IsUseCookie, 逻辑型, , 检查是否使用 Cookie
.参数 hClient, 整数型, ,
.子程序 OnBody, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnChunkComplete, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnChunkHeader, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHeader, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 OnHeadersComplete, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageBegin, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageComplete, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnParseError, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnStatusLine, 逻辑型, , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,dwConnID 整数,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 OnUpgrade, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 OnWSMessageBody, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnWSMessageComplete, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnWSMessageHeader, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 OpenUrl, 逻辑型, , 名称:发送 URL 请求 描述:向服务端发送 HTTP URL 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszUrl, 文本型, , 请求 URL
.参数 lpHeaders, TNVPair, 数组, 请求头
.参数 pBody, 字节集, , 请求体
.参数 bForceReconnect, 逻辑型, 可空 , 强制重新连接(默认:FALSE,当请求 URL 的主机和端口与现有连接一致时,重用现有连接)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendChunkData, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 hClient, 整数型, ,
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 SendConnect, 逻辑型, , 发送 Connect 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendDelete, 逻辑型, , 发送 DELETE 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendGet, 逻辑型, , 发送 GET 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendHead, 逻辑型, , 发送 Head 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendLocalFile, 逻辑型, , 名称:发送本地文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.子程序 SendOptions, 逻辑型, , 发送 Options 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendPatch, 逻辑型, , 发送 PATCH 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendPost, 逻辑型, , 发送 POST 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendPut, 逻辑型, , 发送 PUT 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 SendRequest, 逻辑型, , 名称:发送请求 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.参数 pData, 字节集, 可空 ,
.子程序 SendTrace, 逻辑型, , 发送 Trace 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 SendWSMessage, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, 可空 , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 SetConnectTimeout, , , 设置连接超时(毫秒,0:系统默认超时,默认:5000)
.参数 hClient, 整数型, ,
.参数 dwConnectTimeout, 整数型, ,
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetHttpAutoStart, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hClient, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 SetLocalVersion, , , 设置本地协议版本
.参数 hClient, 整数型, ,
.参数 usVersion, 整数型, ,
.子程序 SetRequestTimeout, , , 设置请求超时(毫秒,0:无限等待,默认:10000)
.参数 hClient, 整数型, ,
.参数 dwRequestTimeout, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 SetUseCookie, , , 设置是否使用 Cookie
.参数 hClient, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartHttp, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_Chunked报文头事件, 逻辑型, , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 绑定_Chunked报文完成事件, 逻辑型, , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_WebSocket数据包体事件, 逻辑型, , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_WebSocket数据包头事件, 逻辑型, , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 绑定_WebSocket数据包完成事件, 逻辑型, , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_解析错误事件, 逻辑型, , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 绑定_开始解析事件, 逻辑型, , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_请求体报文事件, 逻辑型, , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_请求头事件, 逻辑型, , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 绑定_请求头完成事件, 逻辑型, , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_升级协议事件, 逻辑型, , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_完成解析事件, 逻辑型, , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_状态行解析完成事件, 逻辑型, , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,dwConnID 整数,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_HttpClient或HP_HttpsClient对象, 整数型, , 创建 HP_HttpClient 或 HP_HttpsClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HP_HttpClient或HP_HttpsClient对象, 整数型, , 创建 HP_HttpClient 或 HP_HttpsClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HttpClientListener对象, 整数型, , 创建 HttpClientListener 对象,只会创建一次
.子程序 创建HttpClientListener对象, 整数型, , 创建 HttpClientListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送Chunked数据分片, 逻辑型, , 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 hClient, 整数型, ,
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, 可空 , 扩展属性(默认:nullptr)
.子程序 发送Connect请求, 逻辑型, , 发送 Connect 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送DELETE请求, 逻辑型, , 发送 DELETE 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送GET请求, 逻辑型, , 发送 GET 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送Head请求, 逻辑型, , 发送 Head 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送Options请求, 逻辑型, , 发送 Options 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送PATCH请求, 逻辑型, , 发送 PATCH 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送POST请求, 逻辑型, , 发送 POST 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送PUT请求, 逻辑型, , 发送 PUT 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.参数 pBody, 字节集, ,
.子程序 发送Trace请求, 逻辑型, , 发送 Trace 请求
.参数 hClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 发送URL请求, 逻辑型, , 名称:发送 URL 请求 描述:向服务端发送 HTTP URL 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszUrl, 文本型, , 请求 URL
.参数 lpHeaders, TNVPair, 数组, 请求头
.参数 pBody, 字节集, , 请求体
.参数 bForceReconnect, 逻辑型, 可空 , 强制重新连接(默认:FALSE,当请求 URL 的主机和端口与现有连接一致时,重用现有连接)
.子程序 发送WebSocket消息, 逻辑型, , 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, 可空 , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, 可空 , 消息体数据缓冲区
.参数 ullBodyLen, 长整数型, 可空 , 消息总长度
.子程序 发送本地文件, 逻辑型, , 名称:SendLocalFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送请求, 逻辑型, , 名称:SendRequest 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 参考 可空 数组, 请求头
.参数 pData, 字节集, 可空 ,
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取Cookie, 文本型, , 获取 Cookie
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取HTTP启动方式, 逻辑型, , 获取 HTTP 启动方式
.参数 hClient, 整数型, ,
.子程序 获取HTTP状态码, 短整数, , 获取 HTTP 状态码
.参数 hClient, 整数型, ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取本地协议版本, 整数型, , GetLocalVersion
.参数 hClient, 整数型, ,
.子程序 获取传输编码, 文本型, , GetTransferEncoding
.参数 hClient, 整数型, ,
.子程序 获取当前WebSocket消息状态, 逻辑型, , 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 hClient, 整数型, ,
.参数 lpbFinal, 逻辑型, 参考 可空 ,
.参数 lpiReserved, 字节型, 参考 可空 ,
.参数 lpiOperationCode, 字节型, 参考 可空 ,
.参数 lpszMask, 整数型, 参考 可空 , 指针到字节集,length=4
.参数 lpullBodyLen, 长整数型, 参考 可空 ,
.参数 lpullBodyRemain, 长整数型, 参考 可空 ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取解析错误代码, 短整数, , GetParseErrorCode
.参数 hClient, 整数型, ,
.参数 lpszErrorDesc, 整数型, 参考 ,
.子程序 获取连接超时, 整数型, , GetConnectTimeout
.参数 hClient, 整数型, ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个请求头_单值, 文本型, , 获取某个请求头(单值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.子程序 获取某个请求头_多值, 逻辑型, , 获取某个请求头(多值)
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 参考 数组,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取内容编码, 文本型, , GetContentEncoding
.参数 hClient, 整数型, ,
.子程序 获取内容类型, 文本型, , GetContentType
.参数 hClient, 整数型, ,
.子程序 获取内容长度, 长整数型, , GetContentLength
.参数 hClient, 整数型, ,
.子程序 获取请求超时, 整数型, , GetRequestTimeout
.参数 hClient, 整数型, ,
.子程序 获取所有Cookie, 逻辑型, , 获取所有 Cookie
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 获取所有请求头名称, 逻辑型, , GetAllHeaderNames
.参数 hClient, 整数型, ,
.参数 lpszName, 文本型, 参考 数组,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取响应体, 字节集, , GetResponseBody
.参数 hClient, 整数型, ,
.子程序 获取协议版本, 短整数, , GetVersion
.参数 hClient, 整数型, ,
.子程序 获取协议升级类型, 整数型, , GetUpgradeType
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查是否升级协议, 逻辑型, , IsUpgrade
.参数 hClient, 整数型, ,
.子程序 检查是否使用Cookie, 逻辑型, , 检查是否使用 Cookie
.参数 hClient, 整数型, ,
.子程序 检查是否有Keep_Alive标识, 逻辑型, , 检查是否有 Keep-Alive 标识
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动HTTP通信当通信组件设置为非自动启动HTTP通信时, 逻辑型, , 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清除请求结果, 逻辑型, , 名称:CleanupRequestResult 描述:清除上一次请求的响应头和响应体等结果信息(该方法会在每次发送请求前自动调用),TRUE-- 成功,FALSE-- 失败,/
.参数 hClient, 整数型, ,
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 取得所有HTTP返回协议头, 逻辑型, , GetAllHeaders
.参数 hClient, 整数型, ,
.参数 lpHeaders, TNVPair, 参考 数组,
.子程序 设置HTTP启动方式, , , 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 hClient, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置本地协议版本, , , SetLocalVersion
.参数 hClient, 整数型, ,
.参数 usVersion, 整数型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置连接超时, , , SetConnectTimeout(毫秒,0:系统默认超时,默认:5000)
.参数 hClient, 整数型, ,
.参数 dwConnectTimeout, 整数型, ,
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置请求超时, , , SetRequestTimeout(毫秒,0:无限等待,默认:10000)
.参数 hClient, 整数型, ,
.参数 dwRequestTimeout, 整数型, ,
.子程序 设置是否使用Cookie, , , 设置是否使用 Cookie
.参数 hClient, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 销毁HP_HttpClient或HP_HttpsClient对象, , , 销毁 HP_HttpClient 或 HP_HttpsClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HP_HttpClient或HP_HttpsClient对象, , , 销毁 HP_HttpClient 或 HP_HttpsClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HttpClientListener对象, , , 销毁 HttpClientListener 对象
.子程序 销毁HttpClientListener对象, , , 销毁 HttpClientListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IServer, , 公开
.子程序 AddSSLContext, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 AddSSLContextByMemory, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 api_no, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 api_ok, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 BindSSLServerName, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取客户端连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个客户端连接时长(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hServer, 整数型, , 服务句柄
.子程序 GetListenAddress, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hServer, 整数型, , 服务句柄
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hServer, 整数型, , 服务句柄
.子程序 http重定向, 逻辑型, , 支持301 302 303 307
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 状态码, 字节型, , 不写30 支持30开头 301(字节49)永久跳转 302临时跳转 303对于POST请求,它表示请求已经被处理 307(字节55)Temporary Redirect,对于POST请求,表示请求还没有被处理,客户端应该跳转后重新发起POST请求
.参数 跳转地址, 字节集, , 需要自行添加http://
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hServer, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hServer, 整数型, ,
.子程序 OnAccept, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定SNI主机域名, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取监听Socket的地址信息, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取客户端连接数, 整数型, , GetConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个客户端连接时长, 逻辑型, , GetConnectPeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hServer, 整数型, ,
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hServer, 整数型, , 服务句柄
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 增加SNI主机证书, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 增加SNI主机证书Ex, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.程序集 ITcpAgent, , 公开
.子程序 CleanupSSLContext, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 Connect, 逻辑型, , 名称:连接服务器 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 Create, 整数型, , 创建 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpAgentListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 释放 TcpAgentListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取连接数
.参数 hAgent, 整数型, ,
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个连接时长(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hAgent, 整数型, ,
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hAgent, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hAgent, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hAgent, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hAgent, 整数型, ,
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hAgent, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hAgent, 整数型, ,
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hAgent, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hAgent, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hAgent, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hAgent, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hAgent, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hAgent, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_TcpAgent或HP_SSLAgent对象, 整数型, , 创建 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpAgentListener对象, 整数型, , 创建 TcpAgentListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 获取地址重用选项, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hAgent, 整数型, ,
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接数, 整数型, , GetConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接时长, 逻辑型, , GetConnectPeriod(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hAgent, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hAgent, 整数型, ,
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hAgent, 整数型, ,
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hAgent, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hAgent, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hAgent, 整数型, ,
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hAgent, 整数型, ,
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hAgent, 整数型, ,
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hAgent, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hAgent, 整数型, ,
.子程序 连接服务器, 逻辑型, , 名称:Connect 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 清理通信组件SSL运行环境, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hAgent, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 释放TcpAgentListener对象, , , 释放 TcpAgentListener 对象
.子程序 销毁HP_TcpAgent或HP_SSLAgent对象, , , 销毁 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 ITcpClient, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_TcpClient 或 HP_SSLClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpClientListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpClient 或 HP_SSLClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 TcpClientListener 对象
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hClient, 整数型, ,
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hClient, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向服务端发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 hClient, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_TcpClient或HP_SSLClient对象, 整数型, , 创建 HP_TcpClient 或 HP_SSLClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpClientListener对象, 整数型, , 创建 TcpClientListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向服务端发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hClient, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hClient, 整数型, ,
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 hClient, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 销毁HP_TcpClient或HP_SSLClient对象, , , 销毁 HP_TcpClient 或 HP_SSLClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpClientListener对象, , , 销毁 TcpClientListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 ITcpPackAgent, , 公开
.子程序 CleanupSSLContext, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 Connect, 逻辑型, , 名称:连接服务器 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 Create, 整数型, , 创建 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Create, 整数型, , 创建 HP_TcpPackAgent 或 HP_SSLPackAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpAgentListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 TcpPackAgentListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Destroy, , , 销毁 HP_TcpPackAgent 或 HP_SSLPackAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 释放 TcpAgentListener 对象
.子程序 DestroyListener, , , 销毁 TcpPackAgentListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取连接数
.参数 hAgent, 整数型, ,
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个连接时长(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hAgent, 整数型, ,
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hAgent, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hAgent, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hAgent, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hAgent, 整数型, ,
.子程序 GetMaxPackSize, 整数型, , 获取数据包最大长度`
.参数 hAgent, 整数型, ,
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hAgent, 整数型, , 服务句柄
.子程序 GetPackHeaderFlag, 整数型, , 获取包头标识`
.参数 hAgent, 整数型, ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hAgent, 整数型, ,
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hAgent, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hAgent, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hAgent, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hAgent, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hAgent, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetMaxPackSize, , , 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 hAgent, 整数型, ,
.参数 dwMaxPackSize, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetPackHeaderFlag, , , 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 hAgent, 整数型, ,
.参数 usPackHeaderFlag, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hAgent, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_TcpAgent或HP_SSLAgent对象, 整数型, , 创建 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HP_TcpPackAgent或HP_SSLPackAgent对象, 整数型, , 创建 HP_TcpPackAgent 或 HP_SSLPackAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpAgentListener对象, 整数型, , 创建 TcpAgentListener 对象,只会创建一次
.子程序 创建TcpPackAgentListener对象, 整数型, , 创建 TcpPackAgentListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 获取包头标识, 整数型, , GetPackHeaderFlag`
.参数 hAgent, 整数型, ,
.子程序 获取地址重用选项, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hAgent, 整数型, ,
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接数, 整数型, , GetConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接时长, 逻辑型, , GetConnectPeriod(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hAgent, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hAgent, 整数型, ,
.子程序 获取数据包最大长度, 整数型, , GetMaxPackSize`
.参数 hAgent, 整数型, ,
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hAgent, 整数型, ,
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hAgent, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hAgent, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hAgent, 整数型, ,
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hAgent, 整数型, ,
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hAgent, 整数型, ,
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hAgent, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hAgent, 整数型, ,
.子程序 连接服务器, 逻辑型, , 名称:Connect 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 清理通信组件SSL运行环境, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置包头标识, , , SetPackHeaderFlag(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 hAgent, 整数型, ,
.参数 usPackHeaderFlag, 整数型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据包最大长度, , , SetMaxPackSize(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 hAgent, 整数型, ,
.参数 dwMaxPackSize, 整数型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hAgent, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 释放TcpAgentListener对象, , , 释放 TcpAgentListener 对象
.子程序 销毁HP_TcpAgent或HP_SSLAgent对象, , , 销毁 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HP_TcpPackAgent或HP_SSLPackAgent对象, , , 销毁 HP_TcpPackAgent 或 HP_SSLPackAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpPackAgentListener对象, , , 销毁 TcpPackAgentListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 ITcpPackClient, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_TcpClient 或 HP_SSLClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Create, 整数型, , 创建 HP_TcpPackClient 或 HP_SSLPackClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpClientListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 TcpPackClientListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpClient 或 HP_SSLClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Destroy, , , 销毁 HP_TcpPackClient 或 HP_SSLPackClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 TcpClientListener 对象
.子程序 DestroyListener, , , 销毁 TcpPackClientListener 对象
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hClient, 整数型, ,
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hClient, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxPackSize, 整数型, , 获取数据包最大长度`
.参数 hClient, 整数型, ,
.子程序 GetPackHeaderFlag, 整数型, , 获取包头标识`
.参数 hClient, 整数型, ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向服务端发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetMaxPackSize, , , 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 hClient, 整数型, ,
.参数 dwMaxPackSize, 整数型, ,
.子程序 SetPackHeaderFlag, , , 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 hClient, 整数型, ,
.参数 usPackHeaderFlag, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 hClient, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_TcpClient或HP_SSLClient对象, 整数型, , 创建 HP_TcpClient 或 HP_SSLClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HP_TcpPackClient或HP_SSLPackClient对象, 整数型, , 创建 HP_TcpPackClient 或 HP_SSLPackClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpClientListener对象, 整数型, , 创建 TcpClientListener 对象,只会创建一次
.子程序 创建TcpPackClientListener对象, 整数型, , 创建 TcpPackClientListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向服务端发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取包头标识, 整数型, , GetPackHeaderFlag`
.参数 hClient, 整数型, ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取数据包最大长度, 整数型, , GetMaxPackSize`
.参数 hClient, 整数型, ,
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hClient, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hClient, 整数型, ,
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置包头标识, , , SetPackHeaderFlag(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 hClient, 整数型, ,
.参数 usPackHeaderFlag, 整数型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置数据包最大长度, , , SetMaxPackSize(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 hClient, 整数型, ,
.参数 dwMaxPackSize, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 hClient, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 销毁HP_TcpClient或HP_SSLClient对象, , , 销毁 HP_TcpClient 或 HP_SSLClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HP_TcpPackClient或HP_SSLPackClient对象, , , 销毁 HP_TcpPackClient 或 HP_SSLPackClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpClientListener对象, , , 销毁 TcpClientListener 对象
.子程序 销毁TcpPackClientListener对象, , , 销毁 TcpPackClientListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 ITcpPackServer, , 公开
.子程序 AddSSLContext, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 AddSSLContextByMemory, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 api_no, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 api_ok, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 BindSSLServerName, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 Create, 整数型, , 创建 HP_TcpServer 或 HP_SSLServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Create, 整数型, , 创建 HP_TcpPackServer 或 HP_SSLPackServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpPackServerListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 TcpServerListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Destroy, , , 销毁 HP_TcpPackServer 或 HP_SSLPackServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 TcpPackServerListener 对象
.子程序 DestroyListener, , , 销毁 TcpServerListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAcceptSocketCount, 整数型, , 获取 Accept 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取客户端连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个客户端连接时长(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hServer, 整数型, , 服务句柄
.子程序 GetListenAddress, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMaxPackSize, 整数型, , 获取数据包最大长度`
.参数 hServer, 整数型, , 服务句柄
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetPackHeaderFlag, 整数型, , 获取包头标识`
.参数 hServer, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSocketListenQueue, 整数型, , 获取监听 Socket 的等候队列大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hServer, 整数型, , 服务句柄
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hServer, 整数型, , 服务句柄
.子程序 http重定向, 逻辑型, , 支持301 302 303 307
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 状态码, 字节型, , 不写30 支持30开头 301(字节49)永久跳转 302临时跳转 303对于POST请求,它表示请求已经被处理 307(字节55)Temporary Redirect,对于POST请求,表示请求还没有被处理,客户端应该跳转后重新发起POST请求
.参数 跳转地址, 字节集, , 需要自行添加http://
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hServer, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hServer, 整数型, ,
.子程序 OnAccept, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetAcceptSocketCount, , , 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多
.参数 hServer, 整数型, , 服务句柄
.参数 dwAcceptSocketCount, 整数型, ,
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetMaxPackSize, , , 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxPackSize, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetPackHeaderFlag, , , 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 hServer, 整数型, , 服务句柄
.参数 usPackHeaderFlag, 整数型, ,
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSocketListenQueue, , , 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketListenQueue, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定SNI主机域名, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 创建HP_TcpPackServer或HP_SSLPackServer对象, 整数型, , 创建 HP_TcpPackServer 或 HP_SSLPackServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HP_TcpServer或HP_SSLServer对象, 整数型, , 创建 HP_TcpServer 或 HP_SSLServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpPackServerListener对象, 整数型, , 创建 TcpPackServerListener 对象,只会创建一次
.子程序 创建TcpServerListener对象, 整数型, , 创建 TcpServerListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Accept预投递数量, 整数型, , 获取 Accept 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 获取包头标识, 整数型, , GetPackHeaderFlag`
.参数 hServer, 整数型, , 服务句柄
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取监听Socket的地址信息, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取监听Socket的等候队列大小, 整数型, , 获取监听 Socket 的等候队列大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取客户端连接数, 整数型, , GetConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个客户端连接时长, 逻辑型, , GetConnectPeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据包最大长度, 整数型, , GetMaxPackSize`
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hServer, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hServer, 整数型, , 服务句柄
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hServer, 整数型, , 服务句柄
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 设置Accept预投递数量, , , 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多
.参数 hServer, 整数型, , 服务句柄
.参数 dwAcceptSocketCount, 整数型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置包头标识, , , SetPackHeaderFlag(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 hServer, 整数型, , 服务句柄
.参数 usPackHeaderFlag, 整数型, ,
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置监听Socket的等候队列大小, , , 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketListenQueue, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据包最大长度, , , SetMaxPackSize(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxPackSize, 整数型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 销毁HP_TcpPackServer或HP_SSLPackServer对象, , , 销毁 HP_TcpPackServer 或 HP_SSLPackServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HP_TcpServer或HP_SSLServer对象, , , 销毁 HP_TcpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpPackServerListener对象, , , 销毁 TcpPackServerListener 对象
.子程序 销毁TcpServerListener对象, , , 销毁 TcpServerListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 增加SNI主机证书, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 增加SNI主机证书Ex, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.程序集 ITcpPullAgent, , 公开
.子程序 CleanupSSLContext, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 Connect, 逻辑型, , 名称:连接服务器 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 Create, 整数型, , 创建 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Create, 整数型, , 创建 HP_TcpPullAgent 或 HP_SSLPullAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpAgentListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 TcpPullAgentListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Destroy, , , 销毁 HP_TcpPullAgent 或 HP_SSLPullAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 释放 TcpAgentListener 对象
.子程序 DestroyListener, , , 销毁 TcpPullAgentListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 Fetch, 整数型, , 名称:抓取数据 描述:用户通过该方法从 Socket 组件中抓取数据,#FR_,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取连接数
.参数 hAgent, 整数型, ,
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个连接时长(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hAgent, 整数型, ,
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hAgent, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hAgent, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hAgent, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hAgent, 整数型, ,
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hAgent, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取某个连接的远程地址信息
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hAgent, 整数型, ,
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hAgent, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hAgent, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hAgent, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hAgent, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hAgent, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Peek, 整数型, , 名称:窥探数据(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,#FR_,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hAgent, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 绑定数据接收事件, 逻辑型, , OnReceive
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hAgent, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_TcpAgent或HP_SSLAgent对象, 整数型, , 创建 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HP_TcpPullAgent或HP_SSLPullAgent对象, 整数型, , 创建 HP_TcpPullAgent 或 HP_SSLPullAgent 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpAgentListener对象, 整数型, , 创建 TcpAgentListener 对象,只会创建一次
.子程序 创建TcpPullAgentListener对象, 整数型, , 创建 TcpPullAgentListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hAgent, 整数型, ,
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hAgent, 整数型, ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.子程序 获取地址重用选项, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hAgent, 整数型, ,
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接数, 整数型, , GetConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 短整数, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接时长, 逻辑型, , GetConnectPeriod(毫秒
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hAgent, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hAgent, 整数型, ,
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hAgent, 整数型, ,
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hAgent, 整数型, ,
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hAgent, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hAgent, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hAgent, 整数型, ,
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hAgent, 整数型, ,
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hAgent, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hAgent, 整数型, ,
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hAgent, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hAgent, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hAgent, 整数型, ,
.子程序 窥探数据, 整数型, , 名称:Peek(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,#FR_,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 连接服务器, 逻辑型, , 名称:Connect 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 参考 可空 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, 可空 , 连接附加数据(默认:nullptr)
.参数 lpszLocalAddress, 文本型, 可空 , 本地地址(默认:nullptr)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 hAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 【可选】绑定地址(默认:nullptr,【可选】绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.子程序 清理通信组件SSL运行环境, 逻辑型, , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hAgent, 整数型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hAgent, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hAgent, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 释放TcpAgentListener对象, , , 释放 TcpAgentListener 对象
.子程序 销毁HP_TcpAgent或HP_SSLAgent对象, , , 销毁 HP_TcpAgent 或 HP_SSLAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HP_TcpPullAgent或HP_SSLPullAgent对象, , , 销毁 HP_TcpPullAgent 或 HP_SSLPullAgent 对象
.参数 hAgent, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpPullAgentListener对象, , , 销毁 TcpPullAgentListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 抓取数据, 整数型, , 名称:Fetch 描述:用户通过该方法从 Socket 组件中抓取数据,#FR_,/
.参数 hAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.程序集 ITcpPullClient, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_TcpClient 或 HP_SSLClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Create, 整数型, , 创建 HP_TcpPullClient 或 HP_SSLPullClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpClientListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 TcpPullClientListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpClient 或 HP_SSLClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Destroy, , , 销毁 HP_TcpPullClient 或 HP_SSLPullClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 TcpClientListener 对象
.子程序 DestroyListener, , , 销毁 TcpPullClientListener 对象
.子程序 Fetch, 整数型, , 名称:抓取数据 描述:用户通过该方法从 Socket 组件中抓取数据,#FR_,/
.参数 hClient, 整数型, ,
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hClient, 整数型, ,
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hClient, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Peek, 整数型, , 名称:窥探数据(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,#FR_,/
.参数 hClient, 整数型, ,
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向服务端发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 hClient, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_TcpClient或HP_SSLClient对象, 整数型, , 创建 HP_TcpClient 或 HP_SSLClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HP_TcpPullClient或HP_SSLPullClient对象, 整数型, , 创建 HP_TcpPullClient 或 HP_SSLPullClient 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpClientListener对象, 整数型, , 创建 TcpClientListener 对象,只会创建一次
.子程序 创建TcpPullClientListener对象, 整数型, , 创建 TcpPullClientListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向服务端发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hClient, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hClient, 整数型, ,
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 窥探数据, 整数型, , 名称:Peek(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,#FR_,/
.参数 hClient, 整数型, ,
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 hClient, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hClient, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.子程序 销毁HP_TcpClient或HP_SSLClient对象, , , 销毁 HP_TcpClient 或 HP_SSLClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HP_TcpPullClient或HP_SSLPullClient对象, , , 销毁 HP_TcpPullClient 或 HP_SSLPullClient 对象
.参数 hClient, 整数型, ,
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpClientListener对象, , , 销毁 TcpClientListener 对象
.子程序 销毁TcpPullClientListener对象, , , 销毁 TcpPullClientListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 抓取数据, 整数型, , 名称:Fetch 描述:用户通过该方法从 Socket 组件中抓取数据,#FR_,/
.参数 hClient, 整数型, ,
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.程序集 ITcpPullServer, , 公开
.子程序 AddSSLContext, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 AddSSLContextByMemory, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 api_no, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 api_ok, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 BindSSLServerName, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 Create, 整数型, , 创建 HP_TcpServer 或 HP_SSLServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Create, 整数型, , 创建 HP_TcpPullServer 或 HP_SSLPullServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpPullServerListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 TcpServerListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 Destroy, , , 销毁 HP_TcpPullServer 或 HP_SSLPullServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 TcpPullServerListener 对象
.子程序 DestroyListener, , , 销毁 TcpServerListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 Fetch, 整数型, , 名称:抓取数据 描述:用户通过该方法从 Socket 组件中抓取数据,#FR_,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 GetAcceptSocketCount, 整数型, , 获取 Accept 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取客户端连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个客户端连接时长(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hServer, 整数型, , 服务句柄
.子程序 GetListenAddress, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSocketListenQueue, 整数型, , 获取监听 Socket 的等候队列大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hServer, 整数型, , 服务句柄
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hServer, 整数型, , 服务句柄
.子程序 http重定向, 逻辑型, , 支持301 302 303 307
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 状态码, 字节型, , 不写30 支持30开头 301(字节49)永久跳转 302临时跳转 303对于POST请求,它表示请求已经被处理 307(字节55)Temporary Redirect,对于POST请求,表示请求还没有被处理,客户端应该跳转后重新发起POST请求
.参数 跳转地址, 字节集, , 需要自行添加http://
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hServer, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hServer, 整数型, ,
.子程序 OnAccept, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Peek, 整数型, , 名称:窥探数据(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,#FR_,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetAcceptSocketCount, , , 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多
.参数 hServer, 整数型, , 服务句柄
.参数 dwAcceptSocketCount, 整数型, ,
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSocketListenQueue, , , 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketListenQueue, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定SNI主机域名, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 绑定数据接收事件, 逻辑型, , OnReceive
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 创建HP_TcpPullServer或HP_SSLPullServer对象, 整数型, , 创建 HP_TcpPullServer 或 HP_SSLPullServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建HP_TcpServer或HP_SSLServer对象, 整数型, , 创建 HP_TcpServer 或 HP_SSLServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpPullServerListener对象, 整数型, , 创建 TcpPullServerListener 对象,只会创建一次
.子程序 创建TcpServerListener对象, 整数型, , 创建 TcpServerListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Accept预投递数量, 整数型, , 获取 Accept 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取监听Socket的地址信息, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取监听Socket的等候队列大小, 整数型, , 获取监听 Socket 的等候队列大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取客户端连接数, 整数型, , GetConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个客户端连接时长, 逻辑型, , GetConnectPeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hServer, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hServer, 整数型, , 服务句柄
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hServer, 整数型, , 服务句柄
.子程序 窥探数据, 整数型, , 名称:Peek(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,#FR_,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 设置Accept预投递数量, , , 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多
.参数 hServer, 整数型, , 服务句柄
.参数 dwAcceptSocketCount, 整数型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置监听Socket的等候队列大小, , , 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketListenQueue, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 销毁HP_TcpPullServer或HP_SSLPullServer对象, , , 销毁 HP_TcpPullServer 或 HP_SSLPullServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁HP_TcpServer或HP_SSLServer对象, , , 销毁 HP_TcpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpPullServerListener对象, , , 销毁 TcpPullServerListener 对象
.子程序 销毁TcpServerListener对象, , , 销毁 TcpServerListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 增加SNI主机证书, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 增加SNI主机证书Ex, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 抓取数据, 整数型, , 名称:Fetch 描述:用户通过该方法从 Socket 组件中抓取数据,#FR_,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, 参考 , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.程序集 ITcpServer, , 公开
.子程序 AddSSLContext, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 AddSSLContextByMemory, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 api_no, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 api_ok, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 BindSSLServerName, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 Create, 整数型, , 创建 HP_TcpServer 或 HP_SSLServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 CreateListener, 整数型, , 创建 TcpServerListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_TcpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 DestroyListener, , , 销毁 TcpServerListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAcceptSocketCount, 整数型, , 获取 Accept 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取客户端连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个客户端连接时长(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetKeepAliveInterval, 整数型, , 获取异常心跳包间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetKeepAliveTime, 整数型, , 获取正常心跳包间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hServer, 整数型, , 服务句柄
.子程序 GetListenAddress, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSocketBufferSize, 整数型, , 获取通信数据缓冲区大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSocketListenQueue, 整数型, , 获取监听 Socket 的等候队列大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hServer, 整数型, , 服务句柄
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hServer, 整数型, , 服务句柄
.子程序 http重定向, 逻辑型, , 支持301 302 303 307
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 状态码, 字节型, , 不写30 支持30开头 301(字节49)永久跳转 302临时跳转 303对于POST请求,它表示请求已经被处理 307(字节55)Temporary Redirect,对于POST请求,表示请求还没有被处理,客户端应该跳转后重新发起POST请求
.参数 跳转地址, 字节集, , 需要自行添加http://
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hServer, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hServer, 整数型, ,
.子程序 OnAccept, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendSmallFile, 逻辑型, , 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 SetAcceptSocketCount, , , 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多
.参数 hServer, 整数型, , 服务句柄
.参数 dwAcceptSocketCount, 整数型, ,
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetKeepAliveInterval, , , 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetKeepAliveTime, , , 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketBufferSize, 整数型, ,
.子程序 SetSocketListenQueue, , , 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketListenQueue, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定SNI主机域名, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 创建HP_TcpServer或HP_SSLServer对象, 整数型, , 创建 HP_TcpServer 或 HP_SSLServer 对象
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 创建TcpServerListener对象, 整数型, , 创建 TcpServerListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送小文件, 逻辑型, , 名称:SendSmallFile 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Accept预投递数量, 整数型, , 获取 Accept 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取监听Socket的地址信息, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取监听Socket的等候队列大小, 整数型, , 获取监听 Socket 的等候队列大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取客户端连接数, 整数型, , GetConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个客户端连接时长, 逻辑型, , GetConnectPeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信数据缓冲区大小, 整数型, , GetSocketBufferSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hServer, 整数型, ,
.子程序 获取异常心跳包间隔, 整数型, , GetKeepAliveInterval
.参数 hServer, 整数型, , 服务句柄
.子程序 获取正常心跳包间隔, 整数型, , GetKeepAliveTime
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hServer, 整数型, , 服务句柄
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 设置Accept预投递数量, , , 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多
.参数 hServer, 整数型, , 服务句柄
.参数 dwAcceptSocketCount, 整数型, ,
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置监听Socket的等候队列大小, , , 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketListenQueue, 整数型, ,
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSocketBufferSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置异常心跳包间隔, , , SetKeepAliveInterval(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置正常心跳包间隔, , , SetKeepAliveTime(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwKeepAliveTime, 整数型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 销毁HP_TcpServer或HP_SSLServer对象, , , 销毁 HP_TcpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.参数 SSL, 逻辑型, , 是否是SSL组件
.子程序 销毁TcpServerListener对象, , , 销毁 TcpServerListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 增加SNI主机证书, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 增加SNI主机证书Ex, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.程序集 IThreadPool, , 公开
.子程序 AdjustThreadCount, 逻辑型, , 增加或减少线程池的工作线程数量,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 dwNewThreadCount, 整数型, , 线程数量,>0 -> dwNewThreadCount,=0 -> (CPU核数 * 2 + 2),<0 -> (CPU核数 * (-dwNewThreadCount))
.子程序 Create, 逻辑型, , 创建 IHPThreadPool 对象
.子程序 Destroy, , , 销毁 IHPThreadPool 对象
.子程序 GetMaxQueueSize, 整数型, , 获取任务队列最大容量
.子程序 GetQueueSize, 整数型, , 获取当前任务队列大小
.子程序 GetRejectedPolicy, 整数型, , 获取任务拒绝处理策略
.子程序 GetState, 整数型, , 查看线程池组件当前状态
.子程序 GetThreadCount, 整数型, , 获取工作线程数量
.子程序 HasStarted, 逻辑型, , 检查线程池组件是否已启动
.子程序 Ptr2Task, 逻辑型, , 指针转换TSocketTask对象
.参数 pTask, 整数型, ,
.参数 retResult, TSocketTask, 参考 ,
.子程序 Release_Task, , , 销毁 TSocketTask 对象
.参数 pTask, 整数型, ,
.子程序 Start, 逻辑型, , 启动线程池组件,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 dwThreadCount, 整数型, , 线程数量,(默认:0)
.参数 dwMaxQueueSize, 整数型, , 任务队列最大容量(0:不限制,默认:0)
.参数 enRejectedPolicy, 整数型, , 任务拒绝处理策略,#TRP_ 开头常量
.参数 dwStackSize, 整数型, , 线程堆栈空间大小(默认:0 -> 操作系统默认)
.子程序 Stop, 逻辑型, , 在规定时间内关闭线程池组件,如果工作线程在最大等待时间内未能正常关闭,会尝试强制关闭,这种情况下很可能会造成系统资源泄漏,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 dwMaxWait, 整数型, 可空 , 最大等待时间(毫秒,默认:INFINITE,一直等待)
.子程序 Submit, 逻辑型, , 向线程池提交异步任务,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码,其中,错误码 #ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
.参数 fnTaskProc, 子程序指针, , 任务处理函数, TaskFunc(pvArg 整数型)
.参数 pvArg, 整数型, , 任务参数
.参数 dwMaxWait, 整数型, 可空 , 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:#INFINITE,一直等待)
.子程序 Submit_Task, 逻辑型, , 创建 TSocketTask 对象并向线程池提交异步 Socket 任务,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码,其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
.参数 fnTaskProc, 子程序指针, , 任务入口函数
.参数 pSender, 整数型, , 发起对象
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, 可空 , 数据缓冲区
.参数 iBuffLen, 整数型, 可空 , 数据缓冲区长度
.参数 enBuffType, 整数型, 可空 , 数据缓冲区类型,#TBT_ (默认:#TBT_COPY)
.参数 wParam, 整数型, 可空 , 自定义参数
.参数 lParam, 整数型, 可空 , 自定义参数
.参数 dwMaxWait, 整数型, 可空 , 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 查看线程池组件当前状态, 整数型, , GetState
.子程序 创建IHPThreadPool对象, 逻辑型, , 创建 IHPThreadPool 对象
.子程序 创建TSocketTask对象并向线程池提交异步Socket任务TRUE__成功FALSE__失败, 逻辑型, , 创建 TSocketTask 对象并向线程池提交异步 Socket 任务,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码,其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
.参数 fnTaskProc, 子程序指针, , 任务入口函数
.参数 pSender, 整数型, , 发起对象
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, 可空 , 数据缓冲区
.参数 iBuffLen, 整数型, 可空 , 数据缓冲区长度
.参数 enBuffType, 整数型, 可空 , 数据缓冲区类型,#TBT_ (默认:#TBT_COPY)
.参数 wParam, 整数型, 可空 , 自定义参数
.参数 lParam, 整数型, 可空 , 自定义参数
.参数 dwMaxWait, 整数型, 可空 , 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 获取当前任务队列大小, 整数型, , GetQueueSize
.子程序 获取工作线程数量, 整数型, , GetThreadCount
.子程序 获取任务队列最大容量, 整数型, , GetMaxQueueSize
.子程序 获取任务拒绝处理策略, 整数型, , GetRejectedPolicy
.子程序 检查线程池组件是否已启动, 逻辑型, , HasStarted
.子程序 启动线程池组件TRUE__成功FALSE__失败, 逻辑型, , 启动线程池组件,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 dwThreadCount, 整数型, , 线程数量,(默认:0)
.参数 dwMaxQueueSize, 整数型, , 任务队列最大容量(0:不限制,默认:0)
.参数 enRejectedPolicy, 整数型, , 任务拒绝处理策略,#TRP_ 开头常量
.参数 dwStackSize, 整数型, , 线程堆栈空间大小(默认:0 -> 操作系统默认)
.子程序 向线程池提交异步任务TRUE__成功FALSE__失败, 逻辑型, , 向线程池提交异步任务,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码,其中,错误码 #ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
.参数 fnTaskProc, 子程序指针, , 任务处理函数, TaskFunc(pvArg 整数型)
.参数 pvArg, 整数型, , 任务参数
.参数 dwMaxWait, 整数型, 可空 , 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:#INFINITE,一直等待)
.子程序 销毁IHPThreadPool对象, , , 销毁 IHPThreadPool 对象
.子程序 销毁TSocketTask对象, , , 销毁 TSocketTask 对象
.参数 pTask, 整数型, ,
.子程序 在规定时间内关闭线程池组件, 逻辑型, , Stop,如果工作线程在最大等待时间内未能正常关闭,会尝试强制关闭,这种情况下很可能会造成系统资源泄漏,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 dwMaxWait, 整数型, 可空 , 最大等待时间(毫秒,默认:INFINITE,一直等待)
.子程序 增加或减少线程池的工作线程数量TRUE__成功FALSE__失败, 逻辑型, , 增加或减少线程池的工作线程数量,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 dwNewThreadCount, 整数型, , 线程数量,>0 -> dwNewThreadCount,=0 -> (CPU核数 * 2 + 2),<0 -> (CPU核数 * (-dwNewThreadCount))
.子程序 指针转换TSocketTask对象, 逻辑型, , Ptr2Task
.参数 pTask, 整数型, ,
.参数 retResult, TSocketTask, 参考 ,
.程序集 IUdpArqClient, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_UdpClient 对象
.子程序 Create, 整数型, , 创建 HP_UdpArqClient 对象
.子程序 CreateListener, 整数型, , 创建 UdpClientListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 UdpClientListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 UdpClient 对象
.参数 hClient, 整数型, ,
.子程序 Destroy, , , 销毁 HP_UdpArqClient 对象
.参数 hClient, 整数型, ,
.子程序 DestroyListener, , , 销毁 UdpClientListener 对象
.子程序 DestroyListener, , , 销毁 UdpClientListener 对象
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetDetectAttempts, 整数型, , 获取心跳检查次数
.参数 hClient, 整数型, ,
.子程序 GetDetectInterval, 整数型, , 获取心跳检查间隔
.参数 hClient, 整数型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFastLimit, 整数型, , 获取快速握手次数限制
.参数 hClient, 整数型, , 服务句柄
.子程序 GetFlushInterval, 整数型, , 获取数据刷新间隔
.参数 hClient, 整数型, , 服务句柄
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetHandShakeTimeout, 整数型, , 获取握手超时时间
.参数 hClient, 整数型, , 服务句柄
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxDatagramSize, 整数型, , 获取数据报文最大长度
.参数 hClient, 整数型, ,
.子程序 GetMaxMessageSize, 整数型, , 获取最大数据包大小
.参数 hClient, 整数型, , 服务句柄
.子程序 GetMaxTransUnit, 整数型, , 获取最大传输单元
.参数 hClient, 整数型, , 服务句柄
.子程序 GetMinRto, 整数型, , 获取最小重传超时时间
.参数 hClient, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRecvWndSize, 整数型, , 获取接收窗口大小
.参数 hClient, 整数型, , 服务句柄
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetResendByAcks, 整数型, , 获取快速重传 ACK 跨越次数
.参数 hClient, 整数型, , 服务句柄
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSendWndSize, 整数型, , 获取发送窗口大小
.参数 hClient, 整数型, , 服务句柄
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetWaitingSendMessageCount, 逻辑型, , 获取等待发送包数量
.参数 hClient, 整数型, , 服务句柄
.参数 piCount, 整数型, 参考 , 返回等待发送包数量
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsNoDelay, 逻辑型, , 检测是否开启 nodelay 模式
.参数 hClient, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 IsTurnoffCongestCtrl, 逻辑型, , 检测是否关闭拥塞控制
.参数 hClient, 整数型, , 服务句柄
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetDetectAttempts, , , 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwDetectAttempts, 整数型, ,
.子程序 SetDetectInterval, , , 设置监测包发送间隔(秒,0 不发送监测包)
.参数 hClient, 整数型, ,
.参数 dwDetectInterval, 整数型, ,
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFastLimit, , , 设置快速握手次数限制(默认:5,如果为 0 则不限制)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, ,
.子程序 SetFlushInterval, , , 设置数据刷新间隔(毫秒,默认:20)
.参数 hClient, 整数型, , 服务句柄
.参数 dwFlushInterval, 整数型, , 数据刷新间隔
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetHandShakeTimeout, , , 设置握手超时时间(毫秒,默认:5000)
.参数 hClient, 整数型, , 服务句柄
.参数 dwHandShakeTimeout, 整数型, , 握手超时时间
.子程序 SetMaxDatagramSize, , , 设置数据报文最大长度(最大64KB)
.参数 hClient, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, , 最大传输单元,最大64KB
.子程序 SetMaxMessageSize, , , 设置最大数据包大小(默认:4096)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMaxMessageSize, 整数型, , 最大数据包大小
.子程序 SetMaxTransUnit, , , 设置最大传输单元(默认:0,最大64KB)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, , 最大传输单元,最大64KB
.子程序 SetMinRto, , , 设置最小重传超时时间(毫秒,默认:30)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMinRto, 整数型, , 最小重传超时时间
.子程序 SetNoDelay, , , 设置是否开启 nodelay 模式(默认:FALSE,不开启)
.参数 hClient, 整数型, , 服务句柄
.参数 bNoDelay, 逻辑型, , 是否开启 nodelay 模式
.子程序 SetRecvWndSize, , , 设置接收窗口大小(数据包数量,默认:512)
.参数 hClient, 整数型, , 服务句柄
.参数 dwRecvWndSize, 整数型, , 接收窗口大小
.子程序 SetResendByAcks, , , 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传)
.参数 hClient, 整数型, , 服务句柄
.参数 dwResendByAcks, 整数型, , 跨越次数
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSendWndSize, , , 设置发送窗口大小(数据包数量,默认:128)
.参数 hClient, 整数型, , 服务句柄
.参数 dwSendWndSize, 整数型, , 发送窗口大小
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetTurnoffCongestCtrl, , , 设置是否关闭拥塞控制(默认:FALSE,不关闭)
.参数 hClient, 整数型, , 服务句柄
.参数 bTurnOff, 逻辑型, , 是否关闭拥塞控制
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_UdpArqClient对象, 整数型, , 创建 HP_UdpArqClient 对象
.子程序 创建HP_UdpClient对象, 整数型, , 创建 HP_UdpClient 对象
.子程序 创建UdpClientListener对象, 整数型, , 创建 UdpClientListener 对象,只会创建一次
.子程序 创建UdpClientListener对象, 整数型, , 创建 UdpClientListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取等待发送包数量, 逻辑型, , GetWaitingSendMessageCount
.参数 hClient, 整数型, , 服务句柄
.参数 piCount, 整数型, 参考 , 返回等待发送包数量
.子程序 获取发送窗口大小, 整数型, , GetSendWndSize
.参数 hClient, 整数型, , 服务句柄
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取接收窗口大小, 整数型, , GetRecvWndSize
.参数 hClient, 整数型, , 服务句柄
.子程序 获取快速握手次数限制, 整数型, , GetFastLimit
.参数 hClient, 整数型, , 服务句柄
.子程序 获取快速重传ACK跨越次数, 整数型, , 获取快速重传 ACK 跨越次数
.参数 hClient, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取数据报文最大长度, 整数型, , GetMaxDatagramSize
.参数 hClient, 整数型, ,
.子程序 获取数据刷新间隔, 整数型, , GetFlushInterval
.参数 hClient, 整数型, , 服务句柄
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取握手超时时间, 整数型, , GetHandShakeTimeout
.参数 hClient, 整数型, , 服务句柄
.子程序 获取心跳检查次数, 整数型, , GetDetectAttempts
.参数 hClient, 整数型, ,
.子程序 获取心跳检查间隔, 整数型, , GetDetectInterval
.参数 hClient, 整数型, ,
.子程序 获取最大传输单元, 整数型, , GetMaxTransUnit
.参数 hClient, 整数型, , 服务句柄
.子程序 获取最大数据包大小, 整数型, , GetMaxMessageSize
.参数 hClient, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 获取最小重传超时时间, 整数型, , GetMinRto
.参数 hClient, 整数型, , 服务句柄
.子程序 检测是否关闭拥塞控制, 逻辑型, , IsTurnoffCongestCtrl
.参数 hClient, 整数型, , 服务句柄
.子程序 检测是否开启nodelay模式, 逻辑型, , 检测是否开启 nodelay 模式
.参数 hClient, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置发送窗口大小, , , SetSendWndSize(数据包数量,默认:128)
.参数 hClient, 整数型, , 服务句柄
.参数 dwSendWndSize, 整数型, , 发送窗口大小
.子程序 设置监测包尝试次数, , , SetDetectAttempts(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwDetectAttempts, 整数型, ,
.子程序 设置监测包发送间隔, , , SetDetectInterval(秒,0 不发送监测包)
.参数 hClient, 整数型, ,
.参数 dwDetectInterval, 整数型, ,
.子程序 设置接收窗口大小, , , SetRecvWndSize(数据包数量,默认:512)
.参数 hClient, 整数型, , 服务句柄
.参数 dwRecvWndSize, 整数型, , 接收窗口大小
.子程序 设置快速握手次数限制, , , SetFastLimit(默认:5,如果为 0 则不限制)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, ,
.子程序 设置快速重传ACK跨越次数, , , 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传)
.参数 hClient, 整数型, , 服务句柄
.参数 dwResendByAcks, 整数型, , 跨越次数
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置是否关闭拥塞控制, , , SetTurnoffCongestCtrl(默认:FALSE,不关闭)
.参数 hClient, 整数型, , 服务句柄
.参数 bTurnOff, 逻辑型, , 是否关闭拥塞控制
.子程序 设置是否开启nodelay模式, , , 设置是否开启 nodelay 模式(默认:FALSE,不开启)
.参数 hClient, 整数型, , 服务句柄
.参数 bNoDelay, 逻辑型, , 是否开启 nodelay 模式
.子程序 设置数据报文最大长度, , , SetMaxDatagramSize(最大64KB)
.参数 hClient, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, , 最大传输单元,最大64KB
.子程序 设置数据刷新间隔, , , SetFlushInterval(毫秒,默认:20)
.参数 hClient, 整数型, , 服务句柄
.参数 dwFlushInterval, 整数型, , 数据刷新间隔
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置握手超时时间, , , SetHandShakeTimeout(毫秒,默认:5000)
.参数 hClient, 整数型, , 服务句柄
.参数 dwHandShakeTimeout, 整数型, , 握手超时时间
.子程序 设置最大传输单元, , , SetMaxTransUnit(默认:0,最大64KB)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, , 最大传输单元,最大64KB
.子程序 设置最大数据包大小, , , SetMaxMessageSize(默认:4096)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMaxMessageSize, 整数型, , 最大数据包大小
.子程序 设置最小重传超时时间, , , SetMinRto(毫秒,默认:30)
.参数 hClient, 整数型, , 服务句柄
.参数 dwMinRto, 整数型, , 最小重传超时时间
.子程序 销毁HP_UdpArqClient对象, , , 销毁 HP_UdpArqClient 对象
.参数 hClient, 整数型, ,
.子程序 销毁UdpClientListener对象, , , 销毁 UdpClientListener 对象
.子程序 销毁UdpClientListener对象, , , 销毁 UdpClientListener 对象
.子程序 销毁UdpClient对象, , , 销毁 UdpClient 对象
.参数 hClient, 整数型, ,
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IUdpArqServer, , 公开
.子程序 AddSSLContext, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 AddSSLContextByMemory, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 api_no, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 api_ok, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 BindSSLServerName, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 Create, 整数型, , 创建 HP_UdpServer 对象
.子程序 Create, 整数型, , 创建 HP_UdpArqServer 对象
.子程序 CreateListener, 整数型, , 创建 UdpServerListener 对象,只会创建一次
.子程序 CreateListener, 整数型, , 创建 UdpServerListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_UdpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.子程序 Destroy, , , 销毁 HP_UdpArqServer 对象
.参数 hServer, 整数型, , 服务句柄
.子程序 DestroyListener, , , 销毁 UdpServerListener 对象
.子程序 DestroyListener, , , 销毁 UdpServerListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取客户端连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个客户端连接时长(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetDetectAttempts, 整数型, , 获取心跳检查次数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetDetectInterval, 整数型, , 获取心跳检查间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFastLimit, 整数型, , 获取快速握手次数限制
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFlushInterval, 整数型, , 获取数据刷新间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetHandShakeTimeout, 整数型, , 获取握手超时时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hServer, 整数型, , 服务句柄
.子程序 GetListenAddress, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMaxDatagramSize, 整数型, , 获取数据报文最大长度
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMaxMessageSize, 整数型, , 获取最大数据包大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMaxTransUnit, 整数型, , 获取最大传输单元
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMinRto, 整数型, , 获取最小重传超时时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetPostReceiveCount, 整数型, , 获取 Receive 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetRecvWndSize, 整数型, , 获取接收窗口大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetResendByAcks, 整数型, , 获取快速重传 ACK 跨越次数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSendWndSize, 整数型, , 获取发送窗口大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetWaitingSendMessageCount, 逻辑型, , 获取等待发送包数量
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piCount, 整数型, 参考 , 返回等待发送包数量
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hServer, 整数型, , 服务句柄
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hServer, 整数型, , 服务句柄
.子程序 http重定向, 逻辑型, , 支持301 302 303 307
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 状态码, 字节型, , 不写30 支持30开头 301(字节49)永久跳转 302临时跳转 303对于POST请求,它表示请求已经被处理 307(字节55)Temporary Redirect,对于POST请求,表示请求还没有被处理,客户端应该跳转后重新发起POST请求
.参数 跳转地址, 字节集, , 需要自行添加http://
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hServer, 整数型, , 服务句柄
.子程序 IsNoDelay, 逻辑型, , 检测是否开启 nodelay 模式
.参数 hServer, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hServer, 整数型, ,
.子程序 IsTurnoffCongestCtrl, 逻辑型, , 检测是否关闭拥塞控制
.参数 hServer, 整数型, , 服务句柄
.子程序 OnAccept, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetDetectAttempts, , , 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectAttempts, 整数型, , 尝试次数
.子程序 SetDetectInterval, , , 设置监测包发送间隔(秒,0 不发送监测包)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectInterval, 整数型, , 间隔时间
.子程序 SetFastLimit, , , 设置快速握手次数限制(默认:5,如果为 0 则不限制)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, ,
.子程序 SetFlushInterval, , , 设置数据刷新间隔(毫秒,默认:20)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFlushInterval, 整数型, , 数据刷新间隔
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetHandShakeTimeout, , , 设置握手超时时间(毫秒,默认:5000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwHandShakeTimeout, 整数型, , 握手超时时间
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetMaxDatagramSize, , , 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxDatagramSize, 整数型, , 最大长度
.子程序 SetMaxMessageSize, , , 设置最大数据包大小(默认:4096)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxMessageSize, 整数型, , 最大数据包大小
.子程序 SetMaxTransUnit, , , 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, , 最大传输单元
.子程序 SetMinRto, , , 设置最小重传超时时间(毫秒,默认:30)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMinRto, 整数型, , 最小重传超时时间
.子程序 SetNoDelay, , , 设置是否开启 nodelay 模式(默认:FALSE,不开启)
.参数 hServer, 整数型, , 服务句柄
.参数 bNoDelay, 逻辑型, , 是否开启 nodelay 模式
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetPostReceiveCount, , , 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 hServer, 整数型, , 服务句柄
.参数 dwPostReceiveCount, 整数型, , 投递数量
.子程序 SetRecvWndSize, , , 设置接收窗口大小(数据包数量,默认:512)
.参数 hServer, 整数型, , 服务句柄
.参数 dwRecvWndSize, 整数型, , 接收窗口大小
.子程序 SetResendByAcks, , , 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传)
.参数 hServer, 整数型, , 服务句柄
.参数 dwResendByAcks, 整数型, , 跨越次数
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 SetSendWndSize, , , 设置发送窗口大小(数据包数量,默认:128)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSendWndSize, 整数型, , 发送窗口大小
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetTurnoffCongestCtrl, , , 设置是否关闭拥塞控制(默认:FALSE,不关闭)
.参数 hServer, 整数型, , 服务句柄
.参数 bTurnOff, 逻辑型, , 是否关闭拥塞控制
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定SNI主机域名, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 创建HP_UdpArqServer对象, 整数型, , 创建 HP_UdpArqServer 对象
.子程序 创建HP_UdpServer对象, 整数型, , 创建 HP_UdpServer 对象
.子程序 创建UdpServerListener对象, 整数型, , 创建 UdpServerListener 对象,只会创建一次
.子程序 创建UdpServerListener对象, 整数型, , 创建 UdpServerListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Receive预投递数量, 整数型, , 获取 Receive 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 获取等待发送包数量, 逻辑型, , GetWaitingSendMessageCount
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piCount, 整数型, 参考 , 返回等待发送包数量
.子程序 获取发送窗口大小, 整数型, , GetSendWndSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取监听Socket的地址信息, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取接收窗口大小, 整数型, , GetRecvWndSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取客户端连接数, 整数型, , GetConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取快速握手次数限制, 整数型, , GetFastLimit
.参数 hServer, 整数型, , 服务句柄
.子程序 获取快速重传ACK跨越次数, 整数型, , 获取快速重传 ACK 跨越次数
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个客户端连接时长, 逻辑型, , GetConnectPeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据报文最大长度, 整数型, , GetMaxDatagramSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据刷新间隔, 整数型, , GetFlushInterval
.参数 hServer, 整数型, , 服务句柄
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hServer, 整数型, ,
.子程序 获取握手超时时间, 整数型, , GetHandShakeTimeout
.参数 hServer, 整数型, , 服务句柄
.子程序 获取心跳检查次数, 整数型, , GetDetectAttempts
.参数 hServer, 整数型, , 服务句柄
.子程序 获取心跳检查间隔, 整数型, , GetDetectInterval
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最大传输单元, 整数型, , GetMaxTransUnit
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最大数据包大小, 整数型, , GetMaxMessageSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最小重传超时时间, 整数型, , GetMinRto
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否关闭拥塞控制, 逻辑型, , IsTurnoffCongestCtrl
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否开启nodelay模式, 逻辑型, , 检测是否开启 nodelay 模式
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hServer, 整数型, , 服务句柄
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Receive预投递数量, , , 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 hServer, 整数型, , 服务句柄
.参数 dwPostReceiveCount, 整数型, , 投递数量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置发送窗口大小, , , SetSendWndSize(数据包数量,默认:128)
.参数 hServer, 整数型, , 服务句柄
.参数 dwSendWndSize, 整数型, , 发送窗口大小
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置监测包尝试次数, , , SetDetectAttempts(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectAttempts, 整数型, , 尝试次数
.子程序 设置监测包发送间隔, , , SetDetectInterval(秒,0 不发送监测包)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectInterval, 整数型, , 间隔时间
.子程序 设置接收窗口大小, , , SetRecvWndSize(数据包数量,默认:512)
.参数 hServer, 整数型, , 服务句柄
.参数 dwRecvWndSize, 整数型, , 接收窗口大小
.子程序 设置快速握手次数限制, , , SetFastLimit(默认:5,如果为 0 则不限制)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, ,
.子程序 设置快速重传ACK跨越次数, , , 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传)
.参数 hServer, 整数型, , 服务句柄
.参数 dwResendByAcks, 整数型, , 跨越次数
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置是否关闭拥塞控制, , , SetTurnoffCongestCtrl(默认:FALSE,不关闭)
.参数 hServer, 整数型, , 服务句柄
.参数 bTurnOff, 逻辑型, , 是否关闭拥塞控制
.子程序 设置是否开启nodelay模式, , , 设置是否开启 nodelay 模式(默认:FALSE,不开启)
.参数 hServer, 整数型, , 服务句柄
.参数 bNoDelay, 逻辑型, , 是否开启 nodelay 模式
.子程序 设置数据报文最大长度, , , SetMaxDatagramSize(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxDatagramSize, 整数型, , 最大长度
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 设置数据刷新间隔, , , SetFlushInterval(毫秒,默认:20)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFlushInterval, 整数型, , 数据刷新间隔
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置握手超时时间, , , SetHandShakeTimeout(毫秒,默认:5000)
.参数 hServer, 整数型, , 服务句柄
.参数 dwHandShakeTimeout, 整数型, , 握手超时时间
.子程序 设置最大传输单元, , , SetMaxTransUnit(默认:0,与 SetMaxDatagramSize() 一致
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxTransUnit, 整数型, , 最大传输单元
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 设置最大数据包大小, , , SetMaxMessageSize(默认:4096)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxMessageSize, 整数型, , 最大数据包大小
.子程序 设置最小重传超时时间, , , SetMinRto(毫秒,默认:30)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMinRto, 整数型, , 最小重传超时时间
.子程序 销毁HP_UdpArqServer对象, , , 销毁 HP_UdpArqServer 对象
.参数 hServer, 整数型, , 服务句柄
.子程序 销毁HP_UdpServer或HP_SSLServer对象, , , 销毁 HP_UdpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.子程序 销毁UdpServerListener对象, , , 销毁 UdpServerListener 对象
.子程序 销毁UdpServerListener对象, , , 销毁 UdpServerListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 增加SNI主机证书, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 增加SNI主机证书Ex, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.程序集 IUdpCast, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_UdpCast 对象
.子程序 CreateListener, 整数型, , 创建 UdpCastListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 UdpCast 对象
.参数 hClient, 整数型, ,
.子程序 DestroyListener, , , 销毁 UdpCastListener 对象
.子程序 GetCastMode, 整数型, , 获取传播模式
.参数 hClient, 整数型, ,
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxDatagramSize, 整数型, , 获取数据报文最大长度
.参数 hClient, 整数型, ,
.子程序 GetMultiCastTtl, 整数型, , 获取组播报文的 TTL
.参数 hClient, 整数型, ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsMultiCastLoop, 逻辑型, , 检测是否启用组播环路
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetCastMode, , , 设置传播模式(组播或广播)
.参数 hClient, 整数型, ,
.参数 enCastMode, 整数型, ,
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetMaxDatagramSize, , , 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 hClient, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.子程序 SetMultiCastLoop, , , 设置是否启用组播环路(TRUE or FALSE)
.参数 hClient, 整数型, ,
.参数 bMCLoop, 逻辑型, ,
.子程序 SetMultiCastTtl, , , 设置组播报文的 TTL(0 - 255)
.参数 hClient, 整数型, ,
.参数 iMCTtl, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_UdpCast对象, 整数型, , 创建 HP_UdpCast 对象
.子程序 创建UdpCastListener对象, 整数型, , 创建 UdpCastListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取传播模式, 整数型, , GetCastMode
.参数 hClient, 整数型, ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取数据报文最大长度, 整数型, , GetMaxDatagramSize
.参数 hClient, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取组播报文的TTL, 整数型, , 获取组播报文的 TTL
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否启用组播环路, 逻辑型, , IsMultiCastLoop
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置传播模式, , , SetCastMode(组播或广播)
.参数 hClient, 整数型, ,
.参数 enCastMode, 整数型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置是否启用组播环路, , , SetMultiCastLoop(TRUE or FALSE)
.参数 hClient, 整数型, ,
.参数 bMCLoop, 逻辑型, ,
.子程序 设置数据报文最大长度, , , SetMaxDatagramSize(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 hClient, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置组播报文的TTL, , , 设置组播报文的 TTL(0 - 255)
.参数 hClient, 整数型, ,
.参数 iMCTtl, 整数型, ,
.子程序 销毁UdpCastListener对象, , , 销毁 UdpCastListener 对象
.子程序 销毁UdpCast对象, , , 销毁 UdpCast 对象
.参数 hClient, 整数型, ,
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IUdpClient, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 Create, 整数型, , 创建 HP_UdpClient 对象
.子程序 CreateListener, 整数型, , 创建 UdpClientListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 UdpClient 对象
.参数 hClient, 整数型, ,
.子程序 DestroyListener, , , 销毁 UdpClientListener 对象
.子程序 GetConnectionID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 GetDetectAttempts, 整数型, , 获取心跳检查次数
.参数 hClient, 整数型, ,
.子程序 GetDetectInterval, 整数型, , 获取心跳检查间隔
.参数 hClient, 整数型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hClient, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 hClient, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hClient, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hClient, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxDatagramSize, 整数型, , 获取数据报文最大长度
.参数 hClient, 整数型, ,
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetRemoteHost, 逻辑型, , 获取连接的远程主机信息
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 hClient, 整数型, ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hClient, 整数型, ,
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hClient, 整数型, ,
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hClient, 整数型, ,
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnConnect, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareConnect, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetDetectAttempts, , , 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwDetectAttempts, 整数型, ,
.子程序 SetDetectInterval, , , 设置监测包发送间隔(秒,0 不发送监测包)
.参数 hClient, 整数型, ,
.参数 dwDetectInterval, 整数型, ,
.子程序 SetExtra, , , 设置连接的附加数据
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetMaxDatagramSize, , , 设置数据报文最大长度(最大64KB)
.参数 hClient, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, , 最大传输单元,最大64KB
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 Start, 逻辑型, , 名称:启动通信组件(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_连接事件, 逻辑型, , 【可选】绑定连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnConnect(pSender 整数型,dwConnID 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备连接事件, 逻辑型, , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,dwConnID 整数型,socket 整数型)
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hClient, 整数型, ,
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 创建HP_UdpClient对象, 整数型, , 创建 HP_UdpClient 对象
.子程序 创建UdpClientListener对象, 整数型, , 创建 UdpClientListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.子程序 获取ClientSocket的地址信, 逻辑型, , 获取 Client Socket 的地址信
.参数 hClient, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 hClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hClient, 整数型, ,
.子程序 获取该组件对象的连接ID, 整数型, , 获取该组件对象的连接 ID
.参数 hClient, 整数型, ,
.子程序 获取连接的附加数据, 整数型, , GetExtra
.参数 hClient, 整数型, ,
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接的远程主机信息, 逻辑型, , GetRemoteHost
.参数 hClient, 整数型, ,
.参数 lpszHost, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hClient, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 hClient, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 hClient, 整数型, ,
.子程序 获取数据报文最大长度, 整数型, , GetMaxDatagramSize
.参数 hClient, 整数型, ,
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hClient, 整数型, ,
.子程序 获取心跳检查次数, 整数型, , GetDetectAttempts
.参数 hClient, 整数型, ,
.子程序 获取心跳检查间隔, 整数型, , GetDetectInterval
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hClient, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hClient, 整数型, ,
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hClient, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hClient, 整数型, ,
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hClient, 整数型, ,
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hClient, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start(并指定【可选】绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 hClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, 可空 , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, 可空 , 本地端口(默认:0)
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hClient, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 hClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置监测包尝试次数, , , SetDetectAttempts(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hClient, 整数型, ,
.参数 dwDetectAttempts, 整数型, ,
.子程序 设置监测包发送间隔, , , SetDetectInterval(秒,0 不发送监测包)
.参数 hClient, 整数型, ,
.参数 dwDetectInterval, 整数型, ,
.子程序 设置连接的附加数据, , , SetExtra
.参数 hClient, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.子程序 设置数据报文最大长度, , , SetMaxDatagramSize(最大64KB)
.参数 hClient, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, , 最大传输单元,最大64KB
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 销毁UdpClientListener对象, , , 销毁 UdpClientListener 对象
.子程序 销毁UdpClient对象, , , 销毁 UdpClient 对象
.参数 hClient, 整数型, ,
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hClient, 整数型, ,
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.程序集 IUdpNode, , 公开
.子程序 Create, 整数型, , 创建 HP_UdpNode 对象
.子程序 CreateListener, 整数型, , 创建 UdpNodeListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 UdpNode 对象
.参数 hNode, 整数型, ,
.子程序 DestroyListener, , , 销毁 UdpNodeListener 对象
.子程序 GetCastAddress, 逻辑型, , 获取本节点传播地址
.参数 pNode, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetCastMode, 整数型, , 获取传播模式
.参数 pNode, 整数型, ,
.子程序 GetExtra, 整数型, , 获取附加数据
.参数 pNode, 整数型, ,
.子程序 GetFreeBufferPoolHold, 整数型, , 获取内存块缓存池回收阀值
.参数 pNode, 整数型, ,
.子程序 GetFreeBufferPoolSize, 整数型, , 获取内存块缓存池大小
.参数 pNode, 整数型, ,
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 pNode, 整数型, ,
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 pNode, 整数型, ,
.子程序 GetLocalAddress, 逻辑型, , 获取本节点地址
.参数 pNode, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxDatagramSize, 整数型, , 获取数据报文最大长度
.参数 pNode, 整数型, ,
.子程序 GetMultiCastTtl, 整数型, , 获取组播报文的 TTL
.参数 pNode, 整数型, ,
.子程序 GetPendingDataLength, 逻辑型, , 获取未发出数据的长度
.参数 pNode, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetPostReceiveCount, 整数型, , 获取 Receive 预投递数量
.参数 pNode, 整数型, ,
.子程序 GetReuseAddressPolicy, 整数型, , 获取地址重用选项 #RAP_ 开头常量
.参数 pNode, 整数型, ,
.子程序 GetState, 整数型, , 检查通信组件是否已启动
.参数 pNode, 整数型, ,
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 pNode, 整数型, ,
.子程序 HasStarted, 逻辑型, , 查看通信组件当前状态
.参数 pNode, 整数型, ,
.子程序 IsMultiCastLoop, 逻辑型, , 检测是否启用组播环路
.参数 pNode, 整数型, ,
.子程序 OnError, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnError(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型,lpszRemoteAddress 文本型,usRemotePort 短整数型,pData 整数型(BYTE*),iLength 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,lpszRemoteAddress 文本型,usRemotePort 短整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,lpszRemoteAddress 文本型,usRemotePort 短整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendCast, 逻辑型, , 名称:发送数据 描述:向传播地址发送数据
.参数 pNode, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendCastPackets, 逻辑型, , 名称:发送多组数据 描述:向传播地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
.参数 pNode, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.子程序 SendCastPart, 逻辑型, , 名称:发送数据 描述:向传播地址发送数据
.参数 pNode, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, WSABUF, 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetExtra, , , 设置附加数据
.参数 pNode, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 SetFreeBufferPoolHold, , , 设置内存块缓存池回收阀值
.参数 pNode, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetFreeBufferPoolSize, , , 设置内存块缓存池大小
.参数 pNode, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 SetMaxDatagramSize, , , 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节)
.参数 pNode, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.子程序 SetMultiCastLoop, , , 设置是否启用组播环路(TRUE or FALSE)
.参数 pNode, 整数型, ,
.参数 bMCLoop, 逻辑型, ,
.子程序 SetMultiCastTtl, , , 设置组播报文的 TTL(0 - 255)
.参数 pNode, 整数型, ,
.参数 iMCTtl, 整数型, ,
.子程序 SetPostReceiveCount, , , 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 pNode, 整数型, ,
.参数 dwPostReceiveCount, 整数型, ,
.子程序 SetReuseAddressPolicy, , , 设置地址重用选项
.参数 pNode, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 pNode, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
.参数 pNode, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,绑定任意地址)
.参数 usPort, 短整数, 可空 , 本地端口(默认:0)
.子程序 StartWithCast, 逻辑型, , 名称:启动通信组件 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
.参数 pNode, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,绑定任意地址)
.参数 usPort, 短整数, 可空 , 本地端口(默认:0)
.参数 enCastMode, 整数型, 可空 , 传播模式(默认:CM_UNICAST)
.参数 lpszCastAddress, 文本型, 可空 , 传播地址(默认:nullptr,当 enCaseMode 为 CM_MULTICAST 或 CM_BROADCAST 时有效)
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭 UDP 节点通信组件,关闭完成后释放所有资源
.参数 pNode, 整数型, ,
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 pNode, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnError(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型,lpszRemoteAddress 文本型,usRemotePort 短整数型,pData 整数型(BYTE*),iLength 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,lpszRemoteAddress 文本型,usRemotePort 短整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【可选】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,lpszRemoteAddress 文本型,usRemotePort 短整数型,pData 整数型,iLength 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 查看通信组件当前状态, 逻辑型, , HasStarted
.参数 pNode, 整数型, ,
.子程序 创建HP_UdpNode对象, 整数型, , 创建 HP_UdpNode 对象
.子程序 创建UdpNodeListener对象, 整数型, , 创建 UdpNodeListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 pNode, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, WSABUF, 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.子程序 发送广播多组数据, 逻辑型, , 名称:SendCastPackets 描述:向传播地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
.参数 pNode, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.子程序 发送广播数据, 逻辑型, , 名称:SendCast 描述:向传播地址发送数据
.参数 pNode, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 发送广播数据由指针, 逻辑型, , 名称:SendCastPart 描述:向传播地址发送数据
.参数 pNode, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭 UDP 节点通信组件,关闭完成后释放所有资源
.参数 pNode, 整数型, ,
.子程序 获取Receive预投递数量, 整数型, , 获取 Receive 预投递数量
.参数 pNode, 整数型, ,
.子程序 获取本节点传播地址, 逻辑型, , GetCastAddress
.参数 pNode, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取本节点地址, 逻辑型, , GetLocalAddress
.参数 pNode, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取传播模式, 整数型, , GetCastMode
.参数 pNode, 整数型, ,
.子程序 获取附加数据, 整数型, , GetExtra
.参数 pNode, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 pNode, 整数型, ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferPoolSize
.参数 pNode, 整数型, ,
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferPoolHold
.参数 pNode, 整数型, ,
.子程序 获取数据报文最大长度, 整数型, , GetMaxDatagramSize
.参数 pNode, 整数型, ,
.子程序 获取未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 pNode, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取组播报文的TTL, 整数型, , 获取组播报文的 TTL
.参数 pNode, 整数型, ,
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 pNode, 整数型, ,
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 pNode, 整数型, ,
.子程序 检测是否启用组播环路, 逻辑型, , IsMultiCastLoop
.参数 pNode, 整数型, ,
.子程序 检查通信组件是否已启动, 整数型, , GetState
.参数 pNode, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
.参数 pNode, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,绑定任意地址)
.参数 usPort, 短整数, 可空 , 本地端口(默认:0)
.子程序 启动通信组件Ex, 逻辑型, , 名称:StartWithCast 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
.参数 pNode, 整数型, ,
.参数 lpszBindAddress, 文本型, 可空 , 绑定地址(默认:nullptr,绑定任意地址)
.参数 usPort, 短整数, 可空 , 本地端口(默认:0)
.参数 enCastMode, 整数型, 可空 , 传播模式(默认:CM_UNICAST)
.参数 lpszCastAddress, 文本型, 可空 , 传播地址(默认:nullptr,当 enCaseMode 为 CM_MULTICAST 或 CM_BROADCAST 时有效)
.子程序 设置Receive预投递数量, , , 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 pNode, 整数型, ,
.参数 dwPostReceiveCount, 整数型, ,
.子程序 设置地址重用选项, , , SetReuseAddressPolicy
.参数 pNode, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.子程序 设置附加数据, , , SetExtra
.参数 pNode, 整数型, ,
.参数 pExtra, 整数型, ,
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 pNode, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置内存块缓存池大小, , , SetFreeBufferPoolSize
.参数 pNode, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferPoolHold
.参数 pNode, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.子程序 设置是否启用组播环路, , , SetMultiCastLoop(TRUE or FALSE)
.参数 pNode, 整数型, ,
.参数 bMCLoop, 逻辑型, ,
.子程序 设置数据报文最大长度, , , SetMaxDatagramSize(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节)
.参数 pNode, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.子程序 设置组播报文的TTL, , , 设置组播报文的 TTL(0 - 255)
.参数 pNode, 整数型, ,
.参数 iMCTtl, 整数型, ,
.子程序 销毁UdpNodeListener对象, , , 销毁 UdpNodeListener 对象
.子程序 销毁UdpNode对象, , , 销毁 UdpNode 对象
.参数 hNode, 整数型, ,
.程序集 IUdpServer, , 公开
.子程序 AddSSLContext, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 AddSSLContextByMemory, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.子程序 api_no, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 api_ok, 逻辑型, , Utf8编码,无需组包效率超高,易语言专用 HTTP 1.0 协议
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.子程序 BindSSLServerName, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 Create, 整数型, , 创建 HP_UdpServer 对象
.子程序 CreateListener, 整数型, , 创建 UdpServerListener 对象,只会创建一次
.子程序 Destroy, , , 销毁 HP_UdpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.子程序 DestroyListener, , , 销毁 UdpServerListener 对象
.子程序 Disconnect, 逻辑型, , 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectLongConnections, 逻辑型, , 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 DisconnectSilenceConnections, 逻辑型, , 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 GetAllConnectionIDs, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 GetConnectionCount, 整数型, , 获取客户端连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetConnectionExtra, 逻辑型, , 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 GetConnectPeriod, 逻辑型, , 获取某个客户端连接时长(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetDetectAttempts, 整数型, , 获取心跳检查次数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetDetectInterval, 整数型, , 获取心跳检查间隔
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjHold, 整数型, , 获取内存块缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeBufferObjPool, 整数型, , 获取内存块缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjHold, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjLockTime, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 GetFreeSocketObjPool, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastError, 整数型, , 获取最近一次失败操作的错误代码
.参数 hServer, 整数型, , 服务句柄
.子程序 GetLastErrorDesc, 文本型, , 获取最近一次失败操作的错误描述
.参数 hServer, 整数型, , 服务句柄
.子程序 GetListenAddress, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetLocalAddress, 逻辑型, , 获取某个连接的本地地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetMaxConnectionCount, 整数型, , 获取最大连接数
.参数 hServer, 整数型, , 服务句柄
.子程序 GetMaxDatagramSize, 整数型, , 获取数据报文最大长度
.参数 hServer, 整数型, , 服务句柄
.子程序 GetOnSendSyncPolicy, 整数型, , 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetPendingDataLength, 逻辑型, , 获取连接中未发出数据的长度
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 GetPostReceiveCount, 整数型, , 获取 Receive 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetRemoteAddress, 逻辑型, , 获取某个连接的远程地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 GetSendPolicy, 整数型, , 获取数据发送策略
.参数 hServer, 整数型, , 服务句柄
.子程序 GetSilencePeriod, 逻辑型, , 获取某个连接静默时间(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 GetSSLCipherList, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 GetSSLSessionInfo, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 GetState, 整数型, , 查看通信组件当前状态,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 GetWorkerThreadCount, 整数型, , 获取工作线程数量
.参数 hServer, 整数型, , 服务句柄
.子程序 HasStarted, 逻辑型, , 检查通信组件是否已启动
.参数 hServer, 整数型, , 服务句柄
.子程序 http重定向, 逻辑型, , 支持301 302 303 307
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 状态码, 字节型, , 不写30 支持30开头 301(字节49)永久跳转 302临时跳转 303对于POST请求,它表示请求已经被处理 307(字节55)Temporary Redirect,对于POST请求,表示请求还没有被处理,客户端应该跳转后重新发起POST请求
.参数 跳转地址, 字节集, , 需要自行添加http://
.子程序 IsConnected, 逻辑型, , 检测是否有效连接
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 IsMarkSilence, 逻辑型, , 检测是否标记静默时间
.参数 hServer, 整数型, , 服务句柄
.子程序 IsPauseReceive, 逻辑型, , 获取连接的数据接收状态
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 IsSecure, 逻辑型, , 检测是否为安全连接(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 IsSSLAutoHandShake, 逻辑型, , 获取通信组件握手方式
.参数 hServer, 整数型, ,
.子程序 OnAccept, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 OnClose, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnPrepareListen, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 OnReceive, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnShutdown, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 PauseReceive, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 Send, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 SendBytes, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 SendPackets, 逻辑型, , 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 SendPart, 逻辑型, , 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 SetConnectionExtra, 逻辑型, , 名称:设置连接的附加数据 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 SetDetectAttempts, , , 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectAttempts, 整数型, , 尝试次数
.子程序 SetDetectInterval, , , 设置监测包发送间隔(秒,0 不发送监测包)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectInterval, 整数型, , 间隔时间
.子程序 SetFreeBufferObjHold, , , 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 SetFreeBufferObjPool, , , 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjHold, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 SetFreeSocketObjLockTime, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 SetFreeSocketObjPool, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 SetMarkSilence, , , 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 SetMaxConnectionCount, , , 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 SetMaxDatagramSize, , , 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxDatagramSize, 整数型, , 最大长度
.子程序 SetOnSendSyncPolicy, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 SetPostReceiveCount, , , 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 hServer, 整数型, , 服务句柄
.参数 dwPostReceiveCount, 整数型, , 投递数量
.子程序 SetSendPolicy, , , 设置数据发送策略
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 SetSSLAutoHandShake, , , 设置通信组件握手方式(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 SetSSLCipherList, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetupSSLContextByMemory, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 SetWorkerThreadCount, , , 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 Start, 逻辑型, , 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 StartSSLHandShake, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 Stop, 逻辑型, , 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 Wait, 逻辑型, , 名称:等待 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 绑定_断开事件, 逻辑型, , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, 逻辑型, , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_关闭事件, 逻辑型, , 【可选】绑定关闭事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnShutdown(pSender 整数型)
.子程序 绑定_接受事件, 逻辑型, , 【可选】绑定接受事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnAccept(pSender 整数型,dwConnID 整数型,pClient 整数型)
.子程序 绑定_数据接收事件, 逻辑型, , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_握手事件, 逻辑型, , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_准备监听事件, 逻辑型, , 【可选】绑定准备监听事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareListen(pSender 整数型,soListen 整数型)
.子程序 绑定SNI主机域名, 逻辑型, , 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 hServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.子程序 查看通信组件当前状态, 整数型, , GetState,#SS_ 开头常量
.参数 hServer, 整数型, , 服务句柄
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, 可空 , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 初始化通信组件SSL环境参数Ex, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.子程序 创建HP_UdpServer对象, 整数型, , 创建 HP_UdpServer 对象
.子程序 创建UdpServerListener对象, 整数型, , 创建 UdpServerListener 对象,只会创建一次
.子程序 等待, 逻辑型, , 名称:Wait 描述:等待通信组件停止运行
.参数 hServer, 整数型, , 服务句柄
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.子程序 断开超时连接, 逻辑型, , 名称:DisconnectLongConnections 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开静默连接, 逻辑型, , 名称:DisconnectSilenceConnections 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 断开连接, 逻辑型, , 名称:Disconnect 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.子程序 发送多组数据, 逻辑型, , 名称:SendPackets 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, WSABUF, 数组, 发送缓冲区
.子程序 发送数据, 逻辑型, , 名称:SendBytes 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 字节集, , 发送缓冲区
.子程序 发送数据Part, 逻辑型, , 名称:SendPart 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.子程序 发送数据由指针, 逻辑型, , 名称:Send 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.子程序 关闭通信组件, 逻辑型, , 名称:Stop 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Receive预投递数量, 整数型, , 获取 Receive 预投递数量
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池大小, 整数型, , 获取 Socket 缓存池大小
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存池回收阀值, 整数型, , 获取 Socket 缓存池回收阀值
.参数 hServer, 整数型, , 服务句柄
.子程序 获取Socket缓存对象锁定时间, 整数型, , 获取 Socket 缓存对象锁定时间
.参数 hServer, 整数型, , 服务句柄
.子程序 获取SSLSession信息, 逻辑型, , 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 参考 ,
.子程序 获取SSL加密算法列表, 文本型, , 获取 SSL 加密算法列表
.参数 hServer, 整数型, ,
.子程序 获取工作线程数量, 整数型, , GetWorkerThreadCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取监听Socket的地址信息, 逻辑型, , 获取监听 Socket 的地址信息
.参数 hServer, 整数型, , 服务句柄
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取客户端连接数, 整数型, , GetConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取连接的附加数据, 逻辑型, , 名称:GetConnectionExtra 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, 参考 , 数据指针
.子程序 获取连接的数据接收状态, 逻辑型, , IsPauseReceive
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 参考 , 返回 真- 暂停, 假- 恢复
.子程序 获取连接中未发出数据的长度, 逻辑型, , GetPendingDataLength
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 参考 ,
.子程序 获取某个客户端连接时长, 逻辑型, , GetConnectPeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取某个连接的本地地址信息, 逻辑型, , GetLocalAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接的远程地址信息, 逻辑型, , GetRemoteAddress
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, 参考 ,
.参数 pusPort, 整数型, 参考 ,
.子程序 获取某个连接静默时间, 逻辑型, , GetSilencePeriod(毫秒)
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 参考 ,
.子程序 获取内存块缓存池大小, 整数型, , GetFreeBufferObjPool
.参数 hServer, 整数型, , 服务句柄
.子程序 获取内存块缓存池回收阀值, 整数型, , GetFreeBufferObjHold
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据报文最大长度, 整数型, , GetMaxDatagramSize
.参数 hServer, 整数型, , 服务句柄
.子程序 获取数据发送策略, 整数型, , GetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.子程序 获取所有连接的HP_CONNID, 逻辑型, , 获取所有连接的 HP_CONNID
.参数 hServer, 整数型, , 服务句柄
.参数 pIDs, 整数型, 参考 数组, 参数请用空数组
.子程序 获取通信组件握手方式, 逻辑型, , IsSSLAutoHandShake
.参数 hServer, 整数型, ,
.子程序 获取心跳检查次数, 整数型, , GetDetectAttempts
.参数 hServer, 整数型, , 服务句柄
.子程序 获取心跳检查间隔, 整数型, , GetDetectInterval
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最大连接数, 整数型, , GetMaxConnectionCount
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误代码, 整数型, , GetLastError
.参数 hServer, 整数型, , 服务句柄
.子程序 获取最近一次失败操作的错误描述, 文本型, , GetLastErrorDesc
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否标记静默时间, 逻辑型, , IsMarkSilence
.参数 hServer, 整数型, , 服务句柄
.子程序 检测是否为安全连接, 逻辑型, , IsSecure(SSL/HTTPS)
.参数 hServer, 整数型, ,
.子程序 检测是否有效连接, 逻辑型, , IsConnected
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.子程序 检查通信组件是否已启动, 逻辑型, , HasStarted
.参数 hServer, 整数型, , 服务句柄
.子程序 启动SSL握手, 逻辑型, , 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.子程序 启动通信组件, 逻辑型, , 名称:Start 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 hServer, 整数型, , 服务句柄
.参数 pszBindAddress, 文本型, 可空 , 监听地址,为空默认:"0.0.0.0"
.参数 usPort, 整数型, , 监听端口
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.参数 hServer, 整数型, , 服务句柄
.子程序 设置OnSend事件同步策略, , , 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 hServer, 整数型, , 服务句柄
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.子程序 设置Receive预投递数量, , , 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 hServer, 整数型, , 服务句柄
.参数 dwPostReceiveCount, 整数型, , 投递数量
.子程序 设置Socket缓存池大小, , , 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjPool, 整数型, ,
.子程序 设置Socket缓存池回收阀值, , , 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置Socket缓存对象锁定时间, , , 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeSocketObjLockTime, 整数型, ,
.子程序 设置SSL加密算法列表, , , 设置 SSL 加密算法列表
.参数 hServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.子程序 设置工作线程数量, , , SetWorkerThreadCount(通常设置为 2 * CPU + 2)
.参数 hServer, 整数型, , 服务句柄
.参数 dwWorkerThreadCount, 整数型, ,
.子程序 设置监测包尝试次数, , , SetDetectAttempts(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectAttempts, 整数型, , 尝试次数
.子程序 设置监测包发送间隔, , , SetDetectInterval(秒,0 不发送监测包)
.参数 hServer, 整数型, , 服务句柄
.参数 dwDetectInterval, 整数型, , 间隔时间
.子程序 设置连接的附加数据, 逻辑型, , 名称:SetConnectionExtra 描述:是否为连接【可选】绑定附加数据或者【可选】绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 hServer, 整数型, , 服务句柄
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, , 数据指针
.子程序 设置内存块缓存池大小, , , SetFreeBufferObjPool(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjPool, 整数型, ,
.子程序 设置内存块缓存池回收阀值, , , SetFreeBufferObjHold(通常设置为内存块缓存池大小的 3 倍)
.参数 hServer, 整数型, , 服务句柄
.参数 dwFreeBufferObjHold, 整数型, ,
.子程序 设置是否标记静默时间, , , SetMarkSilence(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 hServer, 整数型, , 服务句柄
.参数 bMarkSilence, 逻辑型, ,
.子程序 设置数据报文最大长度, , , SetMaxDatagramSize(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxDatagramSize, 整数型, , 最大长度
.子程序 设置数据发送策略, , , SetSendPolicy
.参数 hServer, 整数型, , 服务句柄
.参数 enSendPolicy, 整数型, ,
.子程序 设置通信组件握手方式, , , SetSSLAutoHandShake(默认:真,自动握手)
.参数 hServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.子程序 设置最大连接数, , , SetMaxConnectionCount(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 hServer, 整数型, , 服务句柄
.参数 dwMaxConnectionCount, 整数型, ,
.子程序 销毁HP_UdpServer或HP_SSLServer对象, , , 销毁 HP_UdpServer 或 HP_SSLServer 对象
.参数 hServer, 整数型, , 服务句柄
.子程序 销毁UdpServerListener对象, , , 销毁 UdpServerListener 对象
.子程序 暂停恢复某个连接的数据接收工作, 逻辑型, , 暂停/恢复某个连接的数据接收工作
.参数 hServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, , 真- 暂停, 假- 恢复
.子程序 增加SNI主机证书, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.子程序 增加SNI主机证书Ex, 整数型, , 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 hServer, 整数型, , 服务句柄
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.程序集 IWinHttp, , 公开
.子程序 CleanupSSLContext, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.子程序 Create, 逻辑型, , 创建对象,open自动创建
.子程序 Delete, , , 删除对象
.子程序 GetAllCookies, 逻辑型, , 获取所有 Cookie
.参数 lpCookies, TNVPair, 数组,
.子程序 GetAllResponseHeaders, 逻辑型, , 取得所有HTTP返回协议头
.参数 lpHeaders, TNVPair, 数组,
.子程序 GetConnectTimeout, 整数型, , 获取连接超时
.子程序 GetCookie, 文本型, , 获取指定Cookie
.参数 name, 文本型, ,
.子程序 GetExtra, 整数型, , 获取连接的附加数据
.子程序 GetRequestTimeout, 整数型, , 获取请求超时
.子程序 GetResponseHeader, 文本型, , 取得HTTP返回协议头
.参数 lpszName, 文本型, , 协议头
.子程序 OnBody, , , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnChunkComplete, , , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnChunkHeader, , , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 OnClose, , , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 OnHandShake, , , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 OnHeader, , , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 OnHeadersComplete, , , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageBegin, , , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 OnMessageComplete, , , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnParseError, , , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 OnPrepareConnect, , , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 OnReceive, , , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnSend, , , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnStatusLine, , , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 OnUpgrade, , , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 OnWSMessageBody, , , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 OnWSMessageComplete, , , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 OnWSMessageHeader, , , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 Open, 逻辑型, , 打开网页,规定时间内数据未接收完会超时中断。请
.参数 Method, 文本型, , 请求方式
.参数 Url, 文本型, ,
.子程序 ResponseBody, 字节集, , 获取响应体
.子程序 ResponseText, 文本型, , 获取响应体
.参数 utf8, 逻辑型, 可空 , utf8解码
.子程序 Send, 逻辑型, , 发送HTTP请求
.参数 boby, 字节集, 可空 , 提交数据,可以被省略
.子程序 SetConnectTimeout, , , 设置连接超时(毫秒,0:系统默认超时,默认:30000)
.参数 Timeout, 整数型, ,
.子程序 SetExtra, , , 设置连接的附加数据
.参数 pExtra, 整数型, ,
.子程序 SetRequestHeader, , , 添加 HTTP 协议头,重复添加为覆盖上一次数据
.参数 Header, 文本型, , 协议头
.参数 Value, 文本型, , 值
.子程序 SetRequestTimeout, , , 设置请求超时(毫秒,0:系统默认超时,默认:30000)
.参数 Timeout, 整数型, ,
.子程序 SetSocketBufferSize, , , 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 dwSocketBufferSize, 整数型, , 默认为4M
.子程序 SetupSSLContext, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 Status, 短整数, , 取状态码
.子程序 绑定_Chunked报文头事件, , , 【可选】绑定Chunked 报文头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkHeader(pSender 整数型,dwConnID 整数型,iLength 整数型)
.子程序 绑定_Chunked报文完成事件, , , 【可选】绑定Chunked 报文完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnChunkComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_WebSocket数据包体事件, , , 【可选】绑定WebSocket 数据包体事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_WebSocket数据包头事件, , , 【可选】绑定WebSocket 数据包头事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageHeader(pSender 整数型,dwConnID 整数型,bFinal 逻辑型,iReserved 字节型,iOperationCode 字节型,lpszMask(4数组) 字节型,ullBodyLen 长整数型)
.子程序 绑定_WebSocket数据包完成事件, , , 【可选】绑定WebSocket 数据包完成事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnWSMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_断开事件, , , 【可选】绑定断开事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnClose(pSender 整数型,dwConnID 整数型,enOperation(#SO_ 开头常量) 整数型,iErrorCode 整数型)
.子程序 绑定_发送事件, , , 【可选】绑定发送事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnSend(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_解析错误事件, , , 【必须】绑定解析错误事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnParseError(pSender 整数型,dwConnID 整数型,iErrorCode 整数型,lpszErrorDesc 文本型)
.子程序 绑定_开始解析事件, , , 【可选】绑定开始解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageBegin(pSender 整数型,dwConnID 整数型)
.子程序 绑定_请求体报文事件, , , : 【必须】绑定请求体报文事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnBody(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_请求头事件, , , 【可选】绑定请求头事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeader(pSender 整数型,dwConnID 整数型,lpszName 文本型,lpszValue 文本型)
.子程序 绑定_请求头完成事件, , , 【必须】绑定请求头完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnHeadersComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_升级协议事件, , , 【可选】绑定升级协议事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnUpgrade(pSender 整数型,dwConnID 整数型,enUpgradeType(#HUT_ 开头常量) 整数型)
.子程序 绑定_数据接收事件, , , 【必须】绑定数据接收事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnReceive(pSender 整数型,dwConnID 整数型,pData 整数型,iLength 整数型)
.子程序 绑定_完成解析事件, , , 【必须】绑定完成解析事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnMessageComplete(pSender 整数型,dwConnID 整数型)
.子程序 绑定_握手事件, , , 【可选】绑定握手事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnHandShake(pSender 整数型,dwConnID 整数型)
.子程序 绑定_状态行解析完成事件, , , 【可选】绑定状态行解析完成事件
.参数 fn, 子程序指针, , 返回 #HPR_ 开头常量 OnStatusLine(pSender 整数型,usStatusCode 短整数型,lpszDesc 文本型)
.子程序 绑定_准备连接事件, , , 【可选】绑定准备连接事件
.参数 fn, 子程序指针, , 返回 #HR_ 开头常量 OnPrepareConnect(pSender 整数型,soListen 整数型)
.子程序 初始化通信组件SSL环境参数, 逻辑型, , 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, 可空 , 证书文件
.参数 lpszPemKeyFile, 文本型, 可空 , 私钥文件
.参数 lpszKeyPasswod, 文本型, 可空 , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, 可空 , CA 证书文件或目录(单向验证或客户端可选)
.子程序 创建对象, 逻辑型, , Create,open自动创建
.子程序 打开网页, 逻辑型, , Open,规定时间内数据未接收完会超时中断。请
.参数 Method, 文本型, , 请求方式
.参数 Url, 文本型, ,
.子程序 发送HTTP请求, 逻辑型, , Send
.参数 boby, 字节集, 可空 , 提交数据,可以被省略
.子程序 获取连接超时, 整数型, , GetConnectTimeout
.子程序 获取连接的附加数据, 整数型, , GetExtra
.子程序 获取请求超时, 整数型, , GetRequestTimeout
.子程序 获取所有Cookie, 逻辑型, , 获取所有 Cookie
.参数 lpCookies, TNVPair, 数组,
.子程序 获取响应体, 文本型, , ResponseText
.参数 utf8, 逻辑型, 可空 , utf8解码
.子程序 获取响应体Body, 字节集, , ResponseBody
.子程序 获取指定Cookie, 文本型, , GetCookie
.参数 name, 文本型, ,
.子程序 清理通信组件SSL运行环境, , , 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/当要重新设置通信组件 SSL 环境参数时,需要先调用本方法清理原先的环境参数
.子程序 取得HTTP返回协议头, 文本型, , GetResponseHeader
.参数 lpszName, 文本型, , 协议头
.子程序 取得所有HTTP返回协议头, 逻辑型, , GetAllResponseHeaders
.参数 lpHeaders, TNVPair, 数组,
.子程序 取状态码, 短整数, , Status
.子程序 删除对象, , , Delete
.子程序 设置连接超时, , , SetConnectTimeout(毫秒,0:系统默认超时,默认:30000)
.参数 Timeout, 整数型, ,
.子程序 设置连接的附加数据, , , SetExtra
.参数 pExtra, 整数型, ,
.子程序 设置请求超时, , , SetRequestTimeout(毫秒,0:系统默认超时,默认:30000)
.参数 Timeout, 整数型, ,
.子程序 设置通信数据缓冲区大小, , , SetSocketBufferSize(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 dwSocketBufferSize, 整数型, , 默认为4M
.子程序 添加HTTP协议头重复添加为覆盖上一次数据, , , 添加 HTTP 协议头,重复添加为覆盖上一次数据
.参数 Header, 文本型, , 协议头
.参数 Value, 文本型, , 值
.DLL命令 Create_HP_HttpAgent, 整数型, "HPSocket4C.dll", "Create_HP_HttpAgent", 公开, 创建 HP_HttpAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_HttpAgentListener, 整数型, "HPSocket4C.dll", "Create_HP_HttpAgentListener", 公开, 创建 HP_HttpAgentListener 对象
.DLL命令 Create_HP_HttpClient, 整数型, "HPSocket4C.dll", "Create_HP_HttpClient", 公开, 创建 HP_HttpClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_HttpClientListener, 整数型, "HPSocket4C.dll", "Create_HP_HttpClientListener", 公开, 创建 HP_HttpClientListener 对象
.DLL命令 Create_HP_HttpsAgent, 整数型, "HPSocket4C.dll", "Create_HP_HttpsAgent", 公开, 创建 HP_HttpsAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_HttpsClient, 整数型, "HPSocket4C.dll", "Create_HP_HttpsClient", 公开, 创建 HP_HttpsClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_HttpServer, 整数型, "HPSocket4C.dll", "Create_HP_HttpServer", 公开, 创建 HP_HttpServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_HttpServerListener, 整数型, "HPSocket4C.dll", "Create_HP_HttpServerListener", 公开, 创建 HP_HttpServerListener 对象
.DLL命令 Create_HP_HttpsServer, 整数型, "HPSocket4C.dll", "Create_HP_HttpsServer", 公开, 创建 HP_HttpsServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_HttpsSyncClient, 整数型, "HPSocket4C.dll", "Create_HP_HttpsSyncClient", 公开, 创建 HP_HttpSyncClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_HttpSyncClient, 整数型, "HPSocket4C.dll", "Create_HP_HttpSyncClient", 公开, 创建 HP_HttpSyncClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SocketTaskObj, 整数型, "HPSocket4C.dll", "Create_HP_SocketTaskObj", 公开, 创建 TSocketTask 对象
.参数 fnTaskProc, 子程序指针, , 任务入口函数
.参数 pSender, 整数型, , 发起对象
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 数据缓冲区
.参数 iBuffLen, 整数型, , 数据缓冲区长度
.参数 enBuffType, 整数型, , 数据缓冲区类型#TBT_(默认:#TBT_COPY)
.参数 wParam, 整数型, , 自定义参数
.参数 lParam, 整数型, , 自定义参数
.DLL命令 Create_HP_SSLAgent, 整数型, "HPSocket4C.dll", "Create_HP_SSLAgent", 公开, 创建 HP_SSLAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLClient, 整数型, "HPSocket4C.dll", "Create_HP_SSLClient", 公开, 创建 HP_SSLClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLPackAgent, 整数型, "HPSocket4C.dll", "Create_HP_SSLPackAgent", 公开, 创建 HP_SSLPackAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLPackClient, 整数型, "HPSocket4C.dll", "Create_HP_SSLPackClient", 公开, 创建 HP_SSLPackClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLPackServer, 整数型, "HPSocket4C.dll", "Create_HP_SSLPackServer", 公开, 创建 HP_SSLPackServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLPullAgent, 整数型, "HPSocket4C.dll", "Create_HP_SSLPullAgent", 公开, 创建 HP_SSLPullAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLPullClient, 整数型, "HPSocket4C.dll", "Create_HP_SSLPullClient", 公开, 创建 HP_SSLPullClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLPullServer, 整数型, "HPSocket4C.dll", "Create_HP_SSLPullServer", 公开, 创建 HP_SSLPullServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_SSLServer, 整数型, "HPSocket4C.dll", "Create_HP_SSLServer", 公开, 创建 HP_SSLServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpAgent, 整数型, "HPSocket4C.dll", "Create_HP_TcpAgent", 公开, 创建 HP_TcpAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpAgentListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpAgentListener", 公开, 创建 HP_TcpAgentListener 对象
.DLL命令 Create_HP_TcpClient, 整数型, "HPSocket4C.dll", "Create_HP_TcpClient", 公开, 创建 HP_TcpClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpClientListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpClientListener", 公开, 创建 HP_TcpClientListener 对象
.DLL命令 Create_HP_TcpPackAgent, 整数型, "HPSocket4C.dll", "Create_HP_TcpPackAgent", 公开, 创建 HP_TcpPackAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpPackAgentListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpPackAgentListener", 公开, 创建 HP_TcpPackAgentListener 对象
.DLL命令 Create_HP_TcpPackClient, 整数型, "HPSocket4C.dll", "Create_HP_TcpPackClient", 公开, 创建 HP_TcpPackClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpPackClientListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpPackClientListener", 公开, 创建 HP_TcpPackClientListener 对象
.DLL命令 Create_HP_TcpPackServer, 整数型, "HPSocket4C.dll", "Create_HP_TcpPackServer", 公开, 创建 HP_TcpPackServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpPackServerListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpPackServerListener", 公开, 创建 HP_TcpPackServerListener 对象
.DLL命令 Create_HP_TcpPullAgent, 整数型, "HPSocket4C.dll", "Create_HP_TcpPullAgent", 公开, 创建 HP_TcpPullAgent 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpPullAgentListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpPullAgentListener", 公开, 创建 HP_TcpPullAgentListener 对象
.DLL命令 Create_HP_TcpPullClient, 整数型, "HPSocket4C.dll", "Create_HP_TcpPullClient", 公开, 创建 HP_TcpPullClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpPullClientListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpPullClientListener", 公开, 创建 HP_TcpPullClientListener 对象
.DLL命令 Create_HP_TcpPullServer, 整数型, "HPSocket4C.dll", "Create_HP_TcpPullServer", 公开, 创建 HP_TcpPullServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpPullServerListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpPullServerListener", 公开, 创建 HP_TcpPullServerListener 对象
.DLL命令 Create_HP_TcpServer, 整数型, "HPSocket4C.dll", "Create_HP_TcpServer", 公开, 创建 HP_TcpServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_TcpServerListener, 整数型, "HPSocket4C.dll", "Create_HP_TcpServerListener", 公开, 创建 HP_TcpServerListener 对象
.DLL命令 Create_HP_ThreadPool, 整数型, "HPSocket4C.dll", "Create_HP_ThreadPool", 公开, 创建 IHPThreadPool 对象
.DLL命令 Create_HP_UdpArqClient, 整数型, "HPSocket4C.dll", "Create_HP_UdpArqClient", 公开, 创建 HP_UdpArqClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_UdpArqClientListener, 整数型, "HPSocket4C.dll", "Create_HP_UdpArqClientListener", 公开, 创建 HP_UdpArqClientListener 对象
.DLL命令 Create_HP_UdpArqServer, 整数型, "HPSocket4C.dll", "Create_HP_UdpArqServer", 公开, 创建 HP_UdpArqServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_UdpArqServerListener, 整数型, "HPSocket4C.dll", "Create_HP_UdpArqServerListener", 公开, 创建 HP_UdpArqServerListener 对象
.DLL命令 Create_HP_UdpCast, 整数型, "HPSocket4C.dll", "Create_HP_UdpCast", 公开, 创建 HP_UdpCast 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_UdpCastListener, 整数型, "HPSocket4C.dll", "Create_HP_UdpCastListener", 公开, 创建 HP_UdpCastListener 对象
.DLL命令 Create_HP_UdpClient, 整数型, "HPSocket4C.dll", "Create_HP_UdpClient", 公开, 创建 HP_UdpClient 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_UdpClientListener, 整数型, "HPSocket4C.dll", "Create_HP_UdpClientListener", 公开, 创建 HP_UdpClientListener 对象
.DLL命令 Create_HP_UdpNode, 整数型, "HPSocket4C.dll", "Create_HP_UdpNode", 公开, 创建 HP_UdpNode 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_UdpNodeListener, 整数型, "HPSocket4C.dll", "Create_HP_UdpNodeListener", 公开, 创建 HP_UdpNodeListener 对象
.DLL命令 Create_HP_UdpServer, 整数型, "HPSocket4C.dll", "Create_HP_UdpServer", 公开, 创建 HP_UdpServer 对象
.参数 pListener, 整数型, ,
.DLL命令 Create_HP_UdpServerListener, 整数型, "HPSocket4C.dll", "Create_HP_UdpServerListener", 公开, 创建 HP_UdpServerListener 对象
.DLL命令 Destroy_HP_HttpAgent, , "HPSocket4C.dll", "Destroy_HP_HttpAgent", 公开, 销毁 HP_HttpAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_HttpAgentListener, , "HPSocket4C.dll", "Destroy_HP_HttpAgentListener", 公开, 销毁 HP_HttpAgentListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_HttpClient, , "HPSocket4C.dll", "Destroy_HP_HttpClient", 公开, 销毁 HP_HttpClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_HttpClientListener, , "HPSocket4C.dll", "Destroy_HP_HttpClientListener", 公开, 销毁 HP_HttpClientListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_HttpsAgent, , "HPSocket4C.dll", "Destroy_HP_HttpsAgent", 公开, 销毁 HP_HttpsAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_HttpsClient, , "HPSocket4C.dll", "Destroy_HP_HttpsClient", 公开, 销毁 HP_HttpsClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_HttpServer, , "HPSocket4C.dll", "Destroy_HP_HttpServer", 公开, 销毁 HP_HttpServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_HttpServerListener, , "HPSocket4C.dll", "Destroy_HP_HttpServerListener", 公开, 销毁 HP_HttpServerListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_HttpsServer, , "HPSocket4C.dll", "Destroy_HP_HttpsServer", 公开, 销毁 HP_HttpsServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_HttpsSyncClient, , "HPSocket4C.dll", "Destroy_HP_HttpsSyncClient", 公开, 销毁 HP_HttpSyncClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_HttpSyncClient, , "HPSocket4C.dll", "Destroy_HP_HttpSyncClient", 公开, 销毁 HP_HttpSyncClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_SocketTaskObj, , "HPSocket4C.dll", "Destroy_HP_SocketTaskObj", 公开, 销毁 TSocketTask 对象
.参数 pTask, 整数型, ,
.DLL命令 Destroy_HP_SSLAgent, , "HPSocket4C.dll", "Destroy_HP_SSLAgent", 公开, 销毁 HP_SSLAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_SSLClient, , "HPSocket4C.dll", "Destroy_HP_SSLClient", 公开, 销毁 HP_SSLClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_SSLPackAgent, , "HPSocket4C.dll", "Destroy_HP_SSLPackAgent", 公开, 销毁 HP_SSLPackAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_SSLPackClient, , "HPSocket4C.dll", "Destroy_HP_SSLPackClient", 公开, 销毁 HP_SSLPackClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_SSLPackServer, , "HPSocket4C.dll", "Destroy_HP_SSLPackServer", 公开, 销毁 HP_SSLPackServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_SSLPullAgent, , "HPSocket4C.dll", "Destroy_HP_SSLPullAgent", 公开, 销毁 HP_SSLPullAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_SSLPullClient, , "HPSocket4C.dll", "Destroy_HP_SSLPullClient", 公开, 销毁 HP_SSLPullClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_SSLPullServer, , "HPSocket4C.dll", "Destroy_HP_SSLPullServer", 公开, 销毁 HP_SSLPullServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_SSLServer, , "HPSocket4C.dll", "Destroy_HP_SSLServer", 公开, 销毁 HP_SSLServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_TcpAgent, , "HPSocket4C.dll", "Destroy_HP_TcpAgent", 公开, 销毁 HP_TcpAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_TcpAgentListener, , "HPSocket4C.dll", "Destroy_HP_TcpAgentListener", 公开, 销毁 HP_TcpAgentListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpClient, , "HPSocket4C.dll", "Destroy_HP_TcpClient", 公开, 销毁 HP_TcpClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_TcpClientListener, , "HPSocket4C.dll", "Destroy_HP_TcpClientListener", 公开, 销毁 HP_TcpClientListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpPackAgent, , "HPSocket4C.dll", "Destroy_HP_TcpPackAgent", 公开, 销毁 HP_TcpPackAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_TcpPackAgentListener, , "HPSocket4C.dll", "Destroy_HP_TcpPackAgentListener", 公开, 销毁 HP_TcpPackAgentListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpPackClient, , "HPSocket4C.dll", "Destroy_HP_TcpPackClient", 公开, 销毁 HP_TcpPackClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_TcpPackClientListener, , "HPSocket4C.dll", "Destroy_HP_TcpPackClientListener", 公开, 销毁 HP_TcpPackClientListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpPackServer, , "HPSocket4C.dll", "Destroy_HP_TcpPackServer", 公开, 销毁 HP_TcpPackServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_TcpPackServerListener, , "HPSocket4C.dll", "Destroy_HP_TcpPackServerListener", 公开, 销毁 HP_TcpPackServerListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpPullAgent, , "HPSocket4C.dll", "Destroy_HP_TcpPullAgent", 公开, 销毁 HP_TcpPullAgent 对象
.参数 pAgent, 整数型, ,
.DLL命令 Destroy_HP_TcpPullAgentListener, , "HPSocket4C.dll", "Destroy_HP_TcpPullAgentListener", 公开, 销毁 HP_TcpPullAgentListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpPullClient, , "HPSocket4C.dll", "Destroy_HP_TcpPullClient", 公开, 销毁 HP_TcpPullClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_TcpPullClientListener, , "HPSocket4C.dll", "Destroy_HP_TcpPullClientListener", 公开, 销毁 HP_TcpPullClientListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpPullServer, , "HPSocket4C.dll", "Destroy_HP_TcpPullServer", 公开, 销毁 HP_TcpPullServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_TcpPullServerListener, , "HPSocket4C.dll", "Destroy_HP_TcpPullServerListener", 公开, 销毁 HP_TcpPullServerListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_TcpServer, , "HPSocket4C.dll", "Destroy_HP_TcpServer", 公开, 销毁 HP_TcpServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_TcpServerListener, , "HPSocket4C.dll", "Destroy_HP_TcpServerListener", 公开, 销毁 HP_TcpServerListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_ThreadPool, , "HPSocket4C.dll", "Destroy_HP_ThreadPool", 公开, 销毁 IHPThreadPool 对象
.参数 pThreadPool, 整数型, ,
.DLL命令 Destroy_HP_UdpArqClient, 整数型, "HPSocket4C.dll", "Destroy_HP_UdpArqClient", 公开, 销毁 HP_UdpArqClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_UdpArqClientListener, , "HPSocket4C.dll", "Destroy_HP_UdpArqClientListener", 公开, 销毁 HP_UdpArqClientListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_UdpArqServer, 整数型, "HPSocket4C.dll", "Destroy_HP_UdpArqServer", 公开, 销毁 HP_UdpArqServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_UdpArqServerListener, , "HPSocket4C.dll", "Destroy_HP_UdpArqServerListener", 公开, 销毁 HP_UdpArqServerListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_UdpCast, , "HPSocket4C.dll", "Destroy_HP_UdpCast", 公开, 销毁 HP_UdpCast 对象
.参数 pCast, 整数型, ,
.DLL命令 Destroy_HP_UdpCastListener, , "HPSocket4C.dll", "Destroy_HP_UdpCastListener", 公开, 销毁 HP_UdpCastListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_UdpClient, , "HPSocket4C.dll", "Destroy_HP_UdpClient", 公开, 销毁 HP_UdpClient 对象
.参数 pClient, 整数型, ,
.DLL命令 Destroy_HP_UdpClientListener, , "HPSocket4C.dll", "Destroy_HP_UdpClientListener", 公开, 销毁 HP_UdpClientListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_UdpNode, , "HPSocket4C.dll", "Destroy_HP_UdpNode", 公开, 销毁 HP_UdpNode 对象
.参数 pNode, 整数型, ,
.DLL命令 Destroy_HP_UdpNodeListener, , "HPSocket4C.dll", "Destroy_HP_UdpNodeListener", 公开, 销毁 HP_UdpNodeListener 对象
.参数 pListener, 整数型, ,
.DLL命令 Destroy_HP_UdpServer, , "HPSocket4C.dll", "Destroy_HP_UdpServer", 公开, 销毁 HP_UdpServer 对象
.参数 pServer, 整数型, ,
.DLL命令 Destroy_HP_UdpServerListener, , "HPSocket4C.dll", "Destroy_HP_UdpServerListener", 公开, 销毁 HP_UdpServerListener 对象
.参数 pListener, 整数型, ,
.DLL命令 free, , "crtdll.dll", "@free", 公开, 释放内存
.参数 block, 整数型, ,
.DLL命令 HP_Agent_Connect, 逻辑型, "HPSocket4C.dll", "HP_Agent_Connect", 公开, 名称:连接服务器 描述:连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件,TRUE-- 成功,FALSE-- 失败,可通过函数 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 传址 , 连接 ID(默认:nullptr,不获取连接 ID)
.DLL命令 HP_Agent_ConnectWithExtra, 逻辑型, "HPSocket4C.dll", "HP_Agent_ConnectWithExtra", 公开, 连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
.参数 pAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 传址 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, , 连接附加数据(默认:nullptr)
.DLL命令 HP_Agent_ConnectWithExtraAndLocalAddressPort, 逻辑型, "HPSocket4C.dll", "HP_Agent_ConnectWithExtraAndLocalAddressPort", 公开, 连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
.参数 pAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 传址 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 pExtra, 整数型, , 连接附加数据(默认:nullptr)
.参数 usLocalPort, 整数型, , 本地端口(默认:0)
.参数 lpszLocalAddress, 文本型, , 本地地址(默认:nullptr,使用 Start() 方法中绑定的地址)
.DLL命令 HP_Agent_ConnectWithExtraAndLocalPort, 逻辑型, "HPSocket4C.dll", "HP_Agent_ConnectWithExtraAndLocalPort", 公开, 连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
.参数 pAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 传址 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 usLocalPort, 整数型, , 本地端口(默认:0)
.DLL命令 HP_Agent_ConnectWithLocalAddress, 逻辑型, "HPSocket4C.dll", "HP_Agent_ConnectWithLocalAddress", 公开, 连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
.参数 pAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 传址 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 usLocalPort, 整数型, , 本地端口(默认:0)
.参数 lpszLocalAddress, 文本型, , 本地地址(默认:nullptr,使用 Start() 方法中绑定的地址)
.DLL命令 HP_Agent_ConnectWithLocalPort, 逻辑型, "HPSocket4C.dll", "HP_Agent_ConnectWithLocalPort", 公开, 连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
.参数 pAgent, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 pdwConnID, 整数型, 传址 , 连接 ID(默认:nullptr,不获取连接 ID)
.参数 usLocalPort, 整数型, , 本地端口(默认:0)
.DLL命令 HP_Agent_Disconnect, 逻辑型, "HPSocket4C.dll", "HP_Agent_Disconnect", 公开, 名称:断开连接 描述:断开某个连接,TRUE-- 成功,FALSE-- 失败,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.DLL命令 HP_Agent_DisconnectLongConnections, 逻辑型, "HPSocket4C.dll", "HP_Agent_DisconnectLongConnections", 公开, 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 pAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.DLL命令 HP_Agent_DisconnectSilenceConnections, 逻辑型, "HPSocket4C.dll", "HP_Agent_DisconnectSilenceConnections", 公开, 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 pAgent, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.DLL命令 HP_Agent_GetAllConnectionIDs, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetAllConnectionIDs", 公开, 获取所有连接的 HP_CONNID
.参数 pAgent, 整数型, ,
.参数 pIDs, 整数型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_Agent_GetConnectionCount, 整数型, "HPSocket4C.dll", "HP_Agent_GetConnectionCount", 公开, 获取连接数
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetConnectionExtra, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetConnectionExtra", 公开, 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 ppExtra, 整数型, 传址 ,
.DLL命令 HP_Agent_GetConnectPeriod, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetConnectPeriod", 公开, 获取某个连接时长(毫秒)
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 传址 ,
.DLL命令 HP_Agent_GetFreeBufferObjHold, 整数型, "HPSocket4C.dll", "HP_Agent_GetFreeBufferObjHold", 公开, 获取内存块缓存池回收阀值
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetFreeBufferObjPool, 整数型, "HPSocket4C.dll", "HP_Agent_GetFreeBufferObjPool", 公开, 获取内存块缓存池大小
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetFreeSocketObjHold, 整数型, "HPSocket4C.dll", "HP_Agent_GetFreeSocketObjHold", 公开, 获取 Socket 缓存池回收阀值
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetFreeSocketObjLockTime, 整数型, "HPSocket4C.dll", "HP_Agent_GetFreeSocketObjLockTime", 公开, 获取 Socket 缓存对象锁定时间
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetFreeSocketObjPool, 整数型, "HPSocket4C.dll", "HP_Agent_GetFreeSocketObjPool", 公开, 获取 Socket 缓存池大小
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetLastError, 整数型, "HPSocket4C.dll", "HP_Agent_GetLastError", 公开, 获取最近一次失败操作的错误代码
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetLastErrorDesc, 文本型, "HPSocket4C.dll", "HP_Agent_GetLastErrorDesc", 公开, 获取最近一次失败操作的错误描述
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetLocalAddress, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetLocalAddress", 公开, 获取某个连接的本地地址信息
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Agent_GetMaxConnectionCount, 整数型, "HPSocket4C.dll", "HP_Agent_GetMaxConnectionCount", 公开, 获取最大连接数
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetOnSendSyncPolicy, 整数型, "HPSocket4C.dll", "HP_Agent_GetOnSendSyncPolicy", 公开, 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetPendingDataLength, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetPendingDataLength", 公开, 获取连接中未发出数据的长度
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 传址 ,
.DLL命令 HP_Agent_GetRemoteAddress, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetRemoteAddress", 公开, 获取某个连接的远程地址信息
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Agent_GetRemoteHost, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetRemoteHost", 公开, 获取某个连接的远程主机信息
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, ,
.参数 piHostLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Agent_GetReuseAddressPolicy, 整数型, "HPSocket4C.dll", "HP_Agent_GetReuseAddressPolicy", 公开, 获取地址重用选项 #RAP_ 开头常量
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetSendPolicy, 整数型, "HPSocket4C.dll", "HP_Agent_GetSendPolicy", 公开, 获取数据发送策略
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetSilencePeriod, 逻辑型, "HPSocket4C.dll", "HP_Agent_GetSilencePeriod", 公开, 获取某个连接静默时间(毫秒)
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 传址 ,
.DLL命令 HP_Agent_GetState, 整数型, "HPSocket4C.dll", "HP_Agent_GetState", 公开, 查看通信组件当前状态
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_GetWorkerThreadCount, 整数型, "HPSocket4C.dll", "HP_Agent_GetWorkerThreadCount", 公开, 获取工作线程数量
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_HasStarted, 逻辑型, "HPSocket4C.dll", "HP_Agent_HasStarted", 公开, 检查通信组件是否已启动
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_IsConnected, 逻辑型, "HPSocket4C.dll", "HP_Agent_IsConnected", 公开, 检测是否有效连接
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.DLL命令 HP_Agent_IsMarkSilence, 逻辑型, "HPSocket4C.dll", "HP_Agent_IsMarkSilence", 公开, 检测是否标记静默时间
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_IsPauseReceive, 逻辑型, "HPSocket4C.dll", "HP_Agent_IsPauseReceive", 公开, 获取连接的数据接收状态
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 传址 , 返回 真- 暂停, 假- 恢复
.DLL命令 HP_Agent_IsSecure, 逻辑型, "HPSocket4C.dll", "HP_Agent_IsSecure", 公开, 检测是否为安全连接(SSL/HTTPS)
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_PauseReceive, 逻辑型, "HPSocket4C.dll", "HP_Agent_PauseReceive", 公开, 暂停/恢复某个连接的数据接收工作
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bPause, 逻辑型, , 真- 暂停, 假- 恢复
.DLL命令 HP_Agent_Send, 逻辑型, "HPSocket4C.dll", "HP_Agent_Send", 公开, 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.DLL命令 HP_Agent_SendPackets, 逻辑型, "HPSocket4C.dll", "HP_Agent_SendPackets", 公开, 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffers, WSABUF, 传址 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.DLL命令 HP_Agent_SendPart, 逻辑型, "HPSocket4C.dll", "HP_Agent_SendPart", 公开, 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.DLL命令 HP_Agent_SetConnectionExtra, 逻辑型, "HPSocket4C.dll", "HP_Agent_SetConnectionExtra", 公开, 名称:设置连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, ,
.DLL命令 HP_Agent_SetFreeBufferObjHold, , "HPSocket4C.dll", "HP_Agent_SetFreeBufferObjHold", 公开, 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 pAgent, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.DLL命令 HP_Agent_SetFreeBufferObjPool, , "HPSocket4C.dll", "HP_Agent_SetFreeBufferObjPool", 公开, 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 pAgent, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.DLL命令 HP_Agent_SetFreeSocketObjHold, , "HPSocket4C.dll", "HP_Agent_SetFreeSocketObjHold", 公开, 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 pAgent, 整数型, ,
.参数 dwFreeSocketObjHold, 整数型, ,
.DLL命令 HP_Agent_SetFreeSocketObjLockTime, , "HPSocket4C.dll", "HP_Agent_SetFreeSocketObjLockTime", 公开, 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 pAgent, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.DLL命令 HP_Agent_SetFreeSocketObjPool, , "HPSocket4C.dll", "HP_Agent_SetFreeSocketObjPool", 公开, 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 pAgent, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.DLL命令 HP_Agent_SetMarkSilence, , "HPSocket4C.dll", "HP_Agent_SetMarkSilence", 公开, 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 pAgent, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.DLL命令 HP_Agent_SetMaxConnectionCount, , "HPSocket4C.dll", "HP_Agent_SetMaxConnectionCount", 公开, 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 pAgent, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.DLL命令 HP_Agent_SetOnSendSyncPolicy, , "HPSocket4C.dll", "HP_Agent_SetOnSendSyncPolicy", 公开, 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 pAgent, 整数型, ,
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.DLL命令 HP_Agent_SetReuseAddressPolicy, , "HPSocket4C.dll", "HP_Agent_SetReuseAddressPolicy", 公开, 设置地址重用选项
.参数 pAgent, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.DLL命令 HP_Agent_SetSendPolicy, , "HPSocket4C.dll", "HP_Agent_SetSendPolicy", 公开, 设置数据发送策略
.参数 pAgent, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.DLL命令 HP_Agent_SetWorkerThreadCount, , "HPSocket4C.dll", "HP_Agent_SetWorkerThreadCount", 公开, 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 pAgent, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.DLL命令 HP_Agent_Start, 逻辑型, "HPSocket4C.dll", "HP_Agent_Start", 公开, 名称:启动通信组件 描述:启动通信代理组件,启动完成后可开始连接远程服务器,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 pAgent, 整数型, ,
.参数 lpszBindAddress, 文本型, , 绑定地址(默认:nullptr,绑定 0.0.0.0)
.参数 bAsyncConnect, 逻辑型, , 是否采用异步 Connect
.DLL命令 HP_Agent_Stop, 逻辑型, "HPSocket4C.dll", "HP_Agent_Stop", 公开, 名称:关闭通信组件 描述:关闭通信组件,关闭完成后断开所有连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Agent_GetLastError() 获取错误代码,/
.参数 pAgent, 整数型, ,
.DLL命令 HP_Agent_Wait, 逻辑型, "HPSocket4C.dll", "HP_Agent_Wait", 公开, 名称:等待 描述:等待通信组件停止运行
.参数 pAgent, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.DLL命令 HP_Client_GetConnectionID, 整数型, "HPSocket4C.dll", "HP_Client_GetConnectionID", 公开, 获取该组件对象的连接 ID
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_GetExtra, 整数型, "HPSocket4C.dll", "HP_Client_GetExtra", 公开, 获取连接的附加数据
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_GetFreeBufferPoolHold, 整数型, "HPSocket4C.dll", "HP_Client_GetFreeBufferPoolHold", 公开, 获取内存块缓存池回收阀值
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_GetFreeBufferPoolSize, 整数型, "HPSocket4C.dll", "HP_Client_GetFreeBufferPoolSize", 公开, 获取内存块缓存池大小
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_GetLastError, 整数型, "HPSocket4C.dll", "HP_Client_GetLastError", 公开, 获取最近一次失败操作的错误代码
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_GetLastErrorDesc, 文本型, "HPSocket4C.dll", "HP_Client_GetLastErrorDesc", 公开, 获取最近一次失败操作的错误描述
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_GetLocalAddress, 逻辑型, "HPSocket4C.dll", "HP_Client_GetLocalAddress", 公开, 获取 Client Socket 的地址信息
.参数 pClient, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Client_GetPendingDataLength, 逻辑型, "HPSocket4C.dll", "HP_Client_GetPendingDataLength", 公开, 获取连接中未发出数据的长度
.参数 pClient, 整数型, ,
.参数 piPending, 整数型, 传址 ,
.DLL命令 HP_Client_GetRemoteHost, 逻辑型, "HPSocket4C.dll", "HP_Client_GetRemoteHost", 公开, 获取连接的远程主机信息
.参数 pClient, 整数型, ,
.参数 lpszHost, 文本型, ,
.参数 piHostLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Client_GetReuseAddressPolicy, 整数型, "HPSocket4C.dll", "HP_Client_GetReuseAddressPolicy", 公开, 获取地址重用选项 #RAP_ 开头常量
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_GetState, 整数型, "HPSocket4C.dll", "HP_Client_GetState", 公开, 查看通信组件当前状态
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_HasStarted, 逻辑型, "HPSocket4C.dll", "HP_Client_HasStarted", 公开, 检查通信组件是否已启动
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_IsConnected, 逻辑型, "HPSocket4C.dll", "HP_Client_IsConnected", 公开, 检测是否有效连接
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_IsPauseReceive, 逻辑型, "HPSocket4C.dll", "HP_Client_IsPauseReceive", 公开, 获取连接的数据接收状态
.参数 pClient, 整数型, ,
.参数 pbPaused, 逻辑型, 传址 , 返回 真- 暂停, 假- 恢复
.DLL命令 HP_Client_IsSecure, 逻辑型, "HPSocket4C.dll", "HP_Client_IsSecure", 公开, 检测是否为安全连接(SSL/HTTPS)
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_PauseReceive, 逻辑型, "HPSocket4C.dll", "HP_Client_PauseReceive", 公开, 暂停/恢复某个连接的数据接收工作
.参数 pClient, 整数型, ,
.参数 bPause, 逻辑型, , 真- 暂停, 假- 恢复
.DLL命令 HP_Client_Send, 逻辑型, "HPSocket4C.dll", "HP_Client_Send", 公开, 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.DLL命令 HP_Client_SendPackets, 逻辑型, "HPSocket4C.dll", "HP_Client_SendPackets", 公开, 名称:发送多组数据 描述:向服务端发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pClient, 整数型, ,
.参数 pBuffers, WSABUF, 传址 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.DLL命令 HP_Client_SendPart, 逻辑型, "HPSocket4C.dll", "HP_Client_SendPart", 公开, 名称:发送数据 描述:向服务端发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pClient, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.DLL命令 HP_Client_SetExtra, , "HPSocket4C.dll", "HP_Client_SetExtra", 公开, 设置连接的附加数据
.参数 pClient, 整数型, ,
.参数 pExtra, 整数型, ,
.DLL命令 HP_Client_SetFreeBufferPoolHold, , "HPSocket4C.dll", "HP_Client_SetFreeBufferPoolHold", 公开, 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 pClient, 整数型, ,
.参数 dwFreeBufferPoolHold, 整数型, ,
.DLL命令 HP_Client_SetFreeBufferPoolSize, , "HPSocket4C.dll", "HP_Client_SetFreeBufferPoolSize", 公开, 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 )
.参数 pClient, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.DLL命令 HP_Client_SetReuseAddressPolicy, , "HPSocket4C.dll", "HP_Client_SetReuseAddressPolicy", 公开, 设置地址重用选项
.参数 pClient, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.DLL命令 HP_Client_Start, 逻辑型, "HPSocket4C.dll", "HP_Client_Start", 公开, 名称:启动通信组件 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 pClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, , 是否采用异步 Connect
.DLL命令 HP_Client_StartWithBindAddress, 逻辑型, "HPSocket4C.dll", "HP_Client_StartWithBindAddress", 公开, 名称:启动通信组件(并指定绑定地址) 描述:启动客户端通信组件并连接服务端,启动完成后可开始收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 pClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.DLL命令 HP_Client_StartWithBindAddressAndLocalPort, 逻辑型, "HPSocket4C.dll", "HP_Client_StartWithBindAddressAndLocalPort", 公开, 启动客户端通信组件并连接服务端,启动完成后可开始收发数据。TRUE -- 成功,FALSE -- 失败,可通过 HP_Client_GetLastError() 获取错误代码
.参数 pClient, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 服务端地址
.参数 usPort, 短整数, , 服务端端口
.参数 bAsyncConnect, 逻辑型, , 是否采用异步 Connect
.参数 lpszBindAddress, 文本型, , 绑定地址(默认:nullptr,TcpClient/UdpClient -> 不执行绑定操作,UdpCast 绑定 -> 0.0.0.0)
.参数 usLocalPort, 整数型, , 本地端口(默认:0)
.DLL命令 HP_Client_Stop, 逻辑型, "HPSocket4C.dll", "HP_Client_Stop", 公开, 名称:关闭通信组件 描述:关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Client_GetLastError() 获取错误代码,/
.参数 pClient, 整数型, ,
.DLL命令 HP_Client_Wait, 逻辑型, "HPSocket4C.dll", "HP_Client_Wait", 公开, 名称:等待 描述:等待通信组件停止运行
.参数 pClient, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.DLL命令 HP_GetHPSocketVersion, 整数型, "HPSocket4C.dll", "HP_GetHPSocketVersion", 公开, 获取 HPSocket 版本号(4 个字节分别为:主版本号,子版本号,修正版本号,构建编号)
.DLL命令 HP_GetSocketErrorDesc, 文本型, "HPSocket4C.dll", "HP_GetSocketErrorDesc", 公开, 获取错误描述文本
.参数 enCode, 整数型, ,
.DLL命令 HP_HttpAgent_GetAllCookies, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_GetAllCookies", 公开, 获取所有 Cookie
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpCookies, TNVPair, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpAgent_GetAllHeaderNames, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_GetAllHeaderNames", 公开, 获取所有请求头名称
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpAgent_GetAllHeaders, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_GetAllHeaders", 公开, 获取所有请求头
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpAgent_GetContentEncoding, 文本型, "HPSocket4C.dll", "HP_HttpAgent_GetContentEncoding", 公开, 获取内容编码
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_GetContentLength, 长整数型, "HPSocket4C.dll", "HP_HttpAgent_GetContentLength", 公开, 获取内容长度
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_GetContentType, 文本型, "HPSocket4C.dll", "HP_HttpAgent_GetContentType", 公开, 获取内容类型
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_GetCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_GetCookie", 公开, 获取 Cookie
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 整数型, 传址 ,
.DLL命令 HP_HttpAgent_GetHeader, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_GetHeader", 公开, 获取某个请求头(单值)
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 整数型, 传址 ,
.DLL命令 HP_HttpAgent_GetHeaders, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_GetHeaders", 公开, 获取某个请求头(多值)
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpAgent_GetLocalVersion, 整数型, "HPSocket4C.dll", "HP_HttpAgent_GetLocalVersion", 公开, 获取本地协议版本
.参数 pAgent, 整数型, ,
.DLL命令 HP_HttpAgent_GetParseErrorCode, 短整数, "HPSocket4C.dll", "HP_HttpAgent_GetParseErrorCode", 公开, 获取解析错误代码
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszErrorDesc, 整数型, 传址 ,
.DLL命令 HP_HttpAgent_GetStatusCode, 短整数, "HPSocket4C.dll", "HP_HttpAgent_GetStatusCode", 公开, 获取 HTTP 状态码
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_GetTransferEncoding, 文本型, "HPSocket4C.dll", "HP_HttpAgent_GetTransferEncoding", 公开, 获取传输编码
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_GetUpgradeType, 整数型, "HPSocket4C.dll", "HP_HttpAgent_GetUpgradeType", 公开, 获取协议升级类型
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_GetVersion, 短整数, "HPSocket4C.dll", "HP_HttpAgent_GetVersion", 公开, 获取协议版本
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_GetWSMessageState, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_GetWSMessageState", 公开, 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpbFinal, 逻辑型, 传址 ,
.参数 lpiReserved, 字节型, 传址 ,
.参数 lpiOperationCode, 字节型, 传址 ,
.参数 lpszMask, 整数型, 传址 ,
.参数 lpullBodyLen, 长整数型, 传址 ,
.参数 lpullBodyRemain, 长整数型, 传址 ,
.DLL命令 HP_HttpAgent_IsHttpAutoStart, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_IsHttpAutoStart", 公开, 获取 HTTP 启动方式
.参数 pAgent, 整数型, ,
.DLL命令 HP_HttpAgent_IsKeepAlive, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_IsKeepAlive", 公开, 检查是否有 Keep-Alive 标识
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_IsUpgrade, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_IsUpgrade", 公开, 检查是否升级协议
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpAgent_IsUseCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_IsUseCookie", 公开, 检查是否使用 Cookie
.参数 pAgent, 整数型, ,
.DLL命令 HP_HttpAgent_SendChunkData, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendChunkData", 公开, 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, , 扩展属性(默认:nullptr)
.DLL命令 HP_HttpAgent_SendConnect, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendConnect", 公开, 发送 CONNECT 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszHost, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpAgent_SendDelete, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendDelete", 公开, 发送 DELETE 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpAgent_SendGet, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendGet", 公开, 发送 GET 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpAgent_SendHead, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendHead", 公开, 发送 HEAD 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpAgent_SendLocalFile, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendLocalFile", 公开, 名称:发送本地文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 传址 数组, 请求头
.参数 iHeaderCount, 整数型, , 请求头数量
.DLL命令 HP_HttpAgent_SendOptions, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendOptions", 公开, 发送 OPTIONS 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpAgent_SendPatch, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendPatch", 公开, 发送 PATCH 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.参数 pBody, 字节集, ,
.参数 iLength, 整数型, ,
.DLL命令 HP_HttpAgent_SendPost, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendPost", 公开, 发送 POST 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.参数 pBody, 字节集, ,
.参数 iLength, 整数型, ,
.DLL命令 HP_HttpAgent_SendPut, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendPut", 公开, 发送 PUT 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.参数 pBody, 字节集, ,
.参数 iLength, 整数型, ,
.DLL命令 HP_HttpAgent_SendRequest, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendRequest", 公开, 名称:发送请求 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 传址 数组, 请求头
.参数 iHeaderCount, 整数型, , 请求头数量
.参数 pData, 字节集, ,
.参数 iLength, 整数型, , 请求体长度
.DLL命令 HP_HttpAgent_SendTrace, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendTrace", 公开, 发送 TRACE 请求
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpAgent_SendWSMessage, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_SendWSMessage", 公开, 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, , 消息体数据缓冲区
.参数 iLength, 整数型, , 消息体数据长度
.参数 ullBodyLen, 长整数型, , 消息总长度
.DLL命令 HP_HttpAgent_SetHttpAutoStart, , "HPSocket4C.dll", "HP_HttpAgent_SetHttpAutoStart", 公开, 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 pAgent, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.DLL命令 HP_HttpAgent_SetLocalVersion, , "HPSocket4C.dll", "HP_HttpAgent_SetLocalVersion", 公开, 设置本地协议版本
.参数 pAgent, 整数型, ,
.参数 usVersion, 整数型, ,
.DLL命令 HP_HttpAgent_SetUseCookie, , "HPSocket4C.dll", "HP_HttpAgent_SetUseCookie", 公开, 设置是否使用 Cookie
.参数 pAgent, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.DLL命令 HP_HttpAgent_StartHttp, 逻辑型, "HPSocket4C.dll", "HP_HttpAgent_StartHttp", 公开, 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接ID
.DLL命令 HP_HttpClient_GetAllCookies, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_GetAllCookies", 公开, 获取所有 Cookie
.参数 pClient, 整数型, ,
.参数 lpCookies, TNVPair, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpClient_GetAllHeaderNames, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_GetAllHeaderNames", 公开, 获取所有请求头名称
.参数 pClient, 整数型, ,
.参数 lpszName, 文本型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpClient_GetAllHeaders, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_GetAllHeaders", 公开, 获取所有请求头
.参数 pClient, 整数型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpClient_GetContentEncoding, 文本型, "HPSocket4C.dll", "HP_HttpClient_GetContentEncoding", 公开, 获取内容编码
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetContentLength, 长整数型, "HPSocket4C.dll", "HP_HttpClient_GetContentLength", 公开, 获取内容长度
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetContentType, 文本型, "HPSocket4C.dll", "HP_HttpClient_GetContentType", 公开, 获取内容类型
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_GetCookie", 公开, 获取 Cookie
.参数 pClient, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 整数型, 传址 ,
.DLL命令 HP_HttpClient_GetHeader, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_GetHeader", 公开, 获取某个请求头(单值)
.参数 pClient, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 整数型, 传址 ,
.DLL命令 HP_HttpClient_GetHeaders, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_GetHeaders", 公开, 获取某个请求头(多值)
.参数 pClient, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpClient_GetLocalVersion, 整数型, "HPSocket4C.dll", "HP_HttpClient_GetLocalVersion", 公开, 获取本地协议版本
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetParseErrorCode, 短整数, "HPSocket4C.dll", "HP_HttpClient_GetParseErrorCode", 公开, 获取解析错误代码
.参数 pClient, 整数型, ,
.参数 lpszErrorDesc, 整数型, 传址 ,
.DLL命令 HP_HttpClient_GetStatusCode, 短整数, "HPSocket4C.dll", "HP_HttpClient_GetStatusCode", 公开, 获取 HTTP 状态码
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetTransferEncoding, 文本型, "HPSocket4C.dll", "HP_HttpClient_GetTransferEncoding", 公开, 获取传输编码
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetUpgradeType, 整数型, "HPSocket4C.dll", "HP_HttpClient_GetUpgradeType", 公开, 获取协议升级类型
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetVersion, 短整数, "HPSocket4C.dll", "HP_HttpClient_GetVersion", 公开, 获取协议版本
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_GetWSMessageState, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_GetWSMessageState", 公开, 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 pClient, 整数型, ,
.参数 lpbFinal, 逻辑型, 传址 ,
.参数 lpiReserved, 字节型, 传址 ,
.参数 lpiOperationCode, 字节型, 传址 ,
.参数 lpszMask, 整数型, 传址 ,
.参数 lpullBodyLen, 长整数型, 传址 ,
.参数 lpullBodyRemain, 长整数型, 传址 ,
.DLL命令 HP_HttpClient_IsHttpAutoStart, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_IsHttpAutoStart", 公开, 获取 HTTP 启动方式
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_IsKeepAlive, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_IsKeepAlive", 公开, 检查是否有 Keep-Alive 标识
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_IsUpgrade, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_IsUpgrade", 公开, 检查是否升级协议
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_IsUseCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_IsUseCookie", 公开, 检查是否使用 Cookie
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpClient_SendChunkData, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendChunkData", 公开, 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 pClient, 整数型, ,
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, , 扩展属性(默认:nullptr)
.DLL命令 HP_HttpClient_SendConnect, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendConnect", 公开, 发送 CONNECT 请求
.参数 pClient, 整数型, ,
.参数 lpszHost, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpClient_SendDelete, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendDelete", 公开, 发送 DELETE 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpClient_SendGet, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendGet", 公开, 发送 GET 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpClient_SendHead, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendHead", 公开, 发送 HEAD 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpClient_SendLocalFile, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendLocalFile", 公开, 名称:发送本地文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 pClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 传址 数组, 请求头
.参数 iHeaderCount, 整数型, , 请求头数量
.DLL命令 HP_HttpClient_SendOptions, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendOptions", 公开, 发送 OPTIONS 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpClient_SendPatch, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendPatch", 公开, 发送 PATCH 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.参数 pBody, 字节集, ,
.参数 iLength, 整数型, ,
.DLL命令 HP_HttpClient_SendPost, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendPost", 公开, 发送 POST 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.参数 pBody, 字节集, ,
.参数 iLength, 整数型, ,
.DLL命令 HP_HttpClient_SendPut, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendPut", 公开, 发送 PUT 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.参数 pBody, 字节集, ,
.参数 iLength, 整数型, ,
.DLL命令 HP_HttpClient_SendRequest, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendRequest", 公开, 名称:发送请求 描述:向服务端发送 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 pClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszPath, 文本型, , 请求路径
.参数 lpHeaders, TNVPair, 传址 数组, 请求头
.参数 iHeaderCount, 整数型, , 请求头数量
.参数 pBody, 字节集, , 请求体
.参数 iLength, 整数型, , 请求体长度
.DLL命令 HP_HttpClient_SendTrace, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendTrace", 公开, 发送 TRACE 请求
.参数 pClient, 整数型, ,
.参数 lpszPath, 文本型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 iHeaderCount, 整数型, ,
.DLL命令 HP_HttpClient_SendWSMessage, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_SendWSMessage", 公开, 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 pClient, 整数型, ,
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 lpszMask, 字节集, , 掩码(nullptr 或 4 字节掩码,如果为 nullptr 则没有掩码)
.参数 pData, 字节集, , 消息体数据缓冲区
.参数 iLength, 整数型, , 消息体数据长度
.参数 ullBodyLen, 长整数型, , 消息总长度
.DLL命令 HP_HttpClient_SetHttpAutoStart, , "HPSocket4C.dll", "HP_HttpClient_SetHttpAutoStart", 公开, 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 pClient, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.DLL命令 HP_HttpClient_SetLocalVersion, , "HPSocket4C.dll", "HP_HttpClient_SetLocalVersion", 公开, 设置本地协议版本
.参数 pClient, 整数型, ,
.参数 usVersion, 整数型, ,
.DLL命令 HP_HttpClient_SetUseCookie, , "HPSocket4C.dll", "HP_HttpClient_SetUseCookie", 公开, 设置是否使用 Cookie
.参数 pClient, 整数型, ,
.参数 bUseCookie, 逻辑型, ,
.DLL命令 HP_HttpClient_StartHttp, 逻辑型, "HPSocket4C.dll", "HP_HttpClient_StartHttp", 公开, 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpCookie_HLP_CurrentUTCTime, 长整数型, "HPSocket4C.dll", "HP_HttpCookie_HLP_CurrentUTCTime", 公开, 获取当前 UTC 时间
.DLL命令 HP_HttpCookie_HLP_ExpiresToMaxAge, 整数型, "HPSocket4C.dll", "HP_HttpCookie_HLP_ExpiresToMaxAge", 公开, expires -> Max-Age
.参数 tmExpires, 长整数型, ,
.DLL命令 HP_HttpCookie_HLP_MakeExpiresStr, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_HLP_MakeExpiresStr", 公开, 整数转换为 Cookie expires 字符串
.参数 lpszBuff, 文本型, ,
.参数 piBuffLen, 整数型, 传址 ,
.参数 tmExpires, 长整数型, ,
.DLL命令 HP_HttpCookie_HLP_MaxAgeToExpires, 长整数型, "HPSocket4C.dll", "HP_HttpCookie_HLP_MaxAgeToExpires", 公开, Max-Age -> expires
.参数 iMaxAge, 整数型, ,
.DLL命令 HP_HttpCookie_HLP_ParseExpires, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_HLP_ParseExpires", 公开, Cookie expires 字符串转换为整数
.参数 lpszExpires, 文本型, ,
.参数 ptmExpires, 长整数型, 传址 ,
.DLL命令 HP_HttpCookie_HLP_ToString, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_HLP_ToString", 公开, 生成 Cookie 字符串
.参数 lpszBuff, 文本型, ,
.参数 piBuffLen, 整数型, 传址 ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, ,
.参数 lpszDomain, 文本型, ,
.参数 lpszPath, 文本型, ,
.参数 iMaxAge, 整数型, ,
.参数 bHttpOnly, 逻辑型, ,
.参数 bSecure, 逻辑型, ,
.参数 enSameSite, 整数型, ,
.DLL命令 HP_HttpCookie_MGR_ClearCookies, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_MGR_ClearCookies", 公开, 清理 Cookie
.参数 lpszDomain, 文本型, ,
.参数 lpszPath, 文本型, ,
.DLL命令 HP_HttpCookie_MGR_DeleteCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_MGR_DeleteCookie", 公开, 删除 Cookie
.参数 lpszDomain, 文本型, , 域
.参数 lpszPath, 文本型, , 路径
.参数 lpszName, 文本型, , 名称
.DLL命令 HP_HttpCookie_MGR_IsEnableThirdPartyCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_MGR_IsEnableThirdPartyCookie", 公开, 检查是否允许第三方 Cookie
.DLL命令 HP_HttpCookie_MGR_LoadFromFile, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_MGR_LoadFromFile", 公开, 从文件加载 Cookie
.参数 lpszFile, 文本型, ,
.参数 bKeepExists, 逻辑型, ,
.DLL命令 HP_HttpCookie_MGR_RemoveExpiredCookies, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_MGR_RemoveExpiredCookies", 公开, 清理过期 Cookie
.参数 lpszDomain, 文本型, ,
.参数 lpszPath, 文本型, ,
.DLL命令 HP_HttpCookie_MGR_SaveToFile, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_MGR_SaveToFile", 公开, 保存 Cookie 到文件
.参数 lpszFile, 文本型, ,
.参数 bKeepExists, 逻辑型, ,
.DLL命令 HP_HttpCookie_MGR_SetCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpCookie_MGR_SetCookie", 公开, 设置 Cookie
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, ,
.参数 lpszDomain, 文本型, ,
.参数 lpszPath, 文本型, ,
.参数 iMaxAge, 整数型, ,
.参数 bHttpOnly, 逻辑型, ,
.参数 bSecure, 逻辑型, ,
.参数 enSameSite, 整数型, ,
.参数 bOnlyUpdateValueIfExists, 逻辑型, ,
.DLL命令 HP_HttpCookie_MGR_SetEnableThirdPartyCookie, , "HPSocket4C.dll", "HP_HttpCookie_MGR_SetEnableThirdPartyCookie", 公开, 设置是否允许第三方 Cookie
.参数 bEnableThirdPartyCookie, 逻辑型, ,
.DLL命令 HP_HttpServer_GetAllCookies, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_GetAllCookies", 公开, 获取所有 Cookie
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpCookies, TNVPair, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpServer_GetAllHeaderNames, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_GetAllHeaderNames", 公开, 获取所有请求头名称
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpServer_GetAllHeaders, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_GetAllHeaders", 公开, 获取所有请求头
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpHeaders, TNVPair, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpServer_GetContentEncoding, 文本型, "HPSocket4C.dll", "HP_HttpServer_GetContentEncoding", 公开, 获取内容编码
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetContentLength, 长整数型, "HPSocket4C.dll", "HP_HttpServer_GetContentLength", 公开, 获取内容长度
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetContentType, 文本型, "HPSocket4C.dll", "HP_HttpServer_GetContentType", 公开, 获取内容类型
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetCookie, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_GetCookie", 公开, 获取 Cookie
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 整数型, 传址 ,
.DLL命令 HP_HttpServer_GetHeader, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_GetHeader", 公开, 获取某个请求头(单值)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 整数型, 传址 ,
.DLL命令 HP_HttpServer_GetHeaders, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_GetHeaders", 公开, 获取某个请求头(多值)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszName, 文本型, ,
.参数 lpszValue, 文本型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_HttpServer_GetHost, 文本型, "HPSocket4C.dll", "HP_HttpServer_GetHost", 公开, 获取主机
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetLocalVersion, 整数型, "HPSocket4C.dll", "HP_HttpServer_GetLocalVersion", 公开, 获取本地协议版本
.参数 pServer, 整数型, ,
.DLL命令 HP_HttpServer_GetMethod, 文本型, "HPSocket4C.dll", "HP_HttpServer_GetMethod", 公开, 获取请求方法
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetParseErrorCode, 短整数, "HPSocket4C.dll", "HP_HttpServer_GetParseErrorCode", 公开, 获取解析错误代码
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszErrorDesc, 整数型, 传址 ,
.DLL命令 HP_HttpServer_GetReleaseDelay, 整数型, "HPSocket4C.dll", "HP_HttpServer_GetReleaseDelay", 公开, 获取连接释放延时
.参数 pServer, 整数型, ,
.DLL命令 HP_HttpServer_GetTransferEncoding, 文本型, "HPSocket4C.dll", "HP_HttpServer_GetTransferEncoding", 公开, 获取传输编码
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetUpgradeType, 整数型, "HPSocket4C.dll", "HP_HttpServer_GetUpgradeType", 公开, 获取协议升级类型
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetUrlField, 文本型, "HPSocket4C.dll", "HP_HttpServer_GetUrlField", 公开, 获取某个 URL 域值
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enField, 整数型, ,
.DLL命令 HP_HttpServer_GetUrlFieldSet, 短整数, "HPSocket4C.dll", "HP_HttpServer_GetUrlFieldSet", 公开, 获取请求行 URL 域掩码(URL 域参考:EnHttpUrlField)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetVersion, 短整数, "HPSocket4C.dll", "HP_HttpServer_GetVersion", 公开, 获取协议版本
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_GetWSMessageState, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_GetWSMessageState", 公开, 获取当前 WebSocket 消息状态,传入 nullptr 则不获取相应字段
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpbFinal, 逻辑型, 传址 ,
.参数 lpiReserved, 字节型, 传址 ,
.参数 lpiOperationCode, 字节型, 传址 ,
.参数 lpszMask, 整数型, 传址 ,
.参数 lpullBodyLen, 长整数型, 传址 ,
.参数 lpullBodyRemain, 长整数型, 传址 ,
.DLL命令 HP_HttpServer_IsHttpAutoStart, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_IsHttpAutoStart", 公开, 获取 HTTP 启动方式
.参数 pServer, 整数型, ,
.DLL命令 HP_HttpServer_IsKeepAlive, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_IsKeepAlive", 公开, 检查是否有 Keep-Alive 标识
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_IsUpgrade, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_IsUpgrade", 公开, 检查是否升级协议
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_HttpServer_Release, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_Release", 公开, 名称:释放连接 描述:把连接放入释放队列,等待某个时间(通过 SetReleaseDelay() 设置)关闭连接,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.DLL命令 HP_HttpServer_SendChunkData, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_SendChunkData", 公开, 名称:发送 Chunked 数据分片 描述:向对端发送 Chunked 数据分片
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 整数型, , Chunked 数据分片
.参数 iLength, 整数型, , 数据分片长度(为 0 表示结束分片)
.参数 lpszExtensions, 整数型, , 扩展属性(默认:nullptr)
.DLL命令 HP_HttpServer_SendLocalFile, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_SendLocalFile", 公开, 名称:发送本地文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, , HTTP 状态描述
.参数 lpHeaders, TNVPair, 传址 数组, 回复请求头
.参数 iHeaderCount, 整数型, , 回复请求头数量
.DLL命令 HP_HttpServer_SendResponse, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_SendResponse", 公开, 名称:回复请求 描述:向客户端回复 HTTP 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 usStatusCode, 短整数, , HTTP 状态码
.参数 lpszDesc, 文本型, , HTTP 状态描述
.参数 lpHeaders, TNVPair, 传址 数组, 回复请求头
.参数 iHeaderCount, 整数型, , 回复请求头数量
.参数 pData, 字节集, , 回复请求体
.参数 iLength, 整数型, , 回复请求体长度
.DLL命令 HP_HttpServer_SendWSMessage, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_SendWSMessage", 公开, 名称:发送 WebSocket 消息 描述:向对端端发送 WebSocket 消息,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bFinal, 逻辑型, , 是否结束帧
.参数 iReserved, 字节型, , RSV1/RSV2/RSV3 各 1 位
.参数 iOperationCode, 字节型, , 操作码:0x0 - 0xF
.参数 pData, 字节集, , 消息体数据缓冲区
.参数 iLength, 整数型, , 消息体数据长度
.参数 ullBodyLen, 长整数型, , 消息总长度
.DLL命令 HP_HttpServer_SetHttpAutoStart, , "HPSocket4C.dll", "HP_HttpServer_SetHttpAutoStart", 公开, 设置 HTTP 启动方式(默认:TRUE,自动启动)
.参数 pServer, 整数型, ,
.参数 bAutoStart, 逻辑型, ,
.DLL命令 HP_HttpServer_SetLocalVersion, , "HPSocket4C.dll", "HP_HttpServer_SetLocalVersion", 公开, 设置本地协议版本
.参数 pServer, 整数型, ,
.参数 usVersion, 整数型, ,
.DLL命令 HP_HttpServer_SetReleaseDelay, , "HPSocket4C.dll", "HP_HttpServer_SetReleaseDelay", 公开, 设置连接释放延时(默认:3000 毫秒)
.参数 pServer, 整数型, ,
.参数 dwReleaseDelay, 整数型, ,
.DLL命令 HP_HttpServer_StartHttp, 逻辑型, "HPSocket4C.dll", "HP_HttpServer_StartHttp", 公开, 启动 HTTP 通信,当通信组件设置为非自动启动 HTTP 通信时,需要调用本方法启动 HTTP 通信,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接ID
.DLL命令 HP_HttpSyncClient_CleanupRequestResult, 逻辑型, "HPSocket4C.dll", "HP_HttpSyncClient_CleanupRequestResult", 公开, 名称:清除请求结果 描述:清除上一次请求的响应头和响应体等结果信息(该方法会在每次发送请求前自动调用),TRUE-- 成功,FALSE-- 失败,/
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpSyncClient_GetConnectTimeout, 整数型, "HPSocket4C.dll", "HP_HttpSyncClient_GetConnectTimeout", 公开, 获取连接超时
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpSyncClient_GetRequestTimeout, 整数型, "HPSocket4C.dll", "HP_HttpSyncClient_GetRequestTimeout", 公开, 获取请求超时
.参数 pClient, 整数型, ,
.DLL命令 HP_HttpSyncClient_GetResponseBody, 逻辑型, "HPSocket4C.dll", "HP_HttpSyncClient_GetResponseBody", 公开, 获取响应体
.参数 pClient, 整数型, ,
.参数 lpszBody, 整数型, 传址 ,
.参数 piLength, 整数型, 传址 ,
.DLL命令 HP_HttpSyncClient_OpenUrl, 逻辑型, "HPSocket4C.dll", "HP_HttpSyncClient_OpenUrl", 公开, 名称:发送 URL 请求 描述:向服务端发送 HTTP URL 请求,TRUE-- 成功,FALSE-- 失败,/
.参数 pClient, 整数型, ,
.参数 lpszMethod, 文本型, , 请求方法
.参数 lpszUrl, 文本型, , 请求 URL
.参数 lpHeaders, TNVPair, 传址 数组, 请求头
.参数 iHeaderCount, 整数型, , 请求头数量
.参数 pBody, 字节集, , 请求体
.参数 iLength, 整数型, , 请求体长度
.参数 bForceReconnect, 逻辑型, , 强制重新连接(默认:FALSE,当请求 URL 的主机和端口与现有连接一致时,重用现有连接)
.DLL命令 HP_HttpSyncClient_SetConnectTimeout, , "HPSocket4C.dll", "HP_HttpSyncClient_SetConnectTimeout", 公开, 设置连接超时(毫秒,0:系统默认超时,默认:5000)
.参数 pClient, 整数型, ,
.参数 dwConnectTimeout, 整数型, ,
.DLL命令 HP_HttpSyncClient_SetRequestTimeout, , "HPSocket4C.dll", "HP_HttpSyncClient_SetRequestTimeout", 公开, 设置请求超时(毫秒,0:无限等待,默认:10000)
.参数 pClient, 整数型, ,
.参数 dwRequestTimeout, 整数型, ,
.DLL命令 HP_Server_Disconnect, 逻辑型, "HPSocket4C.dll", "HP_Server_Disconnect", 公开, 名称:断开连接 描述:断开与某个客户端的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bForce, 逻辑型, , 是否强制断开连接
.DLL命令 HP_Server_DisconnectLongConnections, 逻辑型, "HPSocket4C.dll", "HP_Server_DisconnectLongConnections", 公开, 名称:断开超时连接 描述:断开超过指定时长的连接,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.DLL命令 HP_Server_DisconnectSilenceConnections, 逻辑型, "HPSocket4C.dll", "HP_Server_DisconnectSilenceConnections", 公开, 名称:断开静默连接 描述:断开超过指定时长的静默连接,TRUE-- 成功,FALSE-- 失败,/
.参数 pServer, 整数型, ,
.参数 dwPeriod, 整数型, , 时长(毫秒)
.参数 bForce, 逻辑型, , 是否强制断开连接
.DLL命令 HP_Server_GetAllConnectionIDs, 逻辑型, "HPSocket4C.dll", "HP_Server_GetAllConnectionIDs", 公开, 获取所有连接的 HP_CONNID
.参数 pServer, 整数型, ,
.参数 pIDs, 整数型, 传址 数组,
.参数 pdwCount, 整数型, 传址 ,
.DLL命令 HP_Server_GetConnectionCount, 整数型, "HPSocket4C.dll", "HP_Server_GetConnectionCount", 公开, 获取客户端连接数
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetConnectionExtra, 逻辑型, "HPSocket4C.dll", "HP_Server_GetConnectionExtra", 公开, 名称:获取连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 ppExtra, 整数型, 传址 ,
.DLL命令 HP_Server_GetConnectPeriod, 逻辑型, "HPSocket4C.dll", "HP_Server_GetConnectPeriod", 公开, 获取某个客户端连接时长(毫秒)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 传址 ,
.DLL命令 HP_Server_GetFreeBufferObjHold, 整数型, "HPSocket4C.dll", "HP_Server_GetFreeBufferObjHold", 公开, 获取内存块缓存池回收阀值
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetFreeBufferObjPool, 整数型, "HPSocket4C.dll", "HP_Server_GetFreeBufferObjPool", 公开, 获取内存块缓存池大小
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetFreeSocketObjHold, 整数型, "HPSocket4C.dll", "HP_Server_GetFreeSocketObjHold", 公开, 获取 Socket 缓存池回收阀值
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetFreeSocketObjLockTime, 整数型, "HPSocket4C.dll", "HP_Server_GetFreeSocketObjLockTime", 公开, 获取 Socket 缓存对象锁定时间
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetFreeSocketObjPool, 整数型, "HPSocket4C.dll", "HP_Server_GetFreeSocketObjPool", 公开, 获取 Socket 缓存池大小
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetLastError, 整数型, "HPSocket4C.dll", "HP_Server_GetLastError", 公开, 获取最近一次失败操作的错误代码
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetLastErrorDesc, 文本型, "HPSocket4C.dll", "HP_Server_GetLastErrorDesc", 公开, 获取最近一次失败操作的错误描述
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetListenAddress, 逻辑型, "HPSocket4C.dll", "HP_Server_GetListenAddress", 公开, 获取监听 Socket 的地址信息
.参数 pServer, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Server_GetLocalAddress, 逻辑型, "HPSocket4C.dll", "HP_Server_GetLocalAddress", 公开, 获取某个连接的本地地址信息
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Server_GetMaxConnectionCount, 整数型, "HPSocket4C.dll", "HP_Server_GetMaxConnectionCount", 公开, 获取最大连接数
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetOnSendSyncPolicy, 整数型, "HPSocket4C.dll", "HP_Server_GetOnSendSyncPolicy", 公开, 获取 OnSend 事件同步策略,返回#OSSP_ 开头常量
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetPendingDataLength, 逻辑型, "HPSocket4C.dll", "HP_Server_GetPendingDataLength", 公开, 获取连接中未发出数据的长度
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piPending, 整数型, 传址 ,
.DLL命令 HP_Server_GetRemoteAddress, 逻辑型, "HPSocket4C.dll", "HP_Server_GetRemoteAddress", 公开, 获取某个连接的远程地址信息
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_Server_GetReuseAddressPolicy, 整数型, "HPSocket4C.dll", "HP_Server_GetReuseAddressPolicy", 公开, 获取地址重用选项 #RAP_ 开头常量
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetSendPolicy, 整数型, "HPSocket4C.dll", "HP_Server_GetSendPolicy", 公开, 获取数据发送策略
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetSilencePeriod, 逻辑型, "HPSocket4C.dll", "HP_Server_GetSilencePeriod", 公开, 获取某个连接静默时间(毫秒)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 pdwPeriod, 整数型, 传址 ,
.DLL命令 HP_Server_GetState, 整数型, "HPSocket4C.dll", "HP_Server_GetState", 公开, 查看通信组件当前状态
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_GetWorkerThreadCount, 整数型, "HPSocket4C.dll", "HP_Server_GetWorkerThreadCount", 公开, 获取工作线程数量
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_HasStarted, 逻辑型, "HPSocket4C.dll", "HP_Server_HasStarted", 公开, 检查通信组件是否已启动
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_IsConnected, 逻辑型, "HPSocket4C.dll", "HP_Server_IsConnected", 公开, 检测是否有效连接
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.DLL命令 HP_Server_IsMarkSilence, 逻辑型, "HPSocket4C.dll", "HP_Server_IsMarkSilence", 公开, 检测是否标记静默时间
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_IsPauseReceive, 逻辑型, "HPSocket4C.dll", "HP_Server_IsPauseReceive", 公开, 获取连接的数据接收状态
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pbPaused, 逻辑型, 传址 , 返回 真- 暂停, 假- 恢复
.DLL命令 HP_Server_IsSecure, 逻辑型, "HPSocket4C.dll", "HP_Server_IsSecure", 公开, 检测是否为安全连接(SSL/HTTPS)
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_PauseReceive, 逻辑型, "HPSocket4C.dll", "HP_Server_PauseReceive", 公开, 暂停/恢复某个连接的数据接收工作
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 bPause, 逻辑型, , 真- 暂停, 假- 恢复
.DLL命令 HP_Server_Send, 逻辑型, "HPSocket4C.dll", "HP_Server_Send", 公开, 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.DLL命令 HP_Server_SendPackets, 逻辑型, "HPSocket4C.dll", "HP_Server_SendPackets", 公开, 名称:发送多组数据 描述:向指定连接发送多组数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffers, WSABUF, 传址 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.DLL命令 HP_Server_SendPart, 逻辑型, "HPSocket4C.dll", "HP_Server_SendPart", 公开, 名称:发送数据 描述:向指定连接发送数据,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.DLL命令 HP_Server_SetConnectionExtra, 逻辑型, "HPSocket4C.dll", "HP_Server_SetConnectionExtra", 公开, 名称:设置连接的附加数据 描述:是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定,TRUE-- 成功,FALSE-- 失败(无效的连接 ID),/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pExtra, 整数型, ,
.DLL命令 HP_Server_SetFreeBufferObjHold, , "HPSocket4C.dll", "HP_Server_SetFreeBufferObjHold", 公开, 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍)
.参数 pServer, 整数型, ,
.参数 dwFreeBufferObjHold, 整数型, ,
.DLL命令 HP_Server_SetFreeBufferObjPool, , "HPSocket4C.dll", "HP_Server_SetFreeBufferObjPool", 公开, 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍)
.参数 pServer, 整数型, ,
.参数 dwFreeBufferObjPool, 整数型, ,
.DLL命令 HP_Server_SetFreeSocketObjHold, , "HPSocket4C.dll", "HP_Server_SetFreeSocketObjHold", 公开, 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍)
.参数 pServer, 整数型, ,
.参数 dwFreeSocketObjHold, 整数型, ,
.DLL命令 HP_Server_SetFreeSocketObjLockTime, , "HPSocket4C.dll", "HP_Server_SetFreeSocketObjLockTime", 公开, 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用)
.参数 pServer, 整数型, ,
.参数 dwFreeSocketObjLockTime, 整数型, ,
.DLL命令 HP_Server_SetFreeSocketObjPool, , "HPSocket4C.dll", "HP_Server_SetFreeSocketObjPool", 公开, 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2)
.参数 pServer, 整数型, ,
.参数 dwFreeSocketObjPool, 整数型, ,
.DLL命令 HP_Server_SetMarkSilence, , "HPSocket4C.dll", "HP_Server_SetMarkSilence", 公开, 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:TRUE)
.参数 pServer, 整数型, ,
.参数 bMarkSilence, 逻辑型, ,
.DLL命令 HP_Server_SetMaxConnectionCount, , "HPSocket4C.dll", "HP_Server_SetMaxConnectionCount", 公开, 设置最大连接数(组件会根据设置值预分配内存,因此需要根据实际情况设置,不宜过大)
.参数 pServer, 整数型, ,
.参数 dwMaxConnectionCount, 整数型, ,
.DLL命令 HP_Server_SetOnSendSyncPolicy, , "HPSocket4C.dll", "HP_Server_SetOnSendSyncPolicy", 公开, 设置 OnSend 事件同步策略(默认:#OSSP_NONE,不同步)
.参数 pServer, 整数型, ,
.参数 enSyncPolicy, 整数型, , #OSSP_ 开头常量
.DLL命令 HP_Server_SetReuseAddressPolicy, , "HPSocket4C.dll", "HP_Server_SetReuseAddressPolicy", 公开, 设置地址重用选项
.参数 pServer, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.DLL命令 HP_Server_SetSendPolicy, , "HPSocket4C.dll", "HP_Server_SetSendPolicy", 公开, 设置数据发送策略
.参数 pServer, 整数型, ,
.参数 enSendPolicy, 整数型, ,
.DLL命令 HP_Server_SetWorkerThreadCount, , "HPSocket4C.dll", "HP_Server_SetWorkerThreadCount", 公开, 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 pServer, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.DLL命令 HP_Server_Start, 逻辑型, "HPSocket4C.dll", "HP_Server_Start", 公开, 名称:启动通信组件 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 pServer, 整数型, ,
.参数 lpszBindAddress, 文本型, , 监听地址
.参数 usPort, 短整数, , 监听端口
.DLL命令 HP_Server_Stop, 逻辑型, "HPSocket4C.dll", "HP_Server_Stop", 公开, 名称:关闭通信组件 描述:关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源,TRUE-- 成功,FALSE-- 失败,可通过 HP_Server_GetLastError() 获取错误代码,/
.参数 pServer, 整数型, ,
.DLL命令 HP_Server_Wait, 逻辑型, "HPSocket4C.dll", "HP_Server_Wait", 公开, 名称:等待 描述:等待通信组件停止运行
.参数 pServer, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.DLL命令 HP_Set_FN_Agent_OnClose, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnClose", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Agent_OnConnect, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Agent_OnHandShake, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnHandShake", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Agent_OnPrepareConnect, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnPrepareConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Agent_OnPullReceive, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnPullReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Agent_OnReceive, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Agent_OnSend, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnSend", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Agent_OnShutdown, , "HPSocket4C.dll", "HP_Set_FN_Agent_OnShutdown", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Client_OnClose, , "HPSocket4C.dll", "HP_Set_FN_Client_OnClose", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Client_OnConnect, , "HPSocket4C.dll", "HP_Set_FN_Client_OnConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Client_OnHandShake, , "HPSocket4C.dll", "HP_Set_FN_Client_OnHandShake", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Client_OnPrepareConnect, , "HPSocket4C.dll", "HP_Set_FN_Client_OnPrepareConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Client_OnPullReceive, , "HPSocket4C.dll", "HP_Set_FN_Client_OnPullReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Client_OnReceive, , "HPSocket4C.dll", "HP_Set_FN_Client_OnReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Client_OnSend, , "HPSocket4C.dll", "HP_Set_FN_Client_OnSend", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnBody, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnBody", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnChunkComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnChunkComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnChunkHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnChunkHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnClose, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnClose", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnConnect, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnHandShake, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnHandShake", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnHeadersComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnHeadersComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnMessageBegin, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnMessageBegin", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnMessageComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnMessageComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnParseError, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnParseError", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnPrepareConnect, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnPrepareConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnReceive, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnSend, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnSend", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnShutdown, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnShutdown", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnStatusLine, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnStatusLine", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnUpgrade, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnUpgrade", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnWSMessageBody, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnWSMessageBody", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnWSMessageComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnWSMessageComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpAgent_OnWSMessageHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpAgent_OnWSMessageHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnBody, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnBody", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnChunkComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnChunkComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnChunkHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnChunkHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnClose, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnClose", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnConnect, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnHandShake, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnHandShake", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnHeadersComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnHeadersComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnMessageBegin, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnMessageBegin", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnMessageComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnMessageComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnParseError, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnParseError", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnPrepareConnect, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnPrepareConnect", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnReceive, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnSend, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnSend", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnStatusLine, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnStatusLine", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnUpgrade, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnUpgrade", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnWSMessageBody, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnWSMessageBody", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnWSMessageComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnWSMessageComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpClient_OnWSMessageHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpClient_OnWSMessageHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnAccept, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnAccept", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnBody, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnBody", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnChunkComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnChunkComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnChunkHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnChunkHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnClose, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnClose", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnHandShake, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnHandShake", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnHeadersComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnHeadersComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnMessageBegin, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnMessageBegin", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnMessageComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnMessageComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnParseError, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnParseError", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnPrepareListen, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnPrepareListen", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnReceive, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnRequestLine, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnRequestLine", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnSend, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnSend", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnShutdown, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnShutdown", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnUpgrade, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnUpgrade", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnWSMessageBody, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnWSMessageBody", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnWSMessageComplete, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnWSMessageComplete", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_HttpServer_OnWSMessageHeader, , "HPSocket4C.dll", "HP_Set_FN_HttpServer_OnWSMessageHeader", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnAccept, , "HPSocket4C.dll", "HP_Set_FN_Server_OnAccept", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnClose, , "HPSocket4C.dll", "HP_Set_FN_Server_OnClose", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnHandShake, , "HPSocket4C.dll", "HP_Set_FN_Server_OnHandShake", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnPrepareListen, , "HPSocket4C.dll", "HP_Set_FN_Server_OnPrepareListen", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnPullReceive, , "HPSocket4C.dll", "HP_Set_FN_Server_OnPullReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnReceive, , "HPSocket4C.dll", "HP_Set_FN_Server_OnReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnSend, , "HPSocket4C.dll", "HP_Set_FN_Server_OnSend", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_Server_OnShutdown, , "HPSocket4C.dll", "HP_Set_FN_Server_OnShutdown", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_UdpNode_OnError, , "HPSocket4C.dll", "HP_Set_FN_UdpNode_OnError", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_UdpNode_OnPrepareListen, , "HPSocket4C.dll", "HP_Set_FN_UdpNode_OnPrepareListen", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_UdpNode_OnReceive, , "HPSocket4C.dll", "HP_Set_FN_UdpNode_OnReceive", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_UdpNode_OnSend, , "HPSocket4C.dll", "HP_Set_FN_UdpNode_OnSend", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_Set_FN_UdpNode_OnShutdown, , "HPSocket4C.dll", "HP_Set_FN_UdpNode_OnShutdown", 公开,
.参数 pListener, 整数型, ,
.参数 fn, 子程序指针, ,
.DLL命令 HP_SSL_RemoveThreadLocalState, , "HPSocket4C.dll", "HP_SSL_RemoveThreadLocalState", 公开, 名称:清理线程局部环境 SSL 资源 描述:任何一个操作 SSL 的线程,通信结束时都需要清理线程局部环境 SSL 资源,无,/
.参数 dwThreadID, 整数型, , 线程 ID(0:当前线程)
.DLL命令 HP_SSLAgent_CleanupSSLContext, , "HPSocket4C.dll", "HP_SSLAgent_CleanupSSLContext", 公开, 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/
.参数 pAgent, 整数型, ,
.DLL命令 HP_SSLAgent_GetSSLCipherList, 文本型, "HPSocket4C.dll", "HP_SSLAgent_GetSSLCipherList", 公开, 获取 SSL 加密算法列表
.参数 pAgent, 整数型, ,
.DLL命令 HP_SSLAgent_GetSSLSessionInfo, 逻辑型, "HPSocket4C.dll", "HP_SSLAgent_GetSSLSessionInfo", 公开, 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 传址 ,
.DLL命令 HP_SSLAgent_IsSSLAutoHandShake, 逻辑型, "HPSocket4C.dll", "HP_SSLAgent_IsSSLAutoHandShake", 公开, 获取通信组件握手方式
.参数 pAgent, 整数型, ,
.DLL命令 HP_SSLAgent_SetSSLAutoHandShake, , "HPSocket4C.dll", "HP_SSLAgent_SetSSLAutoHandShake", 公开, 设置通信组件握手方式(默认:TRUE,自动握手)
.参数 pAgent, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.DLL命令 HP_SSLAgent_SetSSLCipherList, , "HPSocket4C.dll", "HP_SSLAgent_SetSSLCipherList", 公开, 设置 SSL 加密算法列表
.参数 pAgent, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.DLL命令 HP_SSLAgent_SetupSSLContext, 逻辑型, "HPSocket4C.dll", "HP_SSLAgent_SetupSSLContext", 公开, 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 pAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件(客户端可选)
.参数 lpszPemKeyFile, 文本型, , 私钥文件(客户端可选)
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证或客户端可选)
.DLL命令 HP_SSLAgent_SetupSSLContextByMemory, 逻辑型, "HPSocket4C.dll", "HP_SSLAgent_SetupSSLContextByMemory", 公开, 名称:初始化通信组件 SSL 环境参数(通过内存加载证书)描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
.参数 pAgent, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容(客户端可选)
.参数 lpszPemKey, 文本型, , 私钥内容(客户端可选)
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证或客户端可选)
.DLL命令 HP_SSLAgent_StartSSLHandShake, 逻辑型, "HPSocket4C.dll", "HP_SSLAgent_StartSSLHandShake", 公开, 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_SSLClient_CleanupSSLContext, , "HPSocket4C.dll", "HP_SSLClient_CleanupSSLContext", 公开, 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/
.参数 pClient, 整数型, ,
.DLL命令 HP_SSLClient_GetSSLCipherList, 文本型, "HPSocket4C.dll", "HP_SSLClient_GetSSLCipherList", 公开, 获取 SSL 加密算法列表
.参数 pClient, 整数型, ,
.DLL命令 HP_SSLClient_GetSSLSessionInfo, 逻辑型, "HPSocket4C.dll", "HP_SSLClient_GetSSLSessionInfo", 公开, 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pClient, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 传址 ,
.DLL命令 HP_SSLClient_IsSSLAutoHandShake, 逻辑型, "HPSocket4C.dll", "HP_SSLClient_IsSSLAutoHandShake", 公开, 获取通信组件握手方式
.参数 pClient, 整数型, ,
.DLL命令 HP_SSLClient_SetSSLAutoHandShake, , "HPSocket4C.dll", "HP_SSLClient_SetSSLAutoHandShake", 公开, 设置通信组件握手方式(默认:TRUE,自动握手)
.参数 pClient, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.DLL命令 HP_SSLClient_SetSSLCipherList, , "HPSocket4C.dll", "HP_SSLClient_SetSSLCipherList", 公开, 设置 SSL 加密算法列表
.参数 pClient, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.DLL命令 HP_SSLClient_SetupSSLContext, 逻辑型, "HPSocket4C.dll", "HP_SSLClient_SetupSSLContext", 公开, 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 pClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件(客户端可选)
.参数 lpszPemKeyFile, 文本型, , 私钥文件(客户端可选)
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证或客户端可选)
.DLL命令 HP_SSLClient_SetupSSLContextByMemory, 逻辑型, "HPSocket4C.dll", "HP_SSLClient_SetupSSLContextByMemory", 公开, 名称:初始化通信组件 SSL 环境参数(通过内存加载证书)描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
.参数 pClient, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容(客户端可选)
.参数 lpszPemKey, 文本型, , 私钥内容(客户端可选)
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证或客户端可选)
.DLL命令 HP_SSLClient_StartSSLHandShake, 逻辑型, "HPSocket4C.dll", "HP_SSLClient_StartSSLHandShake", 公开, 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 pClient, 整数型, ,
.DLL命令 HP_SSLServer_AddSSLContext, 整数型, "HPSocket4C.dll", "HP_SSLServer_AddSSLContext", 公开, 名称:增加 SNI 主机证书 描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书,正数-- 成功,并返回 SNI 主机证书对应的索引,该索引用于在 SNI 回调函数中定位 SNI 主机,负数-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 pServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证可选)
.DLL命令 HP_SSLServer_AddSSLContextByMemory, 整数型, "HPSocket4C.dll", "HP_SSLServer_AddSSLContextByMemory", 公开, 名称:增加 SNI 主机证书(通过内存加载证书)描述:SSL 服务端在 SetupSSLContext() 成功后可以调用本方法增加多个 SNI 主机证书
.参数 pServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.DLL命令 HP_SSLServer_BindSSLServerName, 逻辑型, "HPSocket4C.dll", "HP_SSLServer_BindSSLServerName", 公开, 名称:绑定 SNI 主机域名 描述:SSL 服务端在 AddSSLContext() 成功后可以调用本方法绑定主机域名到 SNI 主机证书
.参数 pServer, 整数型, ,
.参数 lpszDomainName, 文本型, , 主机域名
.参数 iContextIndex, 整数型, , SNI 主机证书对应的索引
.DLL命令 HP_SSLServer_CleanupSSLContext, , "HPSocket4C.dll", "HP_SSLServer_CleanupSSLContext", 公开, 名称:清理通信组件 SSL 运行环境 描述:清理通信组件 SSL 运行环境,回收 SSL 相关内存,无,/
.参数 pServer, 整数型, ,
.DLL命令 HP_SSLServer_GetSSLCipherList, 文本型, "HPSocket4C.dll", "HP_SSLServer_GetSSLCipherList", 公开, 获取 SSL 加密算法列表
.参数 pServer, 整数型, ,
.DLL命令 HP_SSLServer_GetSSLSessionInfo, 逻辑型, "HPSocket4C.dll", "HP_SSLServer_GetSSLSessionInfo", 公开, 名称:获取 SSL Session 信息 描述:获取指定类型的 SSL Session 信息(输出类型参考:#SSL_SSI_)
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 enInfo, 整数型, , 参考:#SSL_SSI_
.参数 lppInfo, 整数型, 传址 ,
.DLL命令 HP_SSLServer_IsSSLAutoHandShake, 逻辑型, "HPSocket4C.dll", "HP_SSLServer_IsSSLAutoHandShake", 公开, 获取通信组件握手方式
.参数 pServer, 整数型, ,
.DLL命令 HP_SSLServer_SetSSLAutoHandShake, , "HPSocket4C.dll", "HP_SSLServer_SetSSLAutoHandShake", 公开, 设置通信组件握手方式(默认:TRUE,自动握手)
.参数 pServer, 整数型, ,
.参数 bAutoHandShake, 逻辑型, ,
.DLL命令 HP_SSLServer_SetSSLCipherList, , "HPSocket4C.dll", "HP_SSLServer_SetSSLCipherList", 公开, 设置 SSL 加密算法列表
.参数 pServer, 整数型, ,
.参数 lpszCipherList, 文本型, ,
.DLL命令 HP_SSLServer_SetupSSLContext, 逻辑型, "HPSocket4C.dll", "HP_SSLServer_SetupSSLContext", 公开, 名称:初始化通信组件 SSL 环境参数 描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取失败原因,/
.参数 pServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCertFile, 文本型, , 证书文件
.参数 lpszPemKeyFile, 文本型, , 私钥文件
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCertFileOrPath, 文本型, , CA 证书文件或目录(单向验证或客户端可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.DLL命令 HP_SSLServer_SetupSSLContextByMemory, 逻辑型, "HPSocket4C.dll", "HP_SSLServer_SetupSSLContextByMemory", 公开, 名称:初始化通信组件 SSL 环境参数(通过内存加载证书)描述:SSL 环境参数必须在 SSL 通信组件启动前完成初始化,否则启动失败
.参数 pServer, 整数型, ,
.参数 iVerifyMode, 整数型, , SSL 验证模式(参考 EnSSLVerifyMode)
.参数 lpszPemCert, 文本型, , 证书内容
.参数 lpszPemKey, 文本型, , 私钥内容
.参数 lpszKeyPasswod, 文本型, , 私钥密码(没有密码则为空)
.参数 lpszCAPemCert, 文本型, , CA 证书内容(单向验证可选)
.参数 fnServerNameCallback, 子程序指针, , SNI 回调函数指针(可选)int (__HP_CALL *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName, PVOID pContext)
.DLL命令 HP_SSLServer_StartSSLHandShake, 逻辑型, "HPSocket4C.dll", "HP_SSLServer_StartSSLHandShake", 公开, 启动 SSL 握手,当通信组件设置为非自动握手时,需要调用本方法启动 SSL 握手
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.DLL命令 HP_TcpAgent_GetKeepAliveInterval, 整数型, "HPSocket4C.dll", "HP_TcpAgent_GetKeepAliveInterval", 公开, 获取异常心跳包间隔
.参数 pAgent, 整数型, ,
.DLL命令 HP_TcpAgent_GetKeepAliveTime, 整数型, "HPSocket4C.dll", "HP_TcpAgent_GetKeepAliveTime", 公开, 获取正常心跳包间隔
.参数 pAgent, 整数型, ,
.DLL命令 HP_TcpAgent_GetSocketBufferSize, 整数型, "HPSocket4C.dll", "HP_TcpAgent_GetSocketBufferSize", 公开, 获取通信数据缓冲区大小
.参数 pAgent, 整数型, ,
.DLL命令 HP_TcpAgent_SendSmallFile, 逻辑型, "HPSocket4C.dll", "HP_TcpAgent_SendSmallFile", 公开, 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.DLL命令 HP_TcpAgent_SetKeepAliveInterval, , "HPSocket4C.dll", "HP_TcpAgent_SetKeepAliveInterval", 公开, 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 pAgent, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.DLL命令 HP_TcpAgent_SetKeepAliveTime, , "HPSocket4C.dll", "HP_TcpAgent_SetKeepAliveTime", 公开, 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 pAgent, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.DLL命令 HP_TcpAgent_SetSocketBufferSize, , "HPSocket4C.dll", "HP_TcpAgent_SetSocketBufferSize", 公开, 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 pAgent, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.DLL命令 HP_TcpClient_GetKeepAliveInterval, 整数型, "HPSocket4C.dll", "HP_TcpClient_GetKeepAliveInterval", 公开, 获取异常心跳包间隔
.参数 pClient, 整数型, ,
.DLL命令 HP_TcpClient_GetKeepAliveTime, 整数型, "HPSocket4C.dll", "HP_TcpClient_GetKeepAliveTime", 公开, 获取正常心跳包间隔
.参数 pClient, 整数型, ,
.DLL命令 HP_TcpClient_GetSocketBufferSize, 整数型, "HPSocket4C.dll", "HP_TcpClient_GetSocketBufferSize", 公开, 获取通信数据缓冲区大小
.参数 pClient, 整数型, ,
.DLL命令 HP_TcpClient_SendSmallFile, 逻辑型, "HPSocket4C.dll", "HP_TcpClient_SendSmallFile", 公开, 名称:发送小文件 描述:向服务端发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pClient, 整数型, ,
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.DLL命令 HP_TcpClient_SetKeepAliveInterval, , "HPSocket4C.dll", "HP_TcpClient_SetKeepAliveInterval", 公开, 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 pClient, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.DLL命令 HP_TcpClient_SetKeepAliveTime, , "HPSocket4C.dll", "HP_TcpClient_SetKeepAliveTime", 公开, 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 pClient, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.DLL命令 HP_TcpClient_SetSocketBufferSize, , "HPSocket4C.dll", "HP_TcpClient_SetSocketBufferSize", 公开, 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj))
.参数 pClient, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.DLL命令 HP_TcpPackAgent_GetMaxPackSize, 整数型, "HPSocket4C.dll", "HP_TcpPackAgent_GetMaxPackSize", 公开, 获取数据包最大长度
.参数 pAgent, 整数型, ,
.DLL命令 HP_TcpPackAgent_GetPackHeaderFlag, 短整数, "HPSocket4C.dll", "HP_TcpPackAgent_GetPackHeaderFlag", 公开, 获取包头标识
.参数 pAgent, 整数型, ,
.DLL命令 HP_TcpPackAgent_SetMaxPackSize, , "HPSocket4C.dll", "HP_TcpPackAgent_SetMaxPackSize", 公开, 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 pAgent, 整数型, ,
.参数 dwMaxPackSize, 整数型, ,
.DLL命令 HP_TcpPackAgent_SetPackHeaderFlag, , "HPSocket4C.dll", "HP_TcpPackAgent_SetPackHeaderFlag", 公开, 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 pAgent, 整数型, ,
.参数 usPackHeaderFlag, 短整数, ,
.DLL命令 HP_TcpPackClient_GetMaxPackSize, 整数型, "HPSocket4C.dll", "HP_TcpPackClient_GetMaxPackSize", 公开, 获取数据包最大长度
.参数 pClient, 整数型, ,
.DLL命令 HP_TcpPackClient_GetPackHeaderFlag, 短整数, "HPSocket4C.dll", "HP_TcpPackClient_GetPackHeaderFlag", 公开, 获取包头标识
.参数 pClient, 整数型, ,
.DLL命令 HP_TcpPackClient_SetMaxPackSize, , "HPSocket4C.dll", "HP_TcpPackClient_SetMaxPackSize", 公开, 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 pClient, 整数型, ,
.参数 dwMaxPackSize, 整数型, ,
.DLL命令 HP_TcpPackClient_SetPackHeaderFlag, , "HPSocket4C.dll", "HP_TcpPackClient_SetPackHeaderFlag", 公开, 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 pClient, 整数型, ,
.参数 usPackHeaderFlag, 短整数, ,
.DLL命令 HP_TcpPackServer_GetMaxPackSize, 整数型, "HPSocket4C.dll", "HP_TcpPackServer_GetMaxPackSize", 公开, 获取数据包最大长度
.参数 pServer, 整数型, ,
.DLL命令 HP_TcpPackServer_GetPackHeaderFlag, 短整数, "HPSocket4C.dll", "HP_TcpPackServer_GetPackHeaderFlag", 公开, 获取包头标识
.参数 pServer, 整数型, ,
.DLL命令 HP_TcpPackServer_SetMaxPackSize, , "HPSocket4C.dll", "HP_TcpPackServer_SetMaxPackSize", 公开, 设置数据包最大长度(有效数据包最大长度不能超过 4194303/0x3FFFFF 字节,默认:262144/0x40000)
.参数 pServer, 整数型, ,
.参数 dwMaxPackSize, 整数型, ,
.DLL命令 HP_TcpPackServer_SetPackHeaderFlag, , "HPSocket4C.dll", "HP_TcpPackServer_SetPackHeaderFlag", 公开, 设置包头标识(有效包头标识取值范围 0 ~ 1023/0x3FF,当包头标识为 0 时不校验包头,默认:0)
.参数 pServer, 整数型, ,
.参数 usPackHeaderFlag, 短整数, ,
.DLL命令 HP_TcpPullAgent_Fetch, 整数型, "HPSocket4C.dll", "HP_TcpPullAgent_Fetch", 公开, 名称:抓取数据 描述:用户通过该方法从 Socket 组件中抓取数据,En_HP_FetchResult,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.DLL命令 HP_TcpPullAgent_Peek, 整数型, "HPSocket4C.dll", "HP_TcpPullAgent_Peek", 公开, 名称:窥探数据(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,En_HP_FetchResult,/
.参数 pAgent, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, , 窥探缓冲区
.参数 iLength, 整数型, , 窥探数据长度
.DLL命令 HP_TcpPullClient_Fetch, 整数型, "HPSocket4C.dll", "HP_TcpPullClient_Fetch", 公开, 名称:抓取数据 描述:用户通过该方法从 Socket 组件中抓取数据,En_HP_FetchResult,/
.参数 pClient, 整数型, ,
.参数 pData, 字节集, , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.DLL命令 HP_TcpPullClient_Peek, 整数型, "HPSocket4C.dll", "HP_TcpPullClient_Peek", 公开, 名称:窥探数据(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,En_HP_FetchResult,/
.参数 pClient, 整数型, ,
.参数 pData, 字节集, , 窥探缓冲区
.参数 iLength, 整数型, , 窥探数据长度
.DLL命令 HP_TcpPullServer_Fetch, 整数型, "HPSocket4C.dll", "HP_TcpPullServer_Fetch", 公开, 名称:抓取数据 描述:用户通过该方法从 Socket 组件中抓取数据,En_HP_FetchResult,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, , 抓取缓冲区
.参数 iLength, 整数型, , 抓取数据长度
.DLL命令 HP_TcpPullServer_Peek, 整数型, "HPSocket4C.dll", "HP_TcpPullServer_Peek", 公开, 名称:窥探数据(不会移除缓冲区数据) 描述:用户通过该方法从 Socket 组件中窥探数据,En_HP_FetchResult,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 pData, 字节集, , 窥探缓冲区
.参数 iLength, 整数型, , 窥探数据长度
.DLL命令 HP_TcpServer_GetAcceptSocketCount, 整数型, "HPSocket4C.dll", "HP_TcpServer_GetAcceptSocketCount", 公开, 获取 Accept 预投递数量
.参数 pServer, 整数型, ,
.DLL命令 HP_TcpServer_GetKeepAliveInterval, 整数型, "HPSocket4C.dll", "HP_TcpServer_GetKeepAliveInterval", 公开, 获取异常心跳包间隔
.参数 pServer, 整数型, ,
.DLL命令 HP_TcpServer_GetKeepAliveTime, 整数型, "HPSocket4C.dll", "HP_TcpServer_GetKeepAliveTime", 公开, 获取正常心跳包间隔
.参数 pServer, 整数型, ,
.DLL命令 HP_TcpServer_GetSocketBufferSize, 整数型, "HPSocket4C.dll", "HP_TcpServer_GetSocketBufferSize", 公开, 获取通信数据缓冲区大小
.参数 pServer, 整数型, ,
.DLL命令 HP_TcpServer_GetSocketListenQueue, 整数型, "HPSocket4C.dll", "HP_TcpServer_GetSocketListenQueue", 公开, 获取监听 Socket 的等候队列大小
.参数 pServer, 整数型, ,
.DLL命令 HP_TcpServer_SendSmallFile, 逻辑型, "HPSocket4C.dll", "HP_TcpServer_SendSmallFile", 公开, 名称:发送小文件 描述:向指定连接发送 4096 KB 以下的小文件,TRUE-- 成功,FALSE-- 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码,/
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, , 连接 ID
.参数 lpszFileName, 文本型, , 文件路径
.参数 pHead, WSABUF, , 头部附加数据
.参数 pTail, WSABUF, , 尾部附加数据
.DLL命令 HP_TcpServer_SetAcceptSocketCount, , "HPSocket4C.dll", "HP_TcpServer_SetAcceptSocketCount", 公开, 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多)
.参数 pServer, 整数型, ,
.参数 dwAcceptSocketCount, 整数型, ,
.DLL命令 HP_TcpServer_SetKeepAliveInterval, , "HPSocket4C.dll", "HP_TcpServer_SetKeepAliveInterval", 公开, 设置异常心跳包间隔(毫秒,0 不发送心跳包,,默认:20 * 1000,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线)
.参数 pServer, 整数型, ,
.参数 dwKeepAliveInterval, 整数型, ,
.DLL命令 HP_TcpServer_SetKeepAliveTime, , "HPSocket4C.dll", "HP_TcpServer_SetKeepAliveTime", 公开, 设置正常心跳包间隔(毫秒,0 则不发送心跳包,默认:60 * 1000)
.参数 pServer, 整数型, ,
.参数 dwKeepAliveTime, 整数型, ,
.DLL命令 HP_TcpServer_SetSocketBufferSize, , "HPSocket4C.dll", "HP_TcpServer_SetSocketBufferSize", 公开, 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数)
.参数 pServer, 整数型, ,
.参数 dwSocketBufferSize, 整数型, ,
.DLL命令 HP_TcpServer_SetSocketListenQueue, , "HPSocket4C.dll", "HP_TcpServer_SetSocketListenQueue", 公开, 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置)
.参数 pServer, 整数型, ,
.参数 dwSocketListenQueue, 整数型, ,
.DLL命令 HP_ThreadPool_AdjustThreadCount, 逻辑型, "HPSocket4C.dll", "HP_ThreadPool_AdjustThreadCount", 公开, 增加或减少线程池的工作线程数量,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 pThreadPool, 整数型, ,
.参数 dwNewThreadCount, 整数型, , 线程数量,>0 -> dwNewThreadCount,=0 -> (CPU核数 * 2 + 2),<0 -> (CPU核数 * (-dwNewThreadCount))
.DLL命令 HP_ThreadPool_GetMaxQueueSize, 整数型, "HPSocket4C.dll", "HP_ThreadPool_GetMaxQueueSize", 公开, 获取任务队列最大容量
.参数 pThreadPool, 整数型, ,
.DLL命令 HP_ThreadPool_GetQueueSize, 整数型, "HPSocket4C.dll", "HP_ThreadPool_GetQueueSize", 公开, 获取当前任务队列大小
.参数 pThreadPool, 整数型, ,
.DLL命令 HP_ThreadPool_GetRejectedPolicy, 整数型, "HPSocket4C.dll", "HP_ThreadPool_GetRejectedPolicy", 公开, 获取任务拒绝处理策略
.参数 pThreadPool, 整数型, ,
.DLL命令 HP_ThreadPool_GetState, 整数型, "HPSocket4C.dll", "HP_ThreadPool_GetState", 公开, 查看线程池组件当前状态
.参数 pThreadPool, 整数型, ,
.DLL命令 HP_ThreadPool_GetTaskCount, 整数型, "HPSocket4C.dll", "HP_ThreadPool_GetTaskCount", 公开, 获取当前正在执行的任务数量
.参数 pThreadPool, 整数型, ,
.DLL命令 HP_ThreadPool_GetThreadCount, 整数型, "HPSocket4C.dll", "HP_ThreadPool_GetThreadCount", 公开, 获取工作线程数量
.参数 pThreadPool, 整数型, ,
.DLL命令 HP_ThreadPool_HasStarted, 逻辑型, "HPSocket4C.dll", "HP_ThreadPool_HasStarted", 公开, 检查线程池组件是否已启动
.参数 pThreadPool, 整数型, ,
.DLL命令 HP_ThreadPool_Start, 逻辑型, "HPSocket4C.dll", "HP_ThreadPool_Start", 公开, 启动线程池组件,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 pThreadPool, 整数型, ,
.参数 dwThreadCount, 整数型, , 线程数量,(默认:0)
.参数 dwMaxQueueSize, 整数型, , 任务队列最大容量(0:不限制,默认:0)
.参数 enRejectedPolicy, 整数型, , 任务拒绝处理策略,#TRP_ 开头常量
.参数 dwStackSize, 整数型, , 线程堆栈空间大小(默认:0 -> 操作系统默认)
.DLL命令 HP_ThreadPool_Stop, 逻辑型, "HPSocket4C.dll", "HP_ThreadPool_Stop", 公开, 在规定时间内关闭线程池组件,如果工作线程在最大等待时间内未能正常关闭,会尝试强制关闭,这种情况下很可能会造成系统资源泄漏,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码
.参数 pThreadPool, 整数型, ,
.参数 dwMaxWait, 整数型, , 最大等待时间(毫秒,默认:INFINITE,一直等待)
.DLL命令 HP_ThreadPool_Submit, 逻辑型, "HPSocket4C.dll", "HP_ThreadPool_Submit", 公开, 向线程池提交异步任务,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码,其中,错误码 #ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
.参数 pThreadPool, 整数型, ,
.参数 fnTaskProc, 子程序指针, , 任务处理函数
.参数 pvArg, 整数型, , 任务参数
.参数 dwMaxWait, 整数型, , 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
.DLL命令 HP_ThreadPool_Submit_Task, 逻辑型, "HPSocket4C.dll", "HP_ThreadPool_Submit_Task", 公开, 向线程池提交异步 Socket 任务,TRUE -- 成功,FALSE -- 失败,可通过 SYS_GetLastError() 获取系统错误代码,其中,错误码 ERROR_DESTINATION_ELEMENT_FULL 表示任务队列已满
.参数 pThreadPool, 整数型, ,
.参数 pTask, 整数型, , 任务参数
.参数 dwMaxWait, 整数型, , 任务提交最大等待时间(仅对 TRP_WAIT_FOR 类型线程池生效,默认:INFINITE,一直等待)
.DLL命令 HP_ThreadPool_Wait, 逻辑型, "HPSocket4C.dll", "HP_ThreadPool_Wait", 公开, 名称:等待 描述:等待线程池组件停止运行
.参数 pThreadPool, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.DLL命令 HP_UdpArqClient_GetFastLimit, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetFastLimit", 公开, 获取快速握手次数限制
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetFlushInterval, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetFlushInterval", 公开, 获取数据刷新间隔v
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetHandShakeTimeout, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetHandShakeTimeout", 公开, 获取握手超时时间
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetMaxMessageSize, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetMaxMessageSize", 公开, 获取最大数据包大小
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetMaxTransUnit, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetMaxTransUnit", 公开, 获取最大传输单元
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetMinRto, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetMinRto", 公开, 获取最小重传超时时间
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetRecvWndSize, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetRecvWndSize", 公开, 获取接收窗口大小
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetResendByAcks, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetResendByAcks", 公开, 获取快速重传 ACK 跨越次数
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetSendWndSize, 整数型, "HPSocket4C.dll", "HP_UdpArqClient_GetSendWndSize", 公开, 获取发送窗口大小
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_GetWaitingSendMessageCount, 逻辑型, "HPSocket4C.dll", "HP_UdpArqClient_GetWaitingSendMessageCount", 公开, 获取等待发送包数量
.参数 pClient, 整数型, ,
.参数 piCount, 整数型, 传址 ,
.DLL命令 HP_UdpArqClient_IsNoDelay, 逻辑型, "HPSocket4C.dll", "HP_UdpArqClient_IsNoDelay", 公开, 检测是否开启 nodelay 模式
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_IsTurnoffCongestCtrl, 逻辑型, "HPSocket4C.dll", "HP_UdpArqClient_IsTurnoffCongestCtrl", 公开, 检测是否关闭拥塞控制
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpArqClient_SetFastLimit, , "HPSocket4C.dll", "HP_UdpArqClient_SetFastLimit", 公开, 设置快速握手次数限制(默认:5,如果为 0 则不限制)
.参数 pClient, 整数型, ,
.参数 dwFastLimit, 整数型, ,
.DLL命令 HP_UdpArqClient_SetFlushInterval, , "HPSocket4C.dll", "HP_UdpArqClient_SetFlushInterval", 公开, 设置数据刷新间隔(毫秒,默认:20)
.参数 pClient, 整数型, ,
.参数 dwFlushInterval, 整数型, ,
.DLL命令 HP_UdpArqClient_SetHandShakeTimeout, , "HPSocket4C.dll", "HP_UdpArqClient_SetHandShakeTimeout", 公开, 设置握手超时时间(毫秒,默认:5000)
.参数 pClient, 整数型, ,
.参数 dwHandShakeTimeout, 整数型, ,
.DLL命令 HP_UdpArqClient_SetMaxMessageSize, , "HPSocket4C.dll", "HP_UdpArqClient_SetMaxMessageSize", 公开, 设置最大数据包大小(默认:4096)
.参数 pClient, 整数型, ,
.参数 dwMaxMessageSize, 整数型, ,
.DLL命令 HP_UdpArqClient_SetMaxTransUnit, , "HPSocket4C.dll", "HP_UdpArqClient_SetMaxTransUnit", 公开, 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致)
.参数 pClient, 整数型, ,
.参数 dwMaxTransUnit, 整数型, ,
.DLL命令 HP_UdpArqClient_SetMinRto, , "HPSocket4C.dll", "HP_UdpArqClient_SetMinRto", 公开, 设置最小重传超时时间(毫秒,默认:30)
.参数 pClient, 整数型, ,
.参数 dwMinRto, 整数型, ,
.DLL命令 HP_UdpArqClient_SetNoDelay, , "HPSocket4C.dll", "HP_UdpArqClient_SetNoDelay", 公开, 设置是否开启 nodelay 模式(默认:FALSE,不开启)
.参数 pClient, 整数型, ,
.参数 bNoDelay, 逻辑型, ,
.DLL命令 HP_UdpArqClient_SetRecvWndSize, , "HPSocket4C.dll", "HP_UdpArqClient_SetRecvWndSize", 公开, 设置接收窗口大小(数据包数量,默认:512)
.参数 pClient, 整数型, ,
.参数 dwRecvWndSize, 整数型, ,
.DLL命令 HP_UdpArqClient_SetResendByAcks, , "HPSocket4C.dll", "HP_UdpArqClient_SetResendByAcks", 公开, 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传)
.参数 pClient, 整数型, ,
.参数 dwResendByAcks, 整数型, ,
.DLL命令 HP_UdpArqClient_SetSendWndSize, , "HPSocket4C.dll", "HP_UdpArqClient_SetSendWndSize", 公开, 设置发送窗口大小(数据包数量,默认:128)
.参数 pClient, 整数型, ,
.参数 dwSendWndSize, 整数型, ,
.DLL命令 HP_UdpArqClient_SetTurnoffCongestCtrl, , "HPSocket4C.dll", "HP_UdpArqClient_SetTurnoffCongestCtrl", 公开, 设置是否关闭拥塞控制(默认:FALSE,不关闭)
.参数 pClient, 整数型, ,
.参数 bTurnOff, 逻辑型, ,
.DLL命令 HP_UdpArqServer_GetFastLimit, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetFastLimit", 公开, 获取快速握手次数限制
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetFlushInterval, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetFlushInterval", 公开, 获取数据刷新间隔
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetHandShakeTimeout, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetHandShakeTimeout", 公开, 获取握手超时时间
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetMaxMessageSize, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetMaxMessageSize", 公开, 获取最大数据包大小
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetMaxTransUnit, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetMaxTransUnit", 公开, 获取最大传输单元
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetMinRto, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetMinRto", 公开, 获取最小重传超时时间
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetRecvWndSize, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetRecvWndSize", 公开, 获取接收窗口大小
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetResendByAcks, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetResendByAcks", 公开, 获取快速重传 ACK 跨越次数
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetSendWndSize, 整数型, "HPSocket4C.dll", "HP_UdpArqServer_GetSendWndSize", 公开, 获取发送窗口大小
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_GetWaitingSendMessageCount, 逻辑型, "HPSocket4C.dll", "HP_UdpArqServer_GetWaitingSendMessageCount", 公开, 获取等待发送包数量
.参数 pServer, 整数型, ,
.参数 dwConnID, 整数型, ,
.参数 piCount, 整数型, 传址 ,
.DLL命令 HP_UdpArqServer_IsNoDelay, 逻辑型, "HPSocket4C.dll", "HP_UdpArqServer_IsNoDelay", 公开, 检测是否开启 nodelay 模式
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_IsTurnoffCongestCtrl, 逻辑型, "HPSocket4C.dll", "HP_UdpArqServer_IsTurnoffCongestCtrl", 公开, 检测是否关闭拥塞控制
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpArqServer_SetFastLimit, , "HPSocket4C.dll", "HP_UdpArqServer_SetFastLimit", 公开, 设置快速握手次数限制(默认:5,如果为 0 则不限制)
.参数 pServer, 整数型, ,
.参数 dwFastLimit, 整数型, ,
.DLL命令 HP_UdpArqServer_SetFlushInterval, , "HPSocket4C.dll", "HP_UdpArqServer_SetFlushInterval", 公开, 设置数据刷新间隔(毫秒,默认:20)
.参数 pServer, 整数型, ,
.参数 dwFlushInterval, 整数型, ,
.DLL命令 HP_UdpArqServer_SetHandShakeTimeout, , "HPSocket4C.dll", "HP_UdpArqServer_SetHandShakeTimeout", 公开, 设置握手超时时间(毫秒,默认:5000)
.参数 pServer, 整数型, ,
.参数 dwHandShakeTimeout, 整数型, ,
.DLL命令 HP_UdpArqServer_SetMaxMessageSize, , "HPSocket4C.dll", "HP_UdpArqServer_SetMaxMessageSize", 公开, 设置最大数据包大小(默认:4096)
.参数 pServer, 整数型, ,
.参数 dwMaxMessageSize, 整数型, ,
.DLL命令 HP_UdpArqServer_SetMaxTransUnit, , "HPSocket4C.dll", "HP_UdpArqServer_SetMaxTransUnit", 公开, 设置最大传输单元(默认:0,与 SetMaxDatagramSize() 一致)
.参数 pServer, 整数型, ,
.参数 dwMaxTransUnit, 整数型, ,
.DLL命令 HP_UdpArqServer_SetMinRto, , "HPSocket4C.dll", "HP_UdpArqServer_SetMinRto", 公开, 设置最小重传超时时间(毫秒,默认:30)
.参数 pServer, 整数型, ,
.参数 dwMinRto, 整数型, ,
.DLL命令 HP_UdpArqServer_SetNoDelay, , "HPSocket4C.dll", "HP_UdpArqServer_SetNoDelay", 公开, 设置是否开启 nodelay 模式(默认:FALSE,不开启)
.参数 pServer, 整数型, ,
.参数 bNoDelay, 逻辑型, ,
.DLL命令 HP_UdpArqServer_SetRecvWndSize, , "HPSocket4C.dll", "HP_UdpArqServer_SetRecvWndSize", 公开, 设置接收窗口大小(数据包数量,默认:512)
.参数 pServer, 整数型, ,
.参数 dwRecvWndSize, 整数型, ,
.DLL命令 HP_UdpArqServer_SetResendByAcks, , "HPSocket4C.dll", "HP_UdpArqServer_SetResendByAcks", 公开, 设置快速重传 ACK 跨越次数(默认:0,关闭快速重传)
.参数 pServer, 整数型, ,
.参数 dwResendByAcks, 整数型, ,
.DLL命令 HP_UdpArqServer_SetSendWndSize, , "HPSocket4C.dll", "HP_UdpArqServer_SetSendWndSize", 公开, 设置发送窗口大小(数据包数量,默认:128)
.参数 pServer, 整数型, ,
.参数 dwSendWndSize, 整数型, ,
.DLL命令 HP_UdpArqServer_SetTurnoffCongestCtrl, , "HPSocket4C.dll", "HP_UdpArqServer_SetTurnoffCongestCtrl", 公开, 设置是否关闭拥塞控制(默认:FALSE,不关闭)
.参数 pServer, 整数型, ,
.参数 bTurnOff, 逻辑型, ,
.DLL命令 HP_UdpCast_GetCastMode, 整数型, "HPSocket4C.dll", "HP_UdpCast_GetCastMode", 公开, 获取传播模式
.参数 pCast, 整数型, ,
.DLL命令 HP_UdpCast_GetMaxDatagramSize, 整数型, "HPSocket4C.dll", "HP_UdpCast_GetMaxDatagramSize", 公开, 获取数据报文最大长度
.参数 pCast, 整数型, ,
.DLL命令 HP_UdpCast_GetMultiCastTtl, 整数型, "HPSocket4C.dll", "HP_UdpCast_GetMultiCastTtl", 公开, 获取组播报文的 TTL
.参数 pCast, 整数型, ,
.DLL命令 HP_UdpCast_GetRemoteAddress, 逻辑型, "HPSocket4C.dll", "HP_UdpCast_GetRemoteAddress", 公开, 获取当前数据报的远程地址信息(通常在 OnReceive 事件中调用)
.参数 pCast, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 HP_UdpCast_IsMultiCastLoop, 逻辑型, "HPSocket4C.dll", "HP_UdpCast_IsMultiCastLoop", 公开, 检测是否启用组播环路
.参数 pCast, 整数型, ,
.DLL命令 HP_UdpCast_SetCastMode, , "HPSocket4C.dll", "HP_UdpCast_SetCastMode", 公开, 设置传播模式(组播或广播)
.参数 pCast, 整数型, ,
.参数 enCastMode, 整数型, ,
.DLL命令 HP_UdpCast_SetMaxDatagramSize, , "HPSocket4C.dll", "HP_UdpCast_SetMaxDatagramSize", 公开, 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 pCast, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.DLL命令 HP_UdpCast_SetMultiCastLoop, , "HPSocket4C.dll", "HP_UdpCast_SetMultiCastLoop", 公开, 设置是否启用组播环路(TRUE or FALSE)
.参数 pCast, 整数型, ,
.参数 bMCLoop, 逻辑型, ,
.DLL命令 HP_UdpCast_SetMultiCastTtl, , "HPSocket4C.dll", "HP_UdpCast_SetMultiCastTtl", 公开, 设置组播报文的 TTL(0 - 255)
.参数 pCast, 整数型, ,
.参数 iMCTtl, 整数型, ,
.DLL命令 HP_UdpClient_GetDetectAttempts, 整数型, "HPSocket4C.dll", "HP_UdpClient_GetDetectAttempts", 公开, 获取心跳检查次数
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpClient_GetDetectInterval, 整数型, "HPSocket4C.dll", "HP_UdpClient_GetDetectInterval", 公开, 获取心跳检查间隔
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpClient_GetMaxDatagramSize, 整数型, "HPSocket4C.dll", "HP_UdpClient_GetMaxDatagramSize", 公开, 获取数据报文最大长度
.参数 pClient, 整数型, ,
.DLL命令 HP_UdpClient_SetDetectAttempts, , "HPSocket4C.dll", "HP_UdpClient_SetDetectAttempts", 公开, 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 pClient, 整数型, ,
.参数 dwDetectAttempts, 整数型, ,
.DLL命令 HP_UdpClient_SetDetectInterval, , "HPSocket4C.dll", "HP_UdpClient_SetDetectInterval", 公开, 设置监测包发送间隔(秒,0 不发送监测包)
.参数 pClient, 整数型, ,
.参数 dwDetectInterval, 整数型, ,
.DLL命令 HP_UdpClient_SetMaxDatagramSize, , "HPSocket4C.dll", "HP_UdpClient_SetMaxDatagramSize", 公开, 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 pClient, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.DLL命令 HP_UdpNode_GetCastAddress, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_GetCastAddress", 公开, 获取本节点传播地址
.参数 pNode, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 整数型, 传址 ,
.DLL命令 HP_UdpNode_GetCastMode, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetCastMode", 公开, 获取传播模式
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetExtra, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetExtra", 公开, 获取附加数据
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetFreeBufferPoolHold, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetFreeBufferPoolHold", 公开, 获取内存块缓存池回收阀值
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetFreeBufferPoolSize, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetFreeBufferPoolSize", 公开, 获取内存块缓存池大小
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetLastError, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetLastError", 公开, 获取最近一次失败操作的错误代码
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetLastErrorDesc, 文本型, "HPSocket4C.dll", "HP_UdpNode_GetLastErrorDesc", 公开, 获取最近一次失败操作的错误描述
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetLocalAddress, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_GetLocalAddress", 公开, 获取本节点地址
.参数 pNode, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 整数型, 传址 ,
.DLL命令 HP_UdpNode_GetMaxDatagramSize, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetMaxDatagramSize", 公开, 获取数据报文最大长度
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetMultiCastTtl, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetMultiCastTtl", 公开, 获取组播报文的 TTL
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetPendingDataLength, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_GetPendingDataLength", 公开, 获取未发出数据的长度
.参数 pNode, 整数型, ,
.参数 piPending, 整数型, 传址 ,
.DLL命令 HP_UdpNode_GetPostReceiveCount, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetPostReceiveCount", 公开, 获取 Receive 预投递数量
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetReuseAddressPolicy, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetReuseAddressPolicy", 公开, 获取地址重用选项 #RAP_ 开头常量
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetState, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetState", 公开, 检查通信组件是否已启动
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_GetWorkerThreadCount, 整数型, "HPSocket4C.dll", "HP_UdpNode_GetWorkerThreadCount", 公开, 获取工作线程数量
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_HasStarted, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_HasStarted", 公开, 查看通信组件当前状态
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_IsMultiCastLoop, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_IsMultiCastLoop", 公开, 检测是否启用组播环路
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_Send, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_Send", 公开, 名称:发送数据 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.DLL命令 HP_UdpNode_SendCast, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_SendCast", 公开, 名称:发送数据 描述:向传播地址发送数据
.参数 pNode, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.DLL命令 HP_UdpNode_SendCastPackets, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_SendCastPackets", 公开, 名称:发送多组数据 描述:向传播地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
.参数 pNode, 整数型, ,
.参数 pBuffer, WSABUF, 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.DLL命令 HP_UdpNode_SendCastPart, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_SendCastPart", 公开, 名称:发送数据 描述:向传播地址发送数据
.参数 pNode, 整数型, ,
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.DLL命令 HP_UdpNode_SendPackets, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_SendPackets", 公开, 名称:发送多组数据 描述:向指定地址发送多组数据,把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度)
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, WSABUF, 数组, 发送缓冲区数组
.参数 iCount, 整数型, , 发送缓冲区数目
.DLL命令 HP_UdpNode_SendPart, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_SendPart", 公开, 名称:发送数据 描述:向指定地址发送数据
.参数 pNode, 整数型, ,
.参数 lpszRemoteAddress, 文本型, , 远程地址
.参数 usRemotePort, 短整数, , 远程端口
.参数 pBuffer, 整数型, , 发送缓冲区
.参数 iLength, 整数型, , 发送缓冲区长度
.参数 iOffset, 整数型, , 发送缓冲区指针偏移量
.DLL命令 HP_UdpNode_SetExtra, , "HPSocket4C.dll", "HP_UdpNode_SetExtra", 公开, 设置附加数据
.参数 pNode, 整数型, ,
.参数 pExtra, 整数型, ,
.DLL命令 HP_UdpNode_SetFreeBufferPoolHold, , "HPSocket4C.dll", "HP_UdpNode_SetFreeBufferPoolHold", 公开, 设置内存块缓存池回收阀值
.参数 pNode, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.DLL命令 HP_UdpNode_SetFreeBufferPoolSize, , "HPSocket4C.dll", "HP_UdpNode_SetFreeBufferPoolSize", 公开, 设置内存块缓存池大小
.参数 pNode, 整数型, ,
.参数 dwFreeBufferPoolSize, 整数型, ,
.DLL命令 HP_UdpNode_SetMaxDatagramSize, , "HPSocket4C.dll", "HP_UdpNode_SetMaxDatagramSize", 公开, 设置数据报文最大长度(建议在局域网环境下不超过 1432 字节,在广域网环境下不超过 548 字节)
.参数 pNode, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.DLL命令 HP_UdpNode_SetMultiCastLoop, , "HPSocket4C.dll", "HP_UdpNode_SetMultiCastLoop", 公开, 设置是否启用组播环路(TRUE or FALSE)
.参数 pNode, 整数型, ,
.参数 bMCLoop, 逻辑型, ,
.DLL命令 HP_UdpNode_SetMultiCastTtl, , "HPSocket4C.dll", "HP_UdpNode_SetMultiCastTtl", 公开, 设置组播报文的 TTL(0 - 255)
.参数 pNode, 整数型, ,
.参数 iMCTtl, 整数型, ,
.DLL命令 HP_UdpNode_SetPostReceiveCount, , "HPSocket4C.dll", "HP_UdpNode_SetPostReceiveCount", 公开, 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 pNode, 整数型, ,
.参数 dwPostReceiveCount, 整数型, ,
.DLL命令 HP_UdpNode_SetReuseAddressPolicy, , "HPSocket4C.dll", "HP_UdpNode_SetReuseAddressPolicy", 公开, 设置地址重用选项
.参数 pNode, 整数型, ,
.参数 enReusePolicy, 整数型, , #RAP_ 开头常量
.DLL命令 HP_UdpNode_SetWorkerThreadCount, , "HPSocket4C.dll", "HP_UdpNode_SetWorkerThreadCount", 公开, 设置工作线程数量(通常设置为 2 * CPU + 2)
.参数 pNode, 整数型, ,
.参数 dwWorkerThreadCount, 整数型, ,
.DLL命令 HP_UdpNode_Start, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_Start", 公开, 名称:启动通信组件 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
.参数 pNode, 整数型, ,
.参数 lpszBindAddress, 文本型, , 绑定地址(默认:nullptr,绑定任意地址)
.参数 usPort, 短整数, , 本地端口(默认:0)
.DLL命令 HP_UdpNode_StartWithCast, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_StartWithCast", 公开, 名称:启动通信组件 描述:启动 UDP 节点通信组件,启动完成后可开始收发数据
.参数 pNode, 整数型, ,
.参数 lpszBindAddress, 文本型, , 绑定地址(默认:nullptr,绑定任意地址)
.参数 usPort, 短整数, , 本地端口(默认:0)
.参数 enCastMode, 整数型, , 传播模式(默认:CM_UNICAST)
.参数 lpszCastAddress, 文本型, , 传播地址(默认:nullptr,当 enCaseMode 为 CM_MULTICAST 或 CM_BROADCAST 时有效)
.DLL命令 HP_UdpNode_Stop, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_Stop", 公开, 名称:关闭通信组件 描述:关闭 UDP 节点通信组件,关闭完成后释放所有资源
.参数 pNode, 整数型, ,
.DLL命令 HP_UdpNode_Wait, 逻辑型, "HPSocket4C.dll", "HP_UdpNode_Wait", 公开, 名称:等待 描述:等待通信组件停止运行
.参数 pNode, 整数型, ,
.参数 dwMilliseconds, 整数型, , 超时时间(毫秒,默认:-1,永不超时)
.DLL命令 HP_UdpServer_GetDetectAttempts, 整数型, "HPSocket4C.dll", "HP_UdpServer_GetDetectAttempts", 公开, 获取心跳检查次数
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpServer_GetDetectInterval, 整数型, "HPSocket4C.dll", "HP_UdpServer_GetDetectInterval", 公开, 获取心跳检查间隔
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpServer_GetMaxDatagramSize, 整数型, "HPSocket4C.dll", "HP_UdpServer_GetMaxDatagramSize", 公开, 获取数据报文最大长度
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpServer_GetPostReceiveCount, 整数型, "HPSocket4C.dll", "HP_UdpServer_GetPostReceiveCount", 公开, 获取 Receive 预投递数量
.参数 pServer, 整数型, ,
.DLL命令 HP_UdpServer_SetDetectAttempts, , "HPSocket4C.dll", "HP_UdpServer_SetDetectAttempts", 公开, 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线)
.参数 pServer, 整数型, ,
.参数 dwDetectAttempts, 整数型, ,
.DLL命令 HP_UdpServer_SetDetectInterval, , "HPSocket4C.dll", "HP_UdpServer_SetDetectInterval", 公开, 设置监测包发送间隔(秒,0 不发送监测包)
.参数 pServer, 整数型, ,
.参数 dwDetectInterval, 整数型, ,
.DLL命令 HP_UdpServer_SetMaxDatagramSize, , "HPSocket4C.dll", "HP_UdpServer_SetMaxDatagramSize", 公开, 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节)
.参数 pServer, 整数型, ,
.参数 dwMaxDatagramSize, 整数型, ,
.DLL命令 HP_UdpServer_SetPostReceiveCount, , "HPSocket4C.dll", "HP_UdpServer_SetPostReceiveCount", 公开, 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小)
.参数 pServer, 整数型, ,
.参数 dwPostReceiveCount, 整数型, ,
.DLL命令 malloc, 整数型, "crtdll.dll", "@malloc", 公开, 申请内存
.参数 size, 整数型, ,
.DLL命令 memcmp, 整数型, "crtdll.dll", "@memcmp", 公开, 比较前size个字节是否相同
.参数 _Buf1, 整数型, ,
.参数 _Buf2, 整数型, ,
.参数 _Size, 整数型, ,
.DLL命令 memcpy, 整数型, "crtdll.dll", "@memcpy", 公开, 复制内存
.参数 _Dst, 整数型, ,
.参数 _Src, 整数型, ,
.参数 _Size, 整数型, ,
.DLL命令 memset, 整数型, "crtdll.dll", "@memset", 公开, 填充内存
.参数 _Dst, 整数型, ,
.参数 _Val, 整数型, ,
.参数 _Size, 整数型, ,
.DLL命令 realloc, 整数型, "crtdll.dll", "@realloc", 公开, 重置内存大小
.参数 block, 整数型, ,
.参数 size, 整数型, ,
.DLL命令 SYS_Base64Decode, 整数型, "HPSocket4C.dll", "SYS_Base64Decode", 公开, Base64 解码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_Base64Encode, 整数型, "HPSocket4C.dll", "SYS_Base64Encode", 公开, Base64 编码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_CodePageToUnicode, 逻辑型, "HPSocket4C.dll", "SYS_CodePageToUnicode", 公开, CP_XXX -> UNICODE
.参数 iCodePage, 整数型, ,
.参数 szSrc, 文本型, ,
.参数 szDest, 字节集, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_Compress, 整数型, "HPSocket4C.dll", "SYS_Compress", 公开, 普通压缩
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, 传址 ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_CompressEx, 整数型, "HPSocket4C.dll", "SYS_CompressEx", 公开, 高级压缩(默认值:iLevel -> -1,iMethod -> 8,iWindowBits -> 15,iMemLevel -> 8,iStrategy -> 0)
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, ,
.参数 pdwDestLen, 整数型, 传址 ,
.参数 iLevel, 整数型, ,
.参数 iMethod, 整数型, ,
.参数 iWindowBits, 整数型, ,
.参数 iMemLevel, 整数型, ,
.参数 iStrategy, 整数型, ,
.DLL命令 SYS_EnumHostIPAddresses, 逻辑型, "HPSocket4C.dll", "SYS_EnumHostIPAddresses", 公开, 枚举主机 IP 地址
.参数 lpszHost, 文本型, ,
.参数 enType, 整数型, ,
.参数 lpppIPAddr, 整数型, 传址 ,
.参数 piIPAddrCount, 整数型, 传址 ,
.DLL命令 SYS_Free, 整数型, "HPSocket4C.dll", "SYS_Free", 公开, 释放内存
.参数 p, 整数型, ,
.DLL命令 SYS_FreeHostIPAddresses, 逻辑型, "HPSocket4C.dll", "SYS_FreeHostIPAddresses", 公开, 释放 HP_LPTIPAddr*
.参数 lppIPAddr, 整数型, ,
.DLL命令 SYS_GbkToUnicode, 逻辑型, "HPSocket4C.dll", "SYS_GbkToUnicode", 公开, GBK -> UNICODE
.参数 szSrc, 文本型, ,
.参数 szDest, 字节集, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_GbkToUtf8, 逻辑型, "HPSocket4C.dll", "SYS_GbkToUtf8", 公开, GBK -> UTF8
.参数 szSrc, 文本型, ,
.参数 szDest, 文本型, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_GetIPAddress, 逻辑型, "HPSocket4C.dll", "SYS_GetIPAddress", 公开, 通过主机名获取 IP 地址
.参数 lpszHost, 文本型, ,
.参数 lpszIP, 文本型, ,
.参数 piIPLenth, 整数型, 传址 ,
.参数 penType, 整数型, 传址 ,
.DLL命令 SYS_GetLastError, 整数型, "HPSocket4C.dll", "SYS_GetLastError", 公开, 调用系统的 GetLastError() 方法获取系统错误代码
.DLL命令 SYS_GetSocketLocalAddress, 逻辑型, "HPSocket4C.dll", "SYS_GetSocketLocalAddress", 公开, 获取 SOCKET 本地地址信息
.参数 socket, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 SYS_GetSocketOption, 整数型, "HPSocket4C.dll", "SYS_GetSocketOption", 公开, 调用系统的 getsockopt()
.参数 sock, 整数型, ,
.参数 level, 整数型, ,
.参数 name, 整数型, ,
.参数 val, 整数型, ,
.参数 len, 整数型, 传址 ,
.DLL命令 SYS_GetSocketRemoteAddress, 逻辑型, "HPSocket4C.dll", "SYS_GetSocketRemoteAddress", 公开, 获取 SOCKET 远程地址信息
.参数 socket, 整数型, ,
.参数 lpszAddress, 文本型, ,
.参数 piAddressLen, 整数型, 传址 ,
.参数 pusPort, 短整数, 传址 ,
.DLL命令 SYS_GuessBase64DecodeBound, 整数型, "HPSocket4C.dll", "SYS_GuessBase64DecodeBound", 公开, 计算 Base64 解码后长度
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.DLL命令 SYS_GuessBase64EncodeBound, 整数型, "HPSocket4C.dll", "SYS_GuessBase64EncodeBound", 公开, 计算 Base64 编码后长度
.参数 dwSrcLen, 整数型, ,
.DLL命令 SYS_GuessCompressBound, 整数型, "HPSocket4C.dll", "SYS_GuessCompressBound", 公开, 推测压缩结果长度
.参数 dwSrcLen, 整数型, ,
.参数 bGZip, 逻辑型, ,
.DLL命令 SYS_GuessUrlDecodeBound, 整数型, "HPSocket4C.dll", "SYS_GuessUrlDecodeBound", 公开, 计算 URL 解码后长度
.参数 lpszSrc, 文本型, ,
.参数 dwSrcLen, 整数型, ,
.DLL命令 SYS_GuessUrlEncodeBound, 整数型, "HPSocket4C.dll", "SYS_GuessUrlEncodeBound", 公开, 计算 URL 编码后长度
.参数 lpszSrc, 文本型, ,
.参数 dwSrcLen, 整数型, ,
.DLL命令 SYS_GZipCompress, 整数型, "HPSocket4C.dll", "SYS_GZipCompress", 公开, Gzip 压缩
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_GZipGuessUncompressBound, 整数型, "HPSocket4C.dll", "SYS_GZipGuessUncompressBound", 公开, 推测 Gzip 解压结果长度(如果返回 0 或不合理值则说明输入内容并非有效的 Gzip 格式)
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.DLL命令 SYS_GZipUncompress, 整数型, "HPSocket4C.dll", "SYS_GZipUncompress", 公开, Gzip 解压
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_HToN64, 长整数型, "HPSocket4C.dll", "SYS_HToN64", 公开, 64 位主机字节序转网络字节序
.参数 value, 长整数型, ,
.DLL命令 SYS_IoctlSocket, 整数型, "HPSocket4C.dll", "SYS_IoctlSocket", 公开, 调用系统的 ioctlsocket()
.参数 sock, 整数型, ,
.参数 cmd, 长整数型, ,
.参数 arg, 长整数型, 传址 ,
.DLL命令 SYS_IsIPAddress, 逻辑型, "HPSocket4C.dll", "SYS_IsIPAddress", 公开, 检查字符串是否符合 IP 地址格式
.参数 lpszAddress, 文本型, ,
.参数 penType, 整数型, 传址 ,
.DLL命令 SYS_IsLittleEndian, 逻辑型, "HPSocket4C.dll", "SYS_IsLittleEndian", 公开, 检查是否小端字节序
.DLL命令 SYS_Malloc, 整数型, "HPSocket4C.dll", "SYS_Malloc", 公开, 分配内存
.参数 size, 整数型, ,
.DLL命令 SYS_NToH64, 长整数型, "HPSocket4C.dll", "SYS_NToH64", 公开, 64 位网络字节序转主机字节序
.参数 value, 长整数型, ,
.DLL命令 SYS_Realloc, 整数型, "HPSocket4C.dll", "SYS_Realloc", 公开, 重新分配内存
.参数 p, 整数型, ,
.参数 size, 整数型, ,
.DLL命令 SYS_SetSocketOption, 整数型, "HPSocket4C.dll", "SYS_SetSocketOption", 公开, 调用系统的 setsockopt()
.参数 sock, 整数型, ,
.参数 level, 整数型, ,
.参数 name, 整数型, ,
.参数 val, 整数型, ,
.参数 len, 整数型, ,
.DLL命令 SYS_SSO_DontLinger, 整数型, "HPSocket4C.dll", "SYS_SSO_DontLinger", 公开, 设置 socket 选项:SOL_SOCKET -> SO_DONTLINGER
.参数 sock, 整数型, ,
.参数 bDont, 逻辑型, ,
.DLL命令 SYS_SSO_Linger, 整数型, "HPSocket4C.dll", "SYS_SSO_Linger", 公开, 设置 socket 选项:SOL_SOCKET -> SO_LINGER
.参数 sock, 整数型, ,
.参数 l_onoff, 短整数, ,
.参数 l_linger, 短整数, ,
.DLL命令 SYS_SSO_NoDelay, 整数型, "HPSocket4C.dll", "SYS_SSO_NoDelay", 公开, 设置 socket 选项:IPPROTO_TCP -> TCP_NODELAY
.参数 sock, 整数型, ,
.参数 bNoDelay, 逻辑型, ,
.DLL命令 SYS_SSO_RecvBuffSize, 整数型, "HPSocket4C.dll", "SYS_SSO_RecvBuffSize", 公开, 设置 socket 选项:SOL_SOCKET -> SO_RCVBUF
.参数 sock, 整数型, ,
.参数 size, 整数型, ,
.DLL命令 SYS_SSO_RecvTimeOut, 整数型, "HPSocket4C.dll", "SYS_SSO_RecvTimeOut", 公开, 设置 socket 选项:SOL_SOCKET -> SO_RCVTIMEO
.参数 sock, 整数型, ,
.参数 ms, 整数型, ,
.DLL命令 SYS_SSO_ReuseAddress, 整数型, "HPSocket4C.dll", "SYS_SSO_ReuseAddress", 公开, 设置 socket 选项:SOL_SOCKET -> SO_REUSEADDR
.参数 sock, 整数型, ,
.参数 bReuse, 逻辑型, ,
.DLL命令 SYS_SSO_SendBuffSize, 整数型, "HPSocket4C.dll", "SYS_SSO_SendBuffSize", 公开, 设置 socket 选项:SOL_SOCKET -> SO_SNDBUF
.参数 sock, 整数型, ,
.参数 size, 整数型, ,
.DLL命令 SYS_SSO_SendTimeOut, 整数型, "HPSocket4C.dll", "SYS_SSO_SendTimeOut", 公开, 设置 socket 选项:SOL_SOCKET -> SO_SNDTIMEO
.参数 sock, 整数型, ,
.参数 ms, 整数型, ,
.DLL命令 SYS_SwapEndian16, 短整数, "HPSocket4C.dll", "SYS_SwapEndian16", 公开, 短整型高低字节交换
.参数 value, 短整数, ,
.DLL命令 SYS_SwapEndian32, 整数型, "HPSocket4C.dll", "SYS_SwapEndian32", 公开, 长整型高低字节交换
.参数 value, 整数型, ,
.DLL命令 SYS_Uncompress, 整数型, "HPSocket4C.dll", "SYS_Uncompress", 公开, 普通解压
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_UncompressEx, 整数型, "HPSocket4C.dll", "SYS_UncompressEx", 公开, 高级解压(默认值:iWindowBits -> 15)
.参数 lpszSrc, 字节集, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 字节集, ,
.参数 pdwDestLen, 整数型, 传址 ,
.参数 iWindowBits, 整数型, ,
.DLL命令 SYS_UnicodeToCodePage, 逻辑型, "HPSocket4C.dll", "SYS_UnicodeToCodePage", 公开, UNICODE -> CP_XXX
.参数 iCodePage, 整数型, ,
.参数 szSrc, 字节集, ,
.参数 szDest, 文本型, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_UnicodeToGbk, 逻辑型, "HPSocket4C.dll", "SYS_UnicodeToGbk", 公开, UNICODE -> GBK
.参数 szSrc, 字节集, ,
.参数 szDest, 文本型, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_UnicodeToUtf8, 逻辑型, "HPSocket4C.dll", "SYS_UnicodeToUtf8", 公开, UNICODE -> UTF8
.参数 szSrc, 字节集, ,
.参数 szDest, 文本型, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_UrlDecode, 整数型, "HPSocket4C.dll", "SYS_UrlDecode", 公开, URL 解码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
.参数 lpszSrc, 文本型, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 文本型, ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_UrlEncode, 整数型, "HPSocket4C.dll", "SYS_UrlEncode", 公开, URL 编码(返回值:0 -> 成功,-3 -> 输入数据不正确,-5 -> 输出缓冲区不足)
.参数 lpszSrc, 文本型, ,
.参数 dwSrcLen, 整数型, ,
.参数 lpszDest, 文本型, ,
.参数 pdwDestLen, 整数型, 传址 ,
.DLL命令 SYS_Utf8ToGbk, 逻辑型, "HPSocket4C.dll", "SYS_Utf8ToGbk", 公开, UTF8 -> GBK
.参数 szSrc, 文本型, ,
.参数 szDest, 文本型, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_Utf8ToUnicode, 逻辑型, "HPSocket4C.dll", "SYS_Utf8ToUnicode", 公开, UTF8 -> UNICODE
.参数 szSrc, 文本型, ,
.参数 szDest, 字节集, ,
.参数 piDestLength, 整数型, 传址 ,
.DLL命令 SYS_WSAGetLastError, 整数型, "HPSocket4C.dll", "SYS_WSAGetLastError", 公开, 调用系统的 WSAGetLastError() 方法获取系统错误代码
.DLL命令 SYS_WSAIoctl, 整数型, "HPSocket4C.dll", "SYS_WSAIoctl", 公开, 调用系统的 WSAIoctl()
.参数 sock, 整数型, ,
.参数 dwIoControlCode, 整数型, ,
.参数 lpvInBuffer, 整数型, ,
.参数 cbInBuffer, 整数型, ,
.参数 lpvOutBuffer, 整数型, ,
.参数 cbOutBuffer, 整数型, ,
.参数 lpcbBytesReturned, 整数型, ,
.常量 CM_BROADCAST, "1", 公开, 广播
.常量 CM_MULTICAST, "0", 公开, 组播
.常量 CM_UNICAST, "-1", 公开, 单播
.常量 CONTENT_ENCODING_HEADER, "“Content-Encoding”", 公开,
.常量 CONTENT_LENGTH_HEADER, "“Content-Length”", 公开,
.常量 CONTENT_TYPE_HEADER, "“Content-Type”", 公开,
.常量 COOKIE_HEADER, "“Cookie”", 公开,
.常量 COOKIE_TOKENIZE, "; ", 公开,
.常量 CRLF, "“\r\n”", 公开,
.常量 FR_DATA_NOT_FOUND, "2", 公开, 找不到 ConnID 对应的数据
.常量 FR_LENGTH_TOO_LONG, "1", 公开, 抓取长度过大
.常量 FR_OK, "0", 公开, 成功
.常量 HEADER_SEPARATOR, ": ", 公开,
.常量 HOST_HEADER, "“Host”", 公开,
.常量 HPR_ERROR, "-1", 公开, 解析错误,终止解析,断开连接
.常量 HPR_OK, "0", 公开, 解析成功
.常量 HPR_SKIP_BODY, "1", 公开, 跳过当前请求 BODY(仅用于 OnHeadersComplete 事件)
.常量 HPR_UPGRADE, "2", 公开, 升级协议(仅用于 OnHeadersComplete 事件)
.常量 HR_ERROR, "2", 公开, 错误
.常量 HR_IGNORE, "1", 公开, 忽略
.常量 HR_OK, "0", 公开, 成功
.常量 HSC_ACCEPTED, "202", 公开,
.常量 HSC_ALREADY_REPORTED, "208", 公开,
.常量 HSC_BAD_GATEWAY, "502", 公开,
.常量 HSC_BAD_REQUEST, "400", 公开,
.常量 HSC_BANDWIDTH_LIMIT_EXCEEDED, "509", 公开,
.常量 HSC_CONFLICT, "409", 公开,
.常量 HSC_CONTINUE, "100", 公开,
.常量 HSC_CREATED, "201", 公开,
.常量 HSC_EXPECTATION_FAILED, "417", 公开,
.常量 HSC_FAILED_DEPENDENCY, "424", 公开,
.常量 HSC_FORBIDDEN, "403", 公开,
.常量 HSC_GATEWAY_TIMEOUT, "504", 公开,
.常量 HSC_GONE, "410", 公开,
.常量 HSC_HTTP_VERSION_NOT_SUPPORTED, "505", 公开,
.常量 HSC_IM_USED, "226", 公开,
.常量 HSC_INSUFFICIENT_STORAGE, "507", 公开,
.常量 HSC_INTERNAL_SERVER_ERROR, "500", 公开,
.常量 HSC_LENGTH_REQUIRED, "411", 公开,
.常量 HSC_LOCKED, "423", 公开,
.常量 HSC_LOOP_DETECTED, "508", 公开,
.常量 HSC_METHOD_NOT_ALLOWED, "405", 公开,
.常量 HSC_MISDIRECTED_REQUEST, "421", 公开,
.常量 HSC_MOVED_PERMANENTLY, "301", 公开,
.常量 HSC_MOVED_TEMPORARILY, "302", 公开,
.常量 HSC_MULTI_STATUS, "207", 公开,
.常量 HSC_MULTIPLE_CHOICES, "300", 公开,
.常量 HSC_NETWORK_AUTHENTICATION_REQUIRED, "511", 公开,
.常量 HSC_NO_CONTENT, "204", 公开,
.常量 HSC_NON_AUTHORITATIVE_INFORMATION, "203", 公开,
.常量 HSC_NOT_ACCEPTABLE, "406", 公开,
.常量 HSC_NOT_EXTENDED, "510", 公开,
.常量 HSC_NOT_FOUND, "404", 公开,
.常量 HSC_NOT_IMPLEMENTED, "501", 公开,
.常量 HSC_NOT_MODIFIED, "304", 公开,
.常量 HSC_OK, "200", 公开,
.常量 HSC_PARTIAL_CONTENT, "206", 公开,
.常量 HSC_PAYMENT_REQUIRED, "402", 公开,
.常量 HSC_PERMANENT_REDIRECT, "308", 公开,
.常量 HSC_PRECONDITION_FAILED, "412", 公开,
.常量 HSC_PRECONDITION_REQUIRED, "428", 公开,
.常量 HSC_PROCESSING, "102", 公开,
.常量 HSC_PROXY_AUTHENTICATION_REQUIRED, "407", 公开,
.常量 HSC_REQUEST_ENTITY_TOO_LARGE, "413", 公开,
.常量 HSC_REQUEST_HEADER_FIELDS_TOO_LARGE, "431", 公开,
.常量 HSC_REQUEST_TIMEOUT, "408", 公开,
.常量 HSC_REQUEST_URI_TOO_LONG, "414", 公开,
.常量 HSC_REQUESTED_RANGE_NOT_SATISFIABLE, "416", 公开,
.常量 HSC_RESET_CONTENT, "205", 公开,
.常量 HSC_RETRY_WITH, "449", 公开,
.常量 HSC_SEE_OTHER, "303", 公开,
.常量 HSC_SERVICE_UNAVAILABLE, "503", 公开,
.常量 HSC_SWITCH_PROXY, "306", 公开,
.常量 HSC_SWITCHING_PROTOCOLS, "101", 公开,
.常量 HSC_TEMPORARY_REDIRECT, "307", 公开,
.常量 HSC_TOO_MANY_REQUESTS, "429", 公开,
.常量 HSC_UNAUTHORIZED, "401", 公开,
.常量 HSC_UNAVAILABLE_FOR_LEGAL_REASONS, "451", 公开,
.常量 HSC_UNORDERED_COLLECTION, "425", 公开,
.常量 HSC_UNPARSEABLE_RESPONSE_HEADERS, "600", 公开,
.常量 HSC_UNPROCESSABLE_ENTITY, "422", 公开,
.常量 HSC_UNSUPPORTED_MEDIA_TYPE, "415", 公开,
.常量 HSC_UPGRADE_REQUIRED, "426", 公开,
.常量 HSC_USE_PROXY, "305", 公开,
.常量 HSC_VARIANT_ALSO_NEGOTIATES, "506", 公开,
.常量 HTTP_METHOD_CONNECT, "“CONNECT”", 公开,
.常量 HTTP_METHOD_DELETE, "“DELETE”", 公开,
.常量 HTTP_METHOD_GET, "“GET”", 公开,
.常量 HTTP_METHOD_HEAD, "“HEAD”", 公开,
.常量 HTTP_METHOD_OPTIONS, "“OPTIONS”", 公开,
.常量 HTTP_METHOD_PATCH, "“PATCH”", 公开,
.常量 HTTP_METHOD_POST, "“POST”", 公开,
.常量 HTTP_METHOD_PUT, "“PUT”", 公开,
.常量 HTTP_METHOD_TRACE, "“TRACE”", 公开,
.常量 HUF_FRAGMENT, "5", 公开, 片段
.常量 HUF_HOST, "1", 公开, 主机
.常量 HUF_MAX, "7", 公开, 最大
.常量 HUF_PATH, "3", 公开, 路径
.常量 HUF_PORT, "2", 公开, 端口
.常量 HUF_QUERY, "4", 公开, 查询
.常量 HUF_SCHEMA, "0", 公开, 概要
.常量 HUF_USERINFO, "6", 公开, 用户信息
.常量 HUT_HTTP_TUNNEL, "2", 公开, HTTP 隧道
.常量 HUT_NONE, "0", 公开, 没有升级
.常量 HUT_UNKNOWN, "-1", 公开, 未知类型
.常量 HUT_WEB_SOCKET, "1", 公开, WebSocket
.常量 HV_1_0, "1", 公开, HTTP/1.0
.常量 HV_1_1, "257", 公开, HTTP/1.1
.常量 IPT_ALL, "0", 公开, 所有
.常量 IPT_IPV4, "1", 公开, IPv4
.常量 IPT_IPV6, "2", 公开, IPv6
.常量 MAX_WS_HEADER_LEN, "14", 公开,
.常量 MIN_WS_HEADER_LEN, "2", 公开,
.常量 NV_SEPARATOR_CHAR, "=", 公开,
.常量 OSSP_CLOSE, "1", 公开, 同步 OnClose :只同步 OnClose 事件,此时可能同时触发 OnReceive 事件
.常量 OSSP_NONE, "0", 公开, 不同步(默认) :不同步 OnSend 事件,此时可能同时触发 OnReceive 和 OnClose 事件
.常量 OSSP_RECEIVE, "2", 公开, 同步 OnReceive :(只用于 TCP 组件)同步 OnReceive 和 OnClose 事件,此处不可能同时触发 OnReceive 或 OnClose 事件
.常量 RAP_ADDR_AND_PORT, "2", 公开, 重用地址和端口
.常量 RAP_ADDR_ONLY, "1", 公开, 仅重用地址
.常量 RAP_NONE, "0", 公开, 不重用
.常量 SE_CONNECT_SERVER, "11", 公开, 连接服务器失败
.常量 SE_CP_CREATE, "7", 公开, 创建完成端口失败
.常量 SE_DATA_PROC, "13", 公开, 数据处理错误
.常量 SE_DATA_SEND, "14", 公开, 数据发送失败
.常量 SE_DETECT_THREAD_CREATE, "9", 公开, 创建监测线程失败
.常量 SE_ILLEGAL_STATE, "1", 公开, 当前状态不允许操作
.常量 SE_INVALID_PARAM, "2", 公开, 非法参数
.常量 SE_NETWORK, "12", 公开, 网络错误
.常量 SE_OK, "0", 公开, 成功
.常量 SE_SOCKE_ATTACH_TO_CP, "10", 公开, 绑定完成端口失败
.常量 SE_SOCKET_BIND, "4", 公开, 绑定 SOCKET 失败
.常量 SE_SOCKET_CREATE, "3", 公开, 创建 SOCKET 失败
.常量 SE_SOCKET_LISTEN, "6", 公开, 监听 SOCKET 失败
.常量 SE_SOCKET_PREPARE, "5", 公开, 设置 SOCKET 失败
.常量 SE_SSL_ENV_NOT_READY, "101", 公开, SSL 环境未就绪
.常量 SE_WORKER_THREAD_CREATE, "8", 公开, 创建工作线程失败
.常量 SET_COOKIE_HEADER, "“Set-Cookie”", 公开,
.常量 SO_ACCEPT, "1", 公开, 接受
.常量 SO_CLOSE, "5", 公开, 关闭
.常量 SO_CONNECT, "2", 公开, 连接
.常量 SO_RECEIVE, "4", 公开, 接收
.常量 SO_SEND, "3", 公开, 发送
.常量 SO_UNKNOWN, "0", 公开, 未知
.常量 SP_DIRECT, "2", 公开, 直接模式 :对每一个发送操作都直接投递,适用于负载不高但要求实时性较高的场合
.常量 SP_PACK, "0", 公开, 打包模式(默认) :尽量把多个发送操作的数据组合在一起发送,增加传输效率
.常量 SP_SAFE, "1", 公开, 安全模式 :尽量把多个发送操作的数据组合在一起发送,并控制传输速度,避免缓冲区溢出
.常量 SS_STARTED, "1", 公开, 已经启动
.常量 SS_STARTING, "0", 公开, 正在启动
.常量 SS_STOPPED, "3", 公开, 已经停止
.常量 SS_STOPPING, "2", 公开, 正在停止
.常量 SSL_SM_CLIENT, "0", 公开, 客户端模式
.常量 SSL_SM_SERVER, "1", 公开, 服务端模式
.常量 SSL_SSI_CERT, "8", 公开, SSL Cert (输出类型:X509*)
.常量 SSL_SSI_CIPHERS, "11", 公开, SSL Available Ciphers(输出类型:STACK_OF(SSL_CIPHER)*)
.常量 SSL_SSI_CLIENT_CIPHERS, "12", 公开, SSL Client Ciphers (输出类型:STACK_OF(SSL_CIPHER)*)
.常量 SSL_SSI_CTX, "0", 公开, SSL CTX (输出类型:SSL_CTX*)
.常量 SSL_SSI_CTX_CERT_STORE, "3", 公开, SSL CTX Cert Store (输出类型:X509_STORE*)
.常量 SSL_SSI_CTX_CIPHERS, "2", 公开, SSL CTX Ciphers (输出类型:STACK_OF(SSL_CIPHER)*)
.常量 SSL_SSI_CTX_METHOD, "1", 公开, SSL CTX Mehtod (输出类型:SSL_METHOD*)
.常量 SSL_SSI_CURRENT_CIPHER, "10", 公开, SSL Current Cipher (输出类型:SSL_CIPHER*)
.常量 SSL_SSI_MAX, "15", 公开,
.常量 SSL_SSI_METHOD, "7", 公开, SSL Method (输出类型:SSL_METHOD*)
.常量 SSL_SSI_MIN, "0", 公开,
.常量 SSL_SSI_PEER_CERT, "13", 公开, SSL Peer Cert (输出类型:X509*)
.常量 SSL_SSI_PEER_CERT_CHAIN, "14", 公开, SSL Peer Cert Chain (输出类型:STACK_OF(X509)*)
.常量 SSL_SSI_PKEY, "9", 公开, SSL Private Key (输出类型:EVP_PKEY*)
.常量 SSL_SSI_SERVER_NAME, "5", 公开, Server Name (输出类型:LPCSTR)
.常量 SSL_SSI_SERVER_NAME_TYPE, "4", 公开, Server Name Type (输出类型:int)
.常量 SSL_SSI_VERIFIED_CHAIN, "15", 公开, SSL Verified Chain (输出类型:STACK_OF(X509)*)
.常量 SSL_SSI_VERSION, "6", 公开, SSL Version (输出类型:LPCSTR)
.常量 SSL_VM_CLIENT_ONCE, "4", 公开,
.常量 SSL_VM_FAIL_IF_NO_PEER_CERT, "2", 公开, 如果没有相同证书失败
.常量 SSL_VM_NONE, "0", 公开, 没有
.常量 SSL_VM_PEER, "1", 公开, 相同证书
.常量 STR_HTTP_1_0, "“HTTP/1.0”", 公开,
.常量 STR_HTTP_1_1, "“HTTP/1.1”", 公开,
.常量 TBT_ATTACH, "2", 公开, 附属->执行浅拷贝,但 TSocketTask 对象会获得 pBuffer 的所有权,并负责释放 pBuffer,避免多次缓冲区拷贝,-> 注意:pBuffer 必须由 SYS_Malloc() 函数分配才能使用本类型,否则可能会发生内存访问错误
.常量 TBT_COPY, "0", 公开, 深拷贝->pBuffer 复制到 TSocketTask 对象。此后 TSocketTask 对象与 pBuffer 不再有任何关联,-> 适用于 pBuffer 不大或 pBuffer 生命周期不受控的场景
.常量 TBT_REFER, "1", 公开, 浅拷贝->pBuffer 不复制到 TSocketTask 对象,需确保 TSocketTask 对象生命周期内 pBuffer 必须有效,-> 适用于 pBuffer 较大或 pBuffer 可重用,并且 pBuffer 生命周期受控的场景
.常量 TRANSFER_ENCODING_HEADER, "“Transfer-Encoding”", 公开,
.常量 TRP_CALL_FAIL, "0", 公开, 立刻返回失败
.常量 TRP_CALLER_RUN, "2", 公开, 调用者线程直接执行
.常量 TRP_WAIT_FOR, "1", 公开, 等待(直到成功、超时或线程池关闭等原因导致失败)
.常量 UPGRADE_HEADER, "“Upgrade”", 公开,
.常量 WEB_SOCKET_HEADER_VALUE, "“WebSocket”", 公开,