高性能 Socket 组件 HP-Socket v3.2.1-RC2 发布

dumiyue 10年前

HP-Socket

　　HP-Socket 是一套通用的高性能 TCP/UDP Socket 组件，包含服务端组件、客户端组件和 Agent 组件，广泛适用于各种不同应用场景的 TCP/UDP 通信系统，提供 C/C++、C#、Delphi、E、Java 等编程语言开发接口。HP-Socket 对通信层实现完全封装，上层应用不必关注通信层的任何细节；HP-Socket 提供基于事件通知模型的 API 接口，能非常简单高效地整合到新旧应用程序中。为了让使用者能方便快速地学习和使用 HP-Socket，迅速掌握组件的设计思想和使用方法，特此精心制作了大量 Demo 示例，包括 PUSH 模型示例、PULL模型示例和性能测试示例等。HP-Socket 目前运行在 Windows 平台，将来会实现跨平台支持。

----------------------------------------------------------------

通用性

  • 通信组件的唯一职责就是接受和发送字节流，绝对不能参与上层协议解析等工作；
  • 与上层使用者解耦、互不依赖，组件与使用者通过操作接口和监听器接口进行交互，组件实现操作接口为上层提供操作方法；使用者实现监听器接口把自己注册为组件的 Listener，接收组件通知。因此，任何使用者只要实现了监听器接口都可以使用组件；另一方面，甚至可以自己重新写一个实现方式完全不同的组件实现给使用者调用，只要该组件遵从组件的操作接口，这也是 DIP 设计原则的体现。

可用性

　　可用性对所有通用组件都是至关重要的，如果太难用还不如自己重头写一个来得方便。因此，组件的操作接口和监听器接口设计得尽量简单易用（通俗来说就是“傻瓜化”），这两个接口的主要方法均不超过 5 个。另外，组件完全封装了所有的底层 Socket 通信，上层应用看不到任何通信细节，不必也不能干预任何通信操作，Socket 连接被抽象为 Connection ID，该参数作为连接标识提供给上层应用识别不同的连接。

高性能

　　作为底层的通用组件，性能问题是必须考虑的，绝对不能成为系统的瓶颈。而另一方面，从实际出发，根据客户端组件与服务端组件的性能要求采用不同的 Socket 模型。组件在设计上充分考虑了性能、现实使用情景、可用性和实现复杂性等因素，确保满足性能要求的同时又不会写得太复杂。做出以下两点设计决策：

  • 客户端：在单独线程中实现 Socket 通信交互，这样可以避免与主线程或其他线程相互干扰；I/O 模型选择 Event Select 通信模型。每个组件对象管理一个 Socket 连接。
  • 服务端：采用高效的 IOCP 通信模型；利用缓存池技术，在通信的过程中，通常需要频繁的申请和释放内存缓冲区，建立了动态缓存池， 只有当缓存池中没有可用对象时才创建新对象，而当缓存对象过多时则会压缩缓存池；另外，组件的动态内存通过私有堆（Private Heap）机制分配，避免与 new / malloc 竞争同时又减少内存空洞。
  • Agent：对于代理服务器或中转服务器等应用场景，服务器自身也作为客户端向其它服务器发起大规模连接，一个 Agent 组件对象管理多个 Socket 连接，与服务端采用相同的技术架构，可以用作代理服务器或中转服务器的客户端部件。

伸缩性

　　可以根据实际的使用环境要求设置组件的各项性能参数（如：工作线程的数量、各种缓存池的大小、收发缓冲区的大小、Socket 监听队列的大小、Accep 派发的数目以及心跳检查的间隔等）。

　　 (项目主页：点击这里，下载地址：点击这里)

*** v3.2.1 更新 ***

 > 增加 TcpAgent / TcpPullAgent 通信组件：

-----------------
  1. 对于代理服务器或中转服务器等应用场景，服务器自身也作为客户端向其它服务器发起大规模连接
  2. TcpClient / TcpPullClient 基于 Event Select 通信模型，每个组件对象管理一个 Socket，并开启一个线程，不适合上述应用场景
  3. TcpAgent / TcpPullAgent 基于 IOCP 通信模型，一个组件对象管理多个 Socket，适合用作代理服务器或中转服务器的客户端通信组件
  4. TcpAgent / TcpPullAgent 的使用方式依然简单，提供以下接口方法： 
    /* 1) 通知接口方法 */  OnPrepareConnect(CONNID dwConnID, SOCKET socket)  OnConnect(CONNID dwConnID)  OnSend(CONNID dwConnID, const BYTE* pData, int iLength)  OnReceive(CONNID dwConnID, const BYTE* pData, int iLength) //（Push 模型）  OnReceive(CONNID dwConnID, int iLength)      //（Pull 模型）  OnClose(CONNID dwConnID)  OnError(CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode)  OnAgentShutdown()    /* 2) 主要操作方法 */  Start(LPCTSTR pszBindAddress = nullptr, BOOL bAsyncConnect = TRUE)  Stop()  Connect(LPCTSTR pszRemoteAddress, USHORT usPort, CONNID* pdwConnID = nullptr)  Send(CONNID dwConnID, const BYTE* pBuffer, int iLength)  Disconnect(CONNID dwConnID, BOOL bForce = TRUE)  Fetch(CONNID dwConnID, BYTE* pData, int iLength) //（Pull 模型）
  5. 增加 TcpAgent / TcpPullAgent 使用示例：Agent-PFM / Agent-Pull / Agent-4C

     

