ascs 简明开发教程（十四）：如何编写打包器

QQ交流群：198941541

解包器必须从 ascs::i_packer继承，i_packer接口定义如下：

template<typename MsgType>
class i_packer
{
public:
	typedef MsgType msg_type;
	typedef const msg_type msg_ctype;
	typedef std::list<msg_type> container_type;

protected:
	virtual ~i_packer() {}

public:
	virtual void reset() {}
	virtual msg_type pack_msg(const char* const pstr[], const size_t len[], size_t num, bool native = false) = 0;
	//no native parameter anymore, which means it's always false, if true, you should call direct_(sync_)send_msg instead
	virtual bool pack_msg(msg_type&& msg, container_type& msg_can) {return false;}
	virtual bool pack_msg(msg_type&& msg1, msg_type&& msg2, container_type& msg_can) {return false;}
	virtual bool pack_msg(container_type&& in, container_type& out) {return false;}
	virtual msg_type pack_heartbeat() {return msg_type();}

	//this default implementation is meaningless, just satisfy compilers
	virtual char* raw_data(msg_type& msg) const {return const_cast<char*>(msg.data());}
	virtual const char* raw_data(msg_ctype& msg) const {return msg.data();}
	virtual size_t raw_data_len(msg_ctype& msg) const {return msg.size();}

	msg_type pack_msg(const char* pstr, size_t len, bool native = false) {return pack_msg(&pstr, &len, 1, native);}
	msg_type pack_msg(const std::string& str, bool native = false) {return pack_msg(str.data(), str.size(), native);}
};

有些接口已经有了默认实现，原因是它们不是必须的，注意默认实现并不一定有意义，只是为了让不使用它们的用户，在不重写它们时，也能通过编译而已，下面我们来详细介绍每一个接口：

void reset() 

在对象被重用时由框架调用，如果你的解包器没有成员变量或者它们无需重置，则不用重写。

msg_type pack_msg(const char* const pstr[], const size_t len[], size_t num, bool native = false) 

真正的打包接口，必须重写。num参数是数组的元素个数，pstr[]和len[]都必须至少拥有这么多的元素个数；native参数由框架传入，当你调用send_msg系列函数时，它为false，当你调用send_native_msg系列函数时，它为true。那么打包native消息意义何在呢？比如你有个老工程，打包函数已经写好了，但打包结果并不是msg_type数据类型，此时你就应该调用send_native_msg系列函数来发送消息，那么显然的，在你的打包器里面，当native为true时，就不应该再添加任何协议相关的数据了，只需要简单把数据拷贝或者拼接到msg_type类型消息里面即可，如果原来的打包函数返回的结果刚好就是msg_type呢，那你应该调用direct_send_msg系列函数，不再需要通过打包器打包。如果你要打包的数据已经是msg_type类型但还未打包，那你应该调用相应版本的send_msg函数（带msg_type参数的版本），并重写如下接口（重写时请参考我的packer类，它避免了数据的拷贝和拼接（不是任意协议都可以避免的，看你的协议了））：

virtual bool pack_msg(msg_type&& msg, container_type& msg_can) {return false;}
virtual bool pack_msg(msg_type&& msg1, msg_type&& msg2, container_type& msg_can) {return false;}
virtual bool pack_msg(container_type&& in, container_type& out) {return false;}

msg_type pack_heartbeat() 

打心跳包，由框架调用（只有开启了心跳才会被调用，心跳的开启可以通过宏ASCS_HEARTBEAT_INTERVAL和ASCS_HEARTBEAT_MAX_ABSENCE，或者调用ascs::socket::start_heartbeat函数）。

char* raw_data(msg_type& msg) const
const char* raw_data(msg_ctype& msg) const
size_t raw_data_len(msg_ctype& msg) const

从一个打包好的消息里面，得到真正的数据部分（排除协议数据），不是任意协议都可以实现这三个接口（不拷贝数据的情况下），框架不会使用它们，放在这里只是推荐你去实现（如果可能的话）。

msg_type pack_msg(const char* pstr, size_t len, bool native = false)
msg_type pack_msg(const std::string& str, bool native = false) 

两个helper函数，转换到 msg_type pack_msg(const char* const pstr[], const size_t len[], size_t num, bool native = false) 上去。

 

前面说了那么多，那么哪些协议可以支持不做数据拷贝呢？答案就是协议数据在用户数据的最前面或者最后面，且打包时不改变用户数据。比如ascs库的默认协议 length + body，要发送 “123” 时，如果 "123" 已经在msg_type里面且你不再使用它（以右值引用传给打包器，如果你以 const 引用传入，那还是要拷贝的，因为不能swap它，你还要用），此时可以把包头单独生成在一个msg_type里面并swap到std::list<msg_type>里面，再把 “123” 也swap到std::list<msg_type>里面，就打好包了，没有任何内存拷贝与拼接。这是因为流式套接字没有包边界的概念，所以一个消息（业务上的消息，流式套接字不理解什么叫消息）无论分多少次发送，对方收到的最终数据都是一样的，只要别乱序发送即可。

 

关于如何在运行时替换打包器：

ascs需要的打包器其实是一个i_packer<typename Packer::msg_type>对象指针，但构造client_socket_base和server_socket_base时，为什么需要具体的打包解包器类呢（或者通过宏ASCS_DEFAULT_PACKER和ASCS_DEFAULT_UNPACKER定义）？这是因为ascs无法创建i_packer对象，它是抽象的。所以假设你有两个打包器packer1和packer2，只要它们继承自相同的 template<typename MsgType> class i_packer，就可以运行时相互替换，替换函数如下：

void packer(const std::shared_ptr<i_packer<typename Packer::msg_type>>& _packer_)

注意替换打包器并非线程安全，替换时，需要停止心跳包，并与你发送消息的地方互斥，所以我并不推荐运行时替换打包器，你完全可以把多种打包逻辑写在一个打包器之内，然后通过修改其参数改变其逻辑。

上一篇：ascs 简明开发教程（13） 下一篇：ascs 简明开发教程（15）