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

时间 2019-11-18

原文原文链接

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

----------------------------------------------------------------java

通用性编程

通讯组件的惟一职责就是接受和发送字节流，绝对不能参与上层协议解析等工做。
与上层使用者解耦、互不依赖，组件与使用者经过操做接口和监听器接口进行交互，组件实现操做接口为上层提供操做方法；使用者实现监听器接口把本身注册为组件的 Listener，接收组件通知。所以，任何使用者只要实现了监听器接口均可以使用组件；另外一方面，甚至能够本身从新写一个实现方式彻底不一样的组件实现给使用者调用，只要该组件听从组件的操做接口，这也是 DIP 设计原则的体现。

可用性缓存

　　可用性对全部通用组件都是相当重要的，若是太难用还不如本身重头写一个来得方便。所以，组件的操做接口和监听器接口设计得尽可能简单易用（通俗来讲就是“傻瓜化”），这两个接口的主要方法均不超过 5 个。另外，组件彻底封装了全部的底层 Socket 通讯，上层应用看不到任何通讯细节，没必要也不能干预任何通讯操做，Socket 链接被抽象为 Connection ID，该参数做为链接标识提供给上层应用识别不一样的链接。安全

高性能服务器

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

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

伸缩性并发

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

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

*** v3.2.1 更新 ***

> 增长 TcpAgent / TcpPullAgent 通讯组件：

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

对于代理服务器或中转服务器等应用场景，服务器自身也做为客户端向其它服务器发起大规模链接
TcpClient / TcpPullClient 基于 Event Select 通讯模型，每一个组件对象管理一个 Socket，并开启一个线程，不适合上述应用场景
TcpAgent / TcpPullAgent 基于 IOCP 通讯模型，一个组件对象管理多个 Socket，适合用做代理服务器或中转服务器的客户端通讯组件

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 模型）

增长 TcpAgent / TcpPullAgent 使用示例：Agent-PFM / Agent-Pull / Agent-4C
增长 TcpAgent + TcpServer 实现的 HTTP 代理服务器示例：HttpProxy

> 增长 HPSocket for Java SDK：

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

提供 Java 开发包：hpsocket-3.2.1.jar（经过 JNA 实现，目前只支持 Windows 平台）
运行环境：JDK 1.6+，JVM 运行在 server 模式（"java -server"，在 client 模式下性能受影响）
MBCS 和 Unicode 版本分布位于包 org.jessma.hpsocket.mbcs 和 org.jessma.hpsocket.unicode

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 模型

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);

增长示例工程 TestEcho-4J，展现 HPSocket4J 的使用方法（包括 PULL 模型示例和性能测试示例）

> 优化数据收发策略：

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

Server 和 Agent 组件提供如下三种数据发送策略

1）PACK - 打包模式（默认）：尽可能把多个发送操做的数据组合在一块儿，增长传输效率
2）SAFE - 安全模式	  ：尽可能把多个发送操做的数据组合在一块儿，控制传输速度，避免缓冲区溢出
3）DIRECT - 直接模式	  ：对每个发送操做都直接投递，适用于负载不高但要求实时性较高的场合

Server 和 Agent 组件提供如下两种数据接收策略

1）SERIAL - 串行模式（默认）：顺序触发同一链接的 OnReceive 和 OnClose/OnError 事件
2）PARALLEL - 并行模式：在不一样的通讯线程中同时触发同一链接的 OnReceive 和 OnClose/OnError 事件

> 其它更新：

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

IServer 的 GetClientAddress() 方法更名为 GetRemoteAddress()
IClient 的 Send() 方法删除 “CONNID dwConnID” 参数
IClient/IServer/IAgent 的 Send() 方法增长发送数据缓冲区指针偏移量参数 “int iOffset”
增长 EnSendPolicy 枚举类型，IServer/IAgent 增长发送模式设置方法 SetSendPolicy()
增长 EnRecvPolicy 枚举类型，IServer/IAgent 增长接收模式设置方法 SetRecvPolicy()
IServer/IAgent 增长方法：BOOL GetAllConnectionIDs()，获取全部链接的 CONNID
IUdpServer 增长方法：SetPostReceiveCount()，设置 Receive 预投递数量
EnServerError / EnClientError 枚举类型合并为 EnSocketError
EnSocketError / EnHandleResult / EnFetchResult 枚举类型从原所在类中移到外部
IClient/IServer/IAgent 增长方法：BOOL GetPendingDataLength()，获取链接中未发出数据的长度
HPSocket4C.dll 增长方法 SendPart()，支持指定缓冲区指针偏移量
增长 HPSocket for C# SDK（由 int 2e 提供）
增长 HPSocket 易语言支持库（由 Yecate 提供）
公共代码包 vc-common-src 更新为 v2.3.5（参考：vc-common-src v2.3.5 的 Change Log）

> 升级说明：

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

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

*** v3.1.3 更新 ***

> 增长其它语言 Demo：

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

C#
Delphi
E 语言

> Bug Fix：

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

修复 IP 地址判断错误 Bug

1) 客户端链接服务器时，若是服务器 IP 地址满位（12个数字：‘AAA.BBB.CCC.DDD’），IP 地址解析错误
2) 影响组件：全部 TCP/UDP 客户端组件
3) 影响版本：v3.1.2 及以前全部版本

修复域名或主机名的 IP 地址解析错误 Bug

1) 客户端组件经过域名或主机名链接服务器时，可能会解析到错误的 IP 地址
2) 影响组件：全部 TCP/UDP 客户端组件
3) 影响版本：v3.1.2 及以前全部版本

*** 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;
}

*** 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 对象缓存列表设置了锁定时间，提升访问的安全性