> 增加 HPSocket for Java SDK：

-----------------
  1. 提供 Java 开发包：hpsocket-3.2.1.jar（通过 JNA 实现，目前只支持 Windows 平台）
  2. 运行环境：JDK 1.6+，JVM 运行在 server 模式（"java -server"，在 client 模式下性能受影响）
  3. MBCS 和 Unicode 版本分布位于包 org.jessma.hpsocket.mbcs 和 org.jessma.hpsocket.unicode
  4. HPSocket for Java SDK 提供以下通信组件： 
    1) TcpServer：TCP 通信服务端组件，支持 PUSH/PULL 模型  2) TcpClient：TCP 通信客户端组件，支持 PUSH/PULL 模型  3) TcpAgent ：TCP 通信 Agent 组件，支持 PUSH/PULL 模型  4) UdpServer：UDP 通信服务端组件，支持 PUSH 模型  5) UdpClient：UDP 通信客户端组件，支持 PUSH 模型
  5. HPSocket4J 的使用方法（以 TcpAgent 为例）： 
    /* 0: 应用程序加入 hpsocket-3.2.1.jar 和 jna-4.1.0.jar */    /* 1: 创建通信组件对象 */  TcpAgent agent = TcpAgent.create(Mode.PUSH);    /* 2: 设置回调函数对象 */  // （可选）  agent.setCallBackOnPrepareConnect(new OnPrepareConnectImpl());  // （可选）  agent.setCallBackOnConnect(new OnConnectImpl());  // （必须）PUSH 模型需要设置 OnReceive 回调函数对象  agent.setCallBackOnReceive(new OnReceiveImpl());  // （必须）PULL 模型需要设置 OnPullReceive 回调函数对象  // agent.setCallBackOnPullReceive(new OnPullReceiveImpl());  // （可选）  agent.setCallBackOnSend(new OnSendImpl());  // （必须）  agent.setCallBackOnClose(new OnCloseImpl());  // （必须）  agent.setCallBackOnError(new OnErrorImpl());  // （可选）  agent.setCallBackOnAgentShutdown(new OnAgentShutdownImpl());    /* 3：启动通信组件 */  agent.start("127.0.0.1", false);    /* 4：连接服务器 */  agent.connect("localhost", (short)5555, pdwConnID);    /* 5：处理通信数据 */  // 响应 OnReceive / OnPullReceive 事件接收数据  // 使用 agent.send(dwConnID, data, data.length) 发送数据    /* 6：关闭通信组件 */  agent.stop();    /* 7：销毁通信组件 */  TcpAgent.destroy(agent);
  6. 增加示例工程 TestEcho-4J，展示 HPSocket4J 的使用方法（包括 PULL 模型示例和性能测试示例）

     

> 优化数据发送策略：

-----------------
  1. IClient/IServer/IAgent 组件的 Send() 方法不直接把数据投递到完成端口
  2. 在高负载情形下，数据会放入发送队列，并进行数据包合并，避免高负载下发生 10055 错误
  3. 当发送大量小数据包时，自动组包机制能大大提高发送效率
  4. 应用程序可以通过 GetPendingDataLength() 获取队列中未发出的数据，从而实现流量控制

> 其它更新：

-----------------
  1. IServer 的 GetClientAddress() 方法改名为 GetRemoteAddress()
  2. IClient 的 Send() 方法删除 “CONNID dwConnID” 参数
  3. IClient/IServer/IAgent 的 Send() 方法增加发送数据缓冲区指针偏移量参数 “int iOffset”
  4. EnServerError / EnClientError 枚举类型合并为 EnSocketError
  5. EnSocketError / EnHandleResult / EnFetchResult 枚举类型从原所在类中移到外部
  6. IClient/IServer/IAgent 增加方法：BOOL GetPendingDataLength()，获取连接中未发出数据的长度
  7. HPSocket4C.dll 增加方法 SendPart()，支持指定缓冲区指针偏移量
  8. 增加 HPSocket for C# SDK（由 int 2e 提供）
  9. 公共代码包 vc-common-src 更新为 v2.3.4（参考：vc-common-src v2.3.4 的 Change Log）

> 升级说明：

