fdbase.h

socket的事件分发模型

#ifndef FDBASE_H_
#define FDBASE_H_

#include "z_conf.h"

typedef int HRET;

#ifndef CFG_POLL
#define CFG_POLL		1
#endif

#ifndef CFG_EPOLL
#define CFG_EPOLL		0
#endif

const int FDEVENT_IN	= 1;
const int FDEVENT_OUT	= 2;
const int FDEVENT_ERR	= 4;
const int FDEVENT_HUP	= 8;
const int FDEVENT_PRI	= 16;

/**
 *	@class	fdbase
 *	@brief	可被select轮询的文件描述符的抽象
 *	@remark
 *		通过get_events可得到fdbase当前关注的事件
 *		通过do_read/do_write/do_error/dispatch_events响应文件描述符上发生的事件
 */
class ZBCDLL fdbase
{
public:
	fdbase(){}
	virtual ~fdbase(){}
/**
 *	@brief	取得文件描述符及fdbase当前希望关注的事件
 *	@arg	[out]events		返回当前关注的事件
 *	@return < 0表示错误，>=0为该fdbase关联的文件描述符
 */
	virtual int get_events(int& events) const = 0;	//	取得文件描述符及fdbase当前关注的事件
	virtual int get_fd() const = 0;					//	取得文件描述符
	
	virtual HRET do_read();							//	响应fd可读事件
	virtual HRET do_write();						//	响应fd可写事件
	virtual HRET do_error();						//	响应fd出错事件
	virtual HRET do_hup();							//	EPOLLHUP,对应的文件描述符被挂断
	virtual HRET do_pri();							//	EPOLLPRI,带外数据
};
/**
 *	@brief	响应fd可读事件
 *	@return	< 0表示在do_read内删除了自身，否则表示没有
 *	@remark	
 *		当reactor的wait发现该fdbase上发生可读事件时(即:已接收到数据)，会调用该函数
 */
inline HRET fdbase::do_read()
{
	return 0;
}
/**
 *	@brief	响应fd可写事件
 *	@return	< 0表示在do_write内删除了自身，否则表示没有
 *	@remark	
 *		当reactor的wait发现该fdbase上发生可写事件时(即:能成功发送数据)，会调用该函数
 */
inline HRET fdbase::do_write()
{
	return 0;
}
/**
 *	@brief	响应fd出错事件
 *	@return	< 0表示在do_error内删除了自身，否则表示没有
 *	@remark	
 *		当reactor的wait发现该fdbase上发生错误事件时，会调用该函数
 */
inline HRET fdbase::do_error()
{
	return 0;
}
/**
 *	@brief	响应EPOLLHUP事件
 *	@return	< 0表示在do_hup内删除了自身，否则表示没有
 *	@remark	
 *		该事件只在epoll模型中出现
 */
inline HRET fdbase::do_hup()
{
	return 0;
}
/**
 *	@brief	响应EPOLLPRI事件
 *	@return	< 0表示在do_pri内删除了自身，否则表示没有
 *	@remark	
 *		该事件只在epoll模型中出现
 */
inline HRET fdbase::do_pri()
{
	return 0;
}
#if 0
/**
 *	@brief	响应fd上发生的所有事件
 *	@remark
 *		该方法处理当前侦听到的所有事件。一般是转调用do_read/do_write/do_error
 */
inline void fdbase::dispatch_events(int revents)
{
	if ((revents & FDEVENT_IN) && do_read() < 0){
		return;
	}
	if ((revents & FDEVENT_OUT) && do_write() < 0){
		return;
	}
	if ((revents & FDEVENT_ERR) && do_error() < 0){
		return;
	}
}
#endif

#endif //FDBASE_H_