HP-Socket
高性能网络通信框架
Version - 5.2
Bruce Liang
2018-02-01
项目主页 http://www.oschina.net/p/hp-socket 下载地址 https://github.com/ldcsaa/HP-Socket
1
前 言
HP-Socket 是一套通用的高性能 TCP/UDP/HTTP 通信框架，包含服务端组件、
客户端组件和 Agent 组件，广泛适用于各种不同应用场景的 TCP/UDP/HTTP 通
信系统，提供 C/C++、C#、Delphi、E（易语言）、Java、Python 等编程语言接口。
HP-Socket 对通信层完全封装，应用程序不必关注通信层的任何细节；HP-Socket
提供基于事件通知模型的 API 接口，能非常简单高效地整合到新旧应用程序中。
为了让使用者能方便快速地学习和使用 HP-Socket，迅速掌握框架的设计思
想和使用方法，特此精心制作了大量 Demo 示例（如：PUSH 模型示例、PULL
模型示例、PACK 模型示例、性能测试示例以及其它编程语言示例）。HP-Socket
目前支持 Windows 和 Linux 平台。
通用性
HP-Socket 的唯一职责就是接收和发送字节流，不参与应用程序的协议解析等工作。
HP-Socket 与应用程序通过接口进行交互，并完全解耦。任何应用只要实现了
HP-Socket 的接口规范都可以无缝整合 HP-Socket。
易用性
易用性对所有通用框架都是至关重要的，如果太难用还不如自己从头写一个来得方
便。因此，HP-Socket 的接口设计得非常简单和统一。
HP-Socket 完全封装了所有底层通信细节，应用程序不必也不能干预底层通信操作。
通信连接被抽象为 Connection ID，Connection ID 作为连接的唯一标识提供给应用
程序来处理不同的连接。
HP-Socket 提供 PUSH / PULL / PACK 等接收模型，应用程序可以灵活选择以手工
方式、半自动方式或全自动方式处理封解包，PULL / PACK 接收模型在降低封解包
处理复杂度的同时能大大减少出错几率。
高性能
Server 组件：基于 IOCP / EPOLL 通信模型，并结合缓存池、私有堆等技术实现高
效内存管理，支持超大规模、高并发通信场景。
Agent 组件：Agent 组件实质上是 Multi-Client 组件，与 Server 组件采用相同的技
术架构。一个 Agent 组件对象可同时建立和高效处理大规模 Socket 连接。
Client 组件：基于 Event Select / POLL 通信模型，每个组件对象创建一个通信线程
并管理一个 Socket 连接，适用于小规模客户端场景。
伸缩性
应用程序可以根据不同的容量要求、通信规模和资源状况等现实场景调整 HP-Socket 的
各项性能参数（如：工作线程的数量、缓存池的大小、发送模式和接收模式等），优化资源
配置，在满足应用需求的同时不必过度浪费资源。
项目主页 http://www.oschina.net/p/hp-socket 下载地址 https://github.com/ldcsaa/HP-Socket
2
目 录
前 言................................................................................................................................................. 1
1 概 述 ......................................................................................................................................... 3
1.1 整体架构 ................................................................................................................... 3
1.2 组件分类 ................................................................................................................... 5
1.3 组件接口 ................................................................................................................... 6
1.4 监听器接口 ............................................................................................................... 8
2 框架详述 ................................................................................................................................. 12
2.1 关键概念 ................................................................................................................. 12
2.1.1 接收模型 ......................................................................................................... 12
2.1.2 发送策略 ......................................................................................................... 15
2.1.3 接收策略 ......................................................................................................... 16
2.1.4 连接方式 ......................................................................................................... 16
2.1.5 连接绑定 ......................................................................................................... 18
2.2 Server 组件 ............................................................................................................. 20
2.2.1 接口描述 ......................................................................................................... 20
2.2.2 工作流程 ......................................................................................................... 23
2.3 Agent 组件 .............................................................................................................. 25
2.3.1 接口描述 ......................................................................................................... 25
2.3.2 工作流程 ......................................................................................................... 28
2.4 Client 组件 .............................................................................................................. 29
2.4.1 接口描述 ......................................................................................................... 29
2.4.2 工作流程 ......................................................................................................... 32
3 SSL .......................................................................................................................................... 34
3.1 组件接口 ................................................................................................................. 34
3.2 SSL 运行环境 ......................................................................................................... 36
4 HTTP ....................................................................................................................................... 38
4.1 组件接口 ................................................................................................................. 38
4.2 HTTP 监听器事件 .................................................................................................. 41
4.3 Cookie 管理 ............................................................................................................ 45
5 Linux ....................................................................................................................................... 50
5.1 组件概述 ................................................................................................................. 50
5.2 安装使用 ................................................................................................................. 50
6 使用方式 ................................................................................................................................. 51
6.1 源代码 ..................................................................................................................... 51
6.2 静态库 ..................................................................................................................... 51
6.3 HPSocket DLL ........................................................................................................ 51
6.4 HPSocket4C DLL ................................................................................................... 52
6.5 其它编程语言使用 HPSocket ................................................................................ 53
7 附 录 ....................................................................................................................................... 54
7.1 示例 Demo .............................................................................................................. 54
7.1.1 Windows 示例 ................................................................................................. 54
7.1.2 Linux 示例 ...................................................................................................... 55
7.2 辅助函数 ................................................................................................................. 57
7.3 FAQ ......................................................................................................................... 59
项目主页 http://www.oschina.net/p/hp-socket 下载地址 https://github.com/ldcsaa/HP-Socket
3
1 概 述
1.1 整体架构
HP-Socket 完全封装了底层通信细节，并为应用程序提供一套简单易用的并且与底层通
信完全无关的 API 接口，使应用程序获得高性能、高伸缩性通信的同时，免除处理通信细
节的负担。HP-Socket 的 API 接口模型如图 1.1-1 所示：
图 1.1-1 HP-Socket API 接口模型
HP-Socket 定义了组件接口（如：ITcpServer / IUdpClient）、 组件实现类（如：CTcpServer
/ CUdpClient）和监听器接口（如：ITcpServerListener / IUdpClientListener），其中：
组件接口：声明组件操作方法，应用程序创建组件对象后通过该接口来使用组件
组件实现类：实现组件接口，执行实际通信处理工作，并向监听器报告通信事件
监听器接口：声明组件的通信事件回调方法
每个组件对象都会关联一个监听器对象（监听器对象的实现类由应用程序定义），当组
件对象触发一个通信事件时会调用监听器对象相应的回调方法，应用程序在回调方法中处理
应用业务逻辑。图 1.1-2 以 TCP Agent 为例展示了组件与应用程序的交互：
应用程序首先创建监听器对象和 TCP Agent 对象，创建 TCP Agent 对象时传入监听器对
象，把 TCP Agent 对象与监听器对象关联起来。TCP Agent 对象创建完毕后，应用程序调用
TCP Agent 接口方法操作 TCP Agent 对象（如：Start / Connect / Send / Stop 等）。当 TCP Agent
对象触发通信事件时，会调用监听器对象的回调方法（如：OnConnect / OnSend / OnReceive
/ Onclose 等）通知应用程序。
注意：监听器对象的异步回调方法是在组件的通信线程中执行的，因此回调方法不应
执行耗时较长的业务逻辑代码，同时要注意多线程同步问题，也应尽量避免使用锁。
HP-Socekt
通过设置“连接绑定”能协助应用程序巧妙地避免由于多线程同步和互斥锁
等导致的复杂性和性能问题。
HP-Socket
Component Interface
Listener Interface
Component Implement Class
1
My Application
Listener Implement Class
Logic Controller
项目主页 http://www.oschina.net/p/hp-socket 下载地址 https://github.com/ldcsaa/HP-Socket
4
图 1.1-2 TCP Agent 与应用程序交互示例
My Logic Controller My TCP Agent Listener TCP Agent
ITcpAgentListener := new()
<<create>>
Create Agent & Listener
Start Agent
Connect Operation
Send Operation
OnPrepareConnect Callback
OnConnect Callback
OnSend Callback
OnReceive Callback
OnClose Callback
Stop Operation
OnShutdown Callback
listener
ITcpAgent := new(listener)
<<create>>
agent
Start()
Connect(address, port)
OnPrepareConnect(connid)
OnConnect(connid)
OnHandshake(connid)
OnHandshake Callback
Send(connid, data, length)
OnSend(connid, data, length)
OnReceive(connid, data, length)
OnClose(connid, operation, code)
Stop()
OnShutdown()
