Hp-socket高性能网络库三--tcp组件pack接收模型

一、定义

PACK 模型系列组件是 PUSH 和 PULL 模型的结合体，应用程序不必处理分包（如： PUSH）与数据抓取（如： PULL）， 组件保证每个 OnReceive 事件都向应用程序提供一个完整数据包。
在实际开发中，PACk模型是比较推荐使用一种。

二、原理

PACK 模型组件触发监听器对象的 OnReceive(pSender, dwConnID, pData, iLength)事件时，会保证 pData 是一个完整的数据包。 PACK 模型组件会对应用程序发送的每个数据包自动加上 4 字节（32 位） 的包头， 组件接收到数据时根据包头信息自动分包， 每个完整数据包通过 OnReceive 事件发送给应用程序。
PACK包头格式：

前 10 位 X 为包头标识位， 用于数据包校验。 有效包头标识取值范围 0 ~ 1023（0x3FF），当包头标识等于 0 时不校验包头。 后 22 位 Y 为长度位，记录包体长度。 有效数据包最大长度不能超过 4194303（0x3FFFFF） 字节，默认长度限制为： 262144（0x40000）字节。 应用程序可以通过SetPackHeaderFlag() 和 SetMaxPackSize() 分别设置包头标识与最大包长限制。
通过以上分析可知：

1. 如果选用PACK模型，需要client和server两端都是PACK模型，并且有效包头标识需要设置一样，这样才能c/s之间相互解包成功。

三、编写PACK模型Server端

编码步骤几乎和上一篇push模型步骤一样，有问题的话可以参考上一篇《Hp-Socket高性能网络库一–tcp组件push接收模型》
只需将相应的类型换掉即可

Create_HP_TcpPackServerListener
Create_HP_TcpPackServer

main.cpp如下：

#include "../HpInclude/HPSocket4C.h"
#include <stdio.h>

En_HP_HandleResult __stdcall OnPrepareListen(HP_Server pSender, SOCKET soListen)
{
	TCHAR szAddress[50];
	int iAddressLen = sizeof(szAddress) / sizeof(TCHAR);
	USHORT usPort;

	::HP_Server_GetListenAddress(pSender, szAddress, &iAddressLen, &usPort);
	return HR_OK;
}

En_HP_HandleResult __stdcall OnAccept(HP_Server pSender, HP_CONNID dwConnID, SOCKET soClient)
{
	BOOL bPass = TRUE;
	TCHAR szAddress[50];
	int iAddressLen = sizeof(szAddress) / sizeof(TCHAR);
	USHORT usPort;

	::HP_Server_GetRemoteAddress(pSender, dwConnID, szAddress, &iAddressLen, &usPort);

	const char* msg = "hello world";
	::HP_Server_Send(pSender, dwConnID, (const BYTE*)msg, strlen(msg));

	printf("%s:%d connected...\n", szAddress, usPort);
	return bPass ? HR_OK : HR_ERROR;
}

En_HP_HandleResult __stdcall OnSend(HP_Server pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength)
{
	return HR_OK;
}

En_HP_HandleResult __stdcall OnReceive(HP_Server pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength)
{
	printf("receive data [connID=%d]:%s\n", dwConnID, pData);
	::HP_Server_Send(pSender, dwConnID, pData, iLength);
	return HR_OK;
}

En_HP_HandleResult __stdcall OnClose(HP_Server pSender, HP_CONNID dwConnID, En_HP_SocketOperation enOperation, int iErrorCode)
{
	printf("[connID=%d] closed\n", dwConnID);
	return HR_OK;
}

En_HP_HandleResult __stdcall OnShutdown(HP_Server pSender)
{
	return HR_OK;
}


int main()
{
	HP_TcpServer m_pServer;
	HP_TcpServerListener m_pListener;

	// 创建监听器对象
	m_pListener = ::Create_HP_TcpPackServerListener();
	// 创建 Socket 对象
	m_pServer = ::Create_HP_TcpPackServer(m_pListener);

	// 设置 Socket 监听器回调函数
	::HP_Set_FN_Server_OnPrepareListen(m_pListener, OnPrepareListen);
	::HP_Set_FN_Server_OnAccept(m_pListener, OnAccept);
	::HP_Set_FN_Server_OnSend(m_pListener, OnSend);
	::HP_Set_FN_Server_OnReceive(m_pListener, OnReceive);
	::HP_Set_FN_Server_OnClose(m_pListener, OnClose);
	::HP_Set_FN_Server_OnShutdown(m_pListener, OnShutdown);

	// 设置包头标识与最大包长限制
	::HP_TcpPackServer_SetMaxPackSize(m_pServer, 0xFFF);
	::HP_TcpPackServer_SetPackHeaderFlag(m_pServer, 0x169);

	if (::HP_Server_Start(m_pServer, "127.0.0.1", 6000))
	{
		printf("start tcp server successfully\n");
	}
	else
	{
		printf("start tcp server failed\n");
		return 0;
	}
	getchar();
}

3.1.验证包头

编写好之后，我们用网口助手测试下，server给我们发送的数据，是否加了4字节包头。
运行server

启动网口助手，请求tcp连接，连接上后收到server发送的"hello world"字符串，如下
而 0B 00 40 5A 4字节就是组件自动加上的包头

3.2验证粘包，断包

3.2.1正常情况

用网口助手给server发送带包头的数据
“hello world”==>[0B00405A68656C6C6F20776F726C64]
服务端正常显示，接收到"hello world"字符串

3.2.2断包，粘包情况

1.利用网口助手首先发送一帧包头+"He"这样的字节流，此时服务端onReceive()没有被触发；
2.然后在发送剩下的"llo world+包头+Hello world"字节流，此时服务端onReceive()被触发两次，说明组件内部解包的时候，确实解析出两个完整的数据包，符合预期。

四、最后

通过对PACK模型的调试，可以看到Hp-socket还是很友好的帮我处理好了组包，拆包的工作，能保证每次onReceive()被触发，pData都是一个完整的数据包。
下一步，我们通过查看PACK模型的源码，看代码内部针对组包，拆包的工作是如何处理的。
完整代码已上传码云