从零开始实现一个C++高性能服务器框架----Stream模块

简介

项目介绍：实现了一个基于协程的服务器框架，支持多线程、多协程协同调度；支持以异步处理的方式提高服务器性能；封装了网络相关的模块，包括socket、http、servlet等，支持快速搭建HTTP服务器或WebSokcet服务器。

详细内容：日志模块，使用宏实现流式输出，支持同步日志与异步日志、自定义日志格式、日志级别、多日志分离等功能。线程模块，封装pthread相关方法，封装常用的锁包括（信号量，读写锁，自旋锁等）。IO协程调度模块，基于ucontext_t实现非对称协程模型，以线程池的方式实现多线程，多协程协同调度，同时依赖epoll实现了事件监听机制。定时器模块，使用最小堆管理定时器，配合IO协程调度模块可以完成基于协程的定时任务调度。hook模块，将同步的系统调用封装成异步操作（accept, recv, send等），配合IO协程调度能够极大的提升服务器性能。Http模块，封装了sokcet常用方法，支持http协议解析，客户端实现连接池发送请求，服务器端实现servlet模式处理客户端请求，支持单Reator多线程，多Reator多线程模式的服务器。

Stream模块

1. 主要功能

• 封装了读写操作，支持普通读写以及固定长度读写，方便Http模块使用

2. 功能演示

• 这一部分的功能需要结合Http通信完成，具体可以参考后续文章从零开始实现一个C++高性能服务器框架----Http模块

3. 模块介绍

3.1 Stream

• 基类。支持普通读写以及固定长度读写。其中read、write方法是纯虚函数，子类必须重写。

class Stream
{
public:
    typedef std::shared_ptr<Stream> ptr;

    virtual ~Stream() {}
	virtual int read(void* buffer, size_t length) = 0;
	virtual int read(ByteArray::ptr ba, size_t length) = 0;
	virtual int write(const void* buffer, size_t length) = 0;
	virtual int write(ByteArray::ptr ba, size_t length) = 0;
	
	virtual int readFixSize(void* buffer, size_t length);
	virtual int readFixSize(ByteArray::ptr ba, size_t length);
	virtual int writeFixSize(const void* buffer, size_t length);
	virtual int writeFixSize(ByteArray::ptr ba, size_t length);
};

• 实现了读固定长度readFixSize

 /**
 * @brief 读固定长度的数据
 * @param[out] buffer 接收数据的内存
 * @param[in] length 接收数据的内存大小
 * @return
 *      @retval >0 返回接收到的数据的实际大小
 *      @retval =0 被关闭
 *      @retval <0 出现流错误
 */
int Stream::readFixSize(void* buffer, size_t length) 
{
    size_t offset = 0;		// 偏移量
    int64_t left = length;  // 剩余读的数据
    while(left > 0)
    {
        int64_t len = read((char*)buffer + offset, left);
        if(len <= 0)
        {
            return len;
        }

        offset += len;	
        left -= len;
    }
    return length;
}

• 实现了写固定长度writeFixSize

/**
* @brief 写固定长度的数据
* @param[in] buffer 写数据的内存
* @param[in] length 写入数据的内存大小
* @return
*      @retval >0 返回写入到的数据的实际大小
*      @retval =0 被关闭
*      @retval <0 出现流错误
*/
int Stream::writeFixSize(const void* buffer, size_t length) 
{
    size_t offset = 0;
    int64_t left = length;
    while(left > 0) 
    {
        int64_t len = write((const char*)buffer + offset, left);
        if(len <= 0) 
        {
            return len;
        }
        offset += len;
        left -= len;
    }
    return length;
} 

3.2 SocketStream

• 继承Stream，针对Socket的读写，本质上就是调用了Socket的读写方法

class SocketStream : public Stream 
{
public:
       typedef std::shared_ptr<SocketStream> ptr;
       // owner表示是否直接接管sock，负责它的close
       SocketStream(Socket::ptr sock, bool owner = true);
       ~SocketStream();
	   virtual int read(void* buffer, size_t length) override;
	   virtual int read(ByteArray::ptr ba, size_t length) override;
	   virtual int write(const void* buffer, size_t length) override;
	   virtual int write(ByteArray::ptr ba, size_t length) override;
	   virtual void close() override;
	   bool isConnected() const;

       Address::ptr getRemoteAddress();
       Address::ptr getLocalAddress();
       std::string getRemoteAddressString();
       std::string getLocalAddressString();
};

• 实现的read方法，实际调用的是Socket的recv

/**
* @brief 读取数据
* @param[out] buffer 待接收数据的内存
* @param[in] length 待接收数据的内存长度
* @return
*      @retval >0 返回实际接收到的数据长度
*      @retval =0 socket被远端关闭
*      @retval <0 socket错误
*/
int SocketStream::read(void* buffer, size_t length) 
{
    if(!isConnected()) 
    {
        LOG_INFO(g_logger) << "!isConnected()";
        return -1;
    }
    return m_socket->recv(buffer, length);
}

• 实现的write方法，实际调用的是Socket的send

/**
* @brief 写入数据
* @param[in] buffer 待发送数据的内存
* @param[in] length 待发送数据的内存长度
* @return
*      @retval >0 返回实际接收到的数据长度
*      @retval =0 socket被远端关闭
*      @retval <0 socket错误
*/
int SocketStream::write(const void* buffer, size_t length) 
{
    if(!isConnected()) 
    {
        return -1;
    }
    return m_socket->send(buffer, length);
}