HP-Socket 是一套通用的高性能 Windows Socket 组件包,包含服务端组件(IOCP 模型)和客户端组件(Event Select 模型),普遍适用于 Windows 平台的 TCP/UDP 通讯系统。HP-Socket 对通讯层实现彻底封装,上层应用没必要关注通讯层的任何细节;HP-Socket 提供基于事件通知模型的 API 接口,能很是简单高效地整合到各种应用程序中;另外,为了让你们能更方便的学习 HP-Socket,特此精心制做了功能测试示例(Test Echo)、性能测试示例(Test Echo-PFM)、PULL 模型测试示例(Test Echo-Pull) 和 UDP 测试示例(Test Echo-UDP),用户能够经过这几个测试示例入手,迅速掌握组件的设计思想和使用方法。缓存
----------------------------------------------------------------安全
通用性并发
- 通讯组件的惟一职责就是接受和发送字节流,绝对不能参与上层协议解析等工做;
- 与上层使用者解耦、互不依赖,组件与使用者经过操做接口和监听器接口进行交互,组件实现操做接口为上层提供操做方法;使用者实现监听器接口把本身注册为组件的 Listener,接收组件通知。所以,任何使用者只要实现了监听器接口均可以使用组件;另外一方面,甚至能够本身从新写一个实现方式彻底不一样的组件实现给使用者调用,只要该组件听从组件的操做接口,这也是 DIP 设计原则的体现。
可用性app
可用性对全部通用组件都是相当重要的,若是太难用还不如本身重头写一个来得方便。所以,组件的操做接口和监听器接口设计得尽可能简单易用(通俗来讲就是“傻瓜化”),这两个接口的主要方法均不超过 5 个。另外,组件彻底封装了全部的底层 Socket 通讯,上层应用看不到任何通讯细节,没必要也不能干预任何通讯操做,Socket 链接被抽象为 Connection ID,该参数做为链接标识提供给上层应用识别不一样的链接。socket
高性能函数
做为底层的通用组件,性能问题是必须考虑的,绝对不能成为系统的瓶颈。而另外一方面,从实际出发,根据客户端组件与服务端组件的性能要求采用不一样的 Socket 模型。组件在设计上充分考虑了性能、现实使用情景、可用性和实现复杂性等因素,确保知足性能要求的同时又不会写得太复杂。作出如下两点设计决策:性能
- 客户端:在单独线程中实现 Socket 通讯交互。这样能够避免与主线程或其余线程相互干扰;I/O 模型选择 Event Select 通讯模型。
- 服务端:采用 Windows 平台效率最高的 IOCP 通讯模型;利用缓存池技术,在通讯的过程当中,一般须要频繁的申请和释放内存缓冲区,创建了动态缓存池, 只有当缓存池中没有可用对象时才建立新对象,而当缓存对象过多时则会压缩缓存池;另外,组件的动态内存经过私有堆(Private Heap)机制分配,避免与 new / malloc 竞争同时又减小内存空洞。
伸缩性学习
能够根据实际的使用环境要求设置组件的各项性能参数(如:工做线程的数量、各类缓存池的大小、收发缓冲区的大小、Socket 监听队列的大小、Accep 派发的数目以及心跳检查的间隔等)。测试
*** v3.1.2 更新 ***
> 修改 Server 组件的 OnClose() / OnError() 事件的触发规则:
------------------ 之前版本的 TCP/UDP Server 组件中,当关闭一个链接时可能会同时触发一个 OnClose() 事件和若干个 OnError() 事件
- 因为存在上述可能性,因此应用程序须要对 OnClose() / OnError() 的处理事件代码段进行同步
- 从 v3.1.2 开始,当多个 OnClose() / OnError() 事件同时发生时,组件只会向应用程序通知第一个事件,后续事件则忽略
- 所以,应用程序在处理 OnClose() / OnError() 事件时没必要处理同步,减小了出错的可能和编写同步及检测代码的负担
- 示例代码
/* 示例代码一: */
/* -------------------------------------------------------------------------------------- */
ISocketListener::EnHandleResult CServerDlg::OnClose(CONNID dwConnID)
{
// 之前版本:有可能存在并发的 OnClose()/OnError(),要把代码放在临界区中并检测返回值
CCriSecLock locallock(m_csPkgInfo); // <-- 临界区
PVOID pInfo = nullptr;
// <-- 检测返回值
if (m_Server -> GetConnectionExtra(dwConnID, & pInfo) && pInfo != nullptr)
{
m_Server -> SetConnectionExtra(dwConnID, nullptr);
delete pInfo;
}
}
/* 示例代码二: */
/* -------------------------------------------------------------------------------------- */
ISocketListener::EnHandleResult CServerDlg::OnClose(CONNID dwConnID)
{
// v3.1.2 版本:只会接收到一个 OnClose()/OnError() 事件,能安全地移除临界区代码和检测代码
PVOID pInfo = nullptr;
m_Server -> GetConnectionExtra(dwConnID, & pInfo);
ASSERT(pInfo != nullptr);
delete pInfo;
}
> 其它更新:
------------------ 调整 TCP Server 默认参数
1) DEFAULT_SOCKET_LISTEN_QUEUE : 300 2) DEFAULT_ACCEPT_SOCKET_COUNT : 300 3) DEFAULT_FREE_SOCKETOBJ_POOL : 150 4) DEFAULT_FREE_SOCKETOBJ_HOLD : 450 5) DEFAULT_FREE_BUFFEROBJ_POOL : 300 6) DEFAULT_FREE_BUFFEROBJ_HOLD : 900
- 调整 UDP Server 默认参数
1) DEFAULT_FREE_SOCKETOBJ_POOL : 150 2) DEFAULT_FREE_SOCKETOBJ_HOLD : 450 3) DEFAULT_FREE_BUFFEROBJ_POOL : 300 4) DEFAULT_FREE_BUFFEROBJ_HOLD : 900
> 升级说明:
------------------ 使用 HP-Socket v3.1.1 及之前版本的应用程序能够安全升级到 HP-Socket v3.1.2
*** v3.1.1 更新 ***
> 增长导出纯 C 函数的动态连接库 HPSocket4C.dll:
------------------ 增长代码文件 HPSocket4C.h 和 HPSocket4C.cpp,用于建立 HPSocket4C.dll
- 导出纯 C 函数,让其它语言(如:C/C#/Delphi 等)能方便地使用 HPSocket
- HPSocket4C.dll 使用方法
方法一: ------------------------------------------------------------------------------ (0) (C/C++ 程序)包含 HPSocket4C.h 头文件 (1) 调用 ::Create_HP_XxxListener() 函数建立监听器对象 (2) 调用 ::Create_HP_Xxx(pListener) 函数建立 HPSocket 对象 (3) 调用 ::HP_Set_FN_Xxx_OnYyy(pListener, ...) 函数设置监听器的回调函数 (4) 调用相关导出函数操做 HPSocket 对象 (5) ...... ...... (6) 调用 ::Destroy_HP_Xxx(pSocket) 函数销毁 HPSocket 对象 (7) 调用 ::Destroy_HP_XxxListener(pListener) 函数销毁监听器对象 方法二: ------------------------------------------------------------------------------ (1) 应用程序把须要用到的导出函数封装到特定语言的包装类中 (2) 经过包装类封装后,以面向对象的方式使用 HPSocket
- 动态连接库发行版本
(1) x86/HPSocket4C.dll - (32位/MBCS/Release) (2) x86/HPSocket4C_D.dll - (32位/MBCS/DeBug) (3) x86/HPSocket4C_U.dll - (32位/UNICODE/Release) (4) x86/HPSocket4C_UD.dll - (32位/UNICODE/DeBug) (5) x64/HPSocket4C.dll - (64位/MBCS/Release) (6) x64/HPSocket4C_D.dll - (64位/MBCS/DeBug) (7) x64/HPSocket4C_U.dll - (64位/UNICODE/Release) (8) x64/HPSocket4C_UD.dll - (64位/UNICODE/DeBug)
> 全面启用 Buffer Pool 缓存机制:
------------------ Common/Src 增长代码文件 bufferpool.h 和 bufferpool.cpp,实现 Buffer Pool 缓存机制
- 经过 Buffer Pool 缓存机制提高内存使用效率,减小动态内存分配和释放操做,避免内存空洞
- ICTcpClient 用 CItemPool 和 TItemList 实现发送缓冲区
- CUdpClient 用 CItemPool 和 TItemList 实现发送缓冲区
- CTcpPullClient 用 CItemPool 和 TItemList 实现发送缓冲区和 PULL 缓冲区
- CTcpPullServer 用 CBufferPool 和 TBuffer 实现 PULL 缓冲区
*** v3.0.2 更新 ***
> 把 HP-Socket 编译为动态连接库:
-----------------
- 应用程序能够经过导入源代码或动态连接库方式使用 HP-Socket
- 动态连接库使用方法
方法一: ------------------------------------------------------------------------------ (0) 应用程序包含 SocketInterface.h 和 HPSocket.h 头文件 (1) 调用 HP_Create_Xxx() 函数建立 HPSocket 对象 (2) 使用完毕后调用 HP_Destroy_Xxx() 函数销毁 HPSocket 对象 方法二: ------------------------------------------------------------------------------ (0) 应用程序包含 SocketInterface.h 和 HPSocket.h 头文件 (1) 建立 CXxxWrapper 包装器,经过包装器智能指针使用 HPSocket 对象
- 动态连接库发行版本
(1) x86/HPSocket.dll - (32位/MBCS/Release) (2) x86/HPSocket_D.dll - (32位/MBCS/DeBug) (3) x86/HPSocket_U.dll - (32位/UNICODE/Release) (4) x86/HPSocket_UD.dll - (32位/UNICODE/DeBug) (5) x64/HPSocket.dll - (64位/MBCS/Release) (6) x64/HPSocket_D.dll - (64位/MBCS/DeBug) (7) x64/HPSocket_U.dll - (64位/UNICODE/Release) (8) x64/HPSocket_UD.dll - (64位/UNICODE/DeBug)
*** v3.0.1 更新 ***
> 新增 UDP 通讯组件:
-----------------
- 新增两个 UDP 通讯组件:CUdpServer 为服务端组件,CUdpClient 为客户端组件
- 服务端组件 CUdpServer 采用 IOCP 通讯模型
- 客户端组件 CUdpClient 采用 Event Select 通讯模型
- UDP 通讯组件的接口与原 TCP 通讯组件一致,简单实用
- UDP 通讯组件内置通讯线路自动监测机制
- 新增 UDP 通讯组件示例工程 TestEcho-UDP
> 代码重构与优化:
-----------------
- 规范全部接口、类以及代码文件的命名
- 重构和优化了大量组件代码
- 服务端组件加入读写锁机制,有效平衡处理性能与安全性
- 服务端组件的 Socket 对象缓存列表设置了锁定时间,提升访问的安全性
*** v2.2.3 更新 ***
> 链接 ID 的数据类型改成 ‘CONNID’:
-----------------
- 在SocketHelper.h 中定义 CONNID 数据类型(默认:typedef ULONG_PTR CONNID)
- 应用程序能够把 CONNID 定义为其但愿的类型(如:ULONG / ULONGLONG 等)
- 为了便于移植与维护,应用程序的任何地方都应该用‘CONNID’类型引用链接 ID
> 服务端 Socket 组件支持为每一个链接绑定附加数据:
-----------------
- IServerSocket 和 CIocpServer 增长方法 Get/SetConnectionExtra()
- 经过上述两个方法,应用程序能够为每一个链接绑定任意附加数据并把数据获取出来
*** v2.2.2 更新 ***
> 优化心跳检测相关功能:
-----------------
- IServerSocket 和 IClientSocket 的 Get/SetKeepAliveTimes() 方法改成 Get/SetKeepAliveTime()
- CIocpServer 和 CClientSocket 的默认 KeepAliveTime 属性改成 5000
- CIocpServer 和 CClientSocket 的默认 KeepAliveInterval 属性改成 3000
*** v2.2.1 更新 ***
> PULL 模型支持:
-----------------
- ISocketListener 增长 PULL 模型数据接收通知方法 OnReceive(dwConnID, int)
- 增长 PULL Socket 接口 IPullSocket,该接口的 Fetch(dwConnID, pBuffer, iLength) 方法用于抓取通讯数据
> Server:
-----------------
- 服务端 Socket 接口 ISocketServer 更名为 IServerSocket
- 增长 PULL Server Socket 监听器抽象类 CPullServerSocketListener
- 增长 PULL Server Socket 接口 IPullServerSocket
- 增长 PULL Server Socket 实现类 CIocpPullServer
> Client:
-----------------
- 客户端 Socket 接口 ISocketClient 更名为 IClientSocket
- 客户端 Socket 实现类 CSocketClient 更名为 CClientSocket
- 增长 PULL Client Socket 监听器抽象类 CPullClientSocketListener
- 增长 PULL Client Socket 接口 IPullClientSocket
- 增长 PULL Client Socket 实现类 CPullClientSocket