thrift之TTransport类体系原理及源码详细解析1-类结构和抽象基类
本章主要介绍Thrift的传输层功能的实现,传输的方式多种多样,可以采用压缩、分帧等,而这些功能的实现都是相互独立,和上一章介绍的协议类实现方式比较雷同,还是先看看这部分的类关系图,如下:
由上面的类关系图可以看出,这部分的功能是相当的强大,所以类比较多且关系错综复杂。但是如果理解清楚了这些类直接的关系就很容易掌握这部分的实现技术和这部分实现的功能。我们把这个类关系图分为三部分来看,第一部分看抽象基类TTransport类,它是所有传输类的基类,有很大一部分类直接从它继承实现它提供或者说定义的接口函数(纯虚函数),这些传输类功能比较单一实现也比较简单;第二部分就是TTransport抽象类的默认实现和相应的子类以及加了一层虚拟传输类,这个传输虚拟类的类继承框架个上一章的协议类虚拟继承框架是相同的实现方案和技术,这样实现可以避免采用虚拟继承方式,因为虚拟继承效率会比较低一些,虚拟继承需要动态绑定技术(运行时去查找和指定具体的实现);第三部分就是各种传输类的对象生成工厂类,负责某一种具体传输类对象的生产。
第一节 抽象基类TTransport
本节介绍的是整个传输层实现的抽象概述,传输层实现的接口都在这个抽象基类中定义。下面看看传输层都实现了哪些接口?
1.辅助传输层的全局模板函数readAll
在开始分析传输层的接口以前先看一个辅助模板函数readAll,它的定义和实现如下:
template <class Transport_> uint32_t readAll(Transport_ &trans, uint8_t* buf, uint32_t len) { uint32_t have = 0; uint32_t get = 0; while (have < len) { get = trans.read(buf+have, len-have);//通过具体的传输类读取剩余的需要读取的数据 if (get <= 0) {//处理数据以读完异常 throw TTransportException(TTransportException::END_OF_FILE, "No more data to read."); } have += get;//已经读取的字节数 } return have;//返回读到的字节数 }
这个函数现实比较简单,就是通过一个while循环来保证需要读取的字节数能够读完,如果字节数不够就会抛出异常。
2.TTransport类的接口定义
下面用一个表格来分析TTransport抽象类定义的接口行为,如下:
函数名称 |
函数参数描述 |
函数作用描述 |
isOpen |
无 |
传输层是否打开 |
peek |
无 |
测试是否有数据可读或者远程那边是否任然打开。当传输是打开的默认为true,不过具体的实现逻辑需要根据可能的条件。 |
open |
无 |
为了通信打开传输层 |
close |
无 |
关闭传输层 |
read read_virt |
uint8_t* buf:读入数据的本地缓存 uint32_t len:需要读取数据的长度 |
尝试读取指定的字节数到字符串 |
readAll readAll_virt |
uint8_t* buf:读入数据的本地缓存 uint32_t len:需要读取数据的长度 |
无论如何都要读取被给长度的数据 |
readEnd |
当读取完成时调用 |
|
write write_virt |
uint8_t* buf:写入数据的本地缓存 uint32_t len:需要写入数据的长度 |
写入字符串到缓存,必须调用flush函数后才真正的写入,下次读取的时候才是可利用的。 |
writeEnd |
无 |
写入完成时调用 |
flush |
无 |
刷新任何被阻塞或缓存的数据真正被写入 |
borrow borrow_virt |
uint8_t* buf:借入数据的缓存 uint32_t *len:需要借入数据的长度 |
尝试返回一个指向len字节的字符串缓存并不是真正的读取消耗它。这个函数主要用于可变长度编码中,因为刚开始不知道具体长度。 |
consume consume_virt |
uint32_t len:消耗数据的长度 |
从传输层消耗len字节的数据,这个需要根据borrow函数具体使用的长度来决定。 |
通常一个传输层的对象要么作为输出要么作为输入,但是通常不能同时作为输入和输出。上面的表格中把所有支持的接口操作都简单的介绍了,后面介绍的具体某一个传输层类的实现都会实现这些接口,只是根据各个子类不同的作用和实现方式有不同而已。特别需要注意的是最后两组函数,这两组函数主要是用于支持可变长度编码的,所以如果传输层对象需要支持可变长度编码必须实现这两组函数。