-----------------
  1. HP-Socket v3.2.1 在功能上兼容 HP-Socket v3.1.3 及以前版本
  2. 接口有变化，需要根据提示修改程序代码；注意：现有程序不能直接替换 v3.1.3 的 DLL
  3. EnServerError / EnClientError 枚举类型合并为 EnSocketError，注意一些枚举值发生了变化

*** v3.1.3 更新 ***

 > 增加其它语言 Demo：

-----------------
  1. C#
  2. Delphi
  3. E 语言

> Bug Fix：

-----------------
  1. 修复 IP 地址判断错误 Bug
     
    1) 客户端连接服务器时，如果服务器 IP 地址满位（12个数字：‘AAA.BBB.CCC.DDD’），IP 地址解析错误  2) 影响组件：所有 TCP/UDP 客户端组件  3) 影响版本：v3.1.2 及之前所有版本
     
  2. 修复域名或主机名的 IP 地址解析错误 Bug
     
    1) 客户端组件通过域名或主机名连接服务器时，可能会解析到错误的 IP 地址  2) 影响组件：所有 TCP/UDP 客户端组件  3) 影响版本：v3.1.2 及之前所有版本

*** v3.1.2 更新 ***

 > 修改 Server 组件的 OnClose() / OnError() 事件的触发规则：

-----------------
  1. 以前版本的 TCP/UDP Server 组件中，当关闭一个连接时可能会同时触发一个 OnClose() 事件和若干个 OnError() 事件
  2. 由于存在上述可能性，所以应用程序需要对 OnClose() / OnError() 的处理事件代码段进行同步
  3. 从 v3.1.2 开始，当多个 OnClose() / OnError() 事件同时发生时，组件只会向应用程序通知第一个事件，后续事件则忽略
  4. 因此，应用程序在处理 OnClose() / OnError() 事件时不必处理同步，减少了出错的可能和编写同步及检测代码的负担
  5. 示例代码

     
    /* 示例代码一：*/  /*----------------------------------------------------------------------------*/  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;  }

*** v3.1.1 更新 ***

 > 增加导出纯 C 函数的动态链接库 HPSocket4C.dll：

-----------------
  1. 增加代码文件 HPSocket4C.h 和 HPSocket4C.cpp，用于创建 HPSocket4C.dll
  2. 导出纯 C 函数，让其它语言（如：C/C#/Delphi 等）能方便地使用 HPSocket
  3. 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
  4. 动态链接库发行版本 
    (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 缓存机制：

-----------------
  1. Common/Src 增加代码文件 bufferpool.h 和 bufferpool.cpp，实现 Buffer Pool 缓存机制
  2. 通过 Buffer Pool 缓存机制提升内存使用效率，减少动态内存分配和释放操作，避免内存空洞
  3. ICTcpClient 用 CItemPool 和 TItemList 实现发送缓冲区
  4. CUdpClient 用 CItemPool 和 TItemList 实现发送缓冲区
  5. CTcpPullClient 用 CItemPool 和 TItemList 实现发送缓冲区和 PULL 缓冲区
  6. CTcpPullServer 用 CBufferPool 和 TBuffer 实现 PULL 缓冲区

*** v3.0.2 更新 ***

 > 把 HP-Socket 编译为动态链接库：

-----------------

  1. 应用程序可以通过导入源代码或动态链接库方式使用 HP-Socket
  2. 动态链接库使用方法
    方法一：  ------------------------------------------------------------------------------  (0) 应用程序包含 SocketInterface.h 和 HPSocket.h 头文件  (1) 调用 HP_Create_Xxx() 函数创建 HPSocket 对象  (2) 使用完毕后调用 HP_Destroy_Xxx() 函数销毁 HPSocket 对象    方法二：  ------------------------------------------------------------------------------  (0) 应用程序包含 SocketInterface.h 和 HPSocket.h 头文件  (1) 创建 CXxxWrapper 包装器，通过包装器智能指针使用 HPSocket 对象
  3. 动态链接库发行版本
    (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 通信组件：

-----------------

  1. 新增两个 UDP 通信组件：CUdpServer 为服务端组件，CUdpClient 为客户端组件
  2. 服务端组件 CUdpServer 采用 IOCP 通信模型
  3. 客户端组件 CUdpClient 采用 Event Select 通信模型
  4. UDP 通信组件的接口与原 TCP 通信组件一致，简单实用
  5. UDP 通信组件内置通信线路自动监测机制
  6. 新增 UDP 通信组件示例工程 TestEcho-UDP

> 代码重构与优化：

-----------------

  1. 规范所有接口、类以及代码文件的命名
  2. 重构和优化了大量组件代码
  3. 服务端组件加入读写锁机制，有效平衡处理性能与安全性
  4. 服务端组件的 Socket 对象缓存列表设置了锁定时间，提高访问的安全性