reactor的原理与实现

目录

1.  Reactor模型

2.  Reactor 模型有三个重要的组件:

3.  reactor所需要结构体分析

4.  epoll对fd操作的封装

5.  reactor的操作

6.  事件的回调函数

 7.  完整代码和测试结果

总结


1.  Reactor模型

普通函数调用的机制:

        程序调用某函数,函数执行,程序等待,函数将结果和控制权返回给程序,程序继续处理。

        

什么是Reactor?

        Reactor释义“反应堆”,框架:是一种事件驱动的反应堆模式,高效的事件处理模型。和普通函数调用的不同之处在于:应用程序不是主动的调用某个API完成处理,而是恰恰相反,Reactor逆置了事件处理流程,应用程序需要提供相应的接口并注册到Reactor上,如果相应的时间发生,Reactor将主动调用应用程序注册的接口,这些接口又称为“回调函数”。

        reactor反应堆:当有事件,事件类型可能不相同,需要提前注册好不同的事件处理函数。由epoll_wait获取同时到来的多个事件,并且根据数据的不同类型将事件分发给事件处理机制(事件处理器),需要提前注册的哪些接口函数。

2.  Reactor 模型有三个重要的组件:

1.多路复用器:由操作系统提供,在 linux 上一般是 select, poll, epoll 等系统调用。

2. 事件分发器:将多路复用器中返回的就绪事件分到对应的处理函数中。

 

3. 事件处理器:负责处理特定事件的处理函数。

具体流程如下:

1. 注册读就绪事件和相应的事件处理器;

2. 事件分离器等待事件;

3. 事件到来,激活分离器,分离器调用事件对应的处理器;

4. 事件处理器完成实际的读操作,处理读到的数据,注册新的事件,然后返还控制

权。

3.  reactor所需要结构体分析

1. 管理每一个fd的结构体

//管理每一个io fd的结构体
struct ntyevent{
	int fd; //io fd
	int events;
	void *arg;
	int (*callback)(int fd, int events, void* arg); //执行回调函数

	int status;	//判断是否已有事件
	char buffer[BUFFER_LENGTH]; //用户缓冲区
	int length; //用户缓冲区长度
};

 2. 管理ntyevent fd的块

//管理ntyevent fd的块
struct eventblock{
	struct eventblock* next; //指向ntyevent fd集合
	struct ntyevent* events; //指向下一个ntyevent fd的块
};

 3. Reactor结构体

//reacotr结点
struct ntyreactor{
	int epfd;	//epoll fd
	int blkcnt;	//ntyevent fd的块 计数

	struct eventblock* evblks;	//指向ntyevent fd的块头结点
};

4.  epoll对fd操作的封装

//io fd结构体设置
void nty_event_set(struct ntyevent* ev, int fd, NCALLBACK callback, void* arg)
{
	ev->fd = fd;
	ev->callback = callback;
	ev->events = 0;
	ev->arg = arg;

	return ;
}

//io fd add 事件
int nty_event_add(int epfd, int events, struct ntyevent *ev)
{
	struct epoll_event ep_ev = {0, {0}};
	ep_ev.data.ptr = ev;				//io fd结构体
	ep_ev.events = ev->events = events; //需要检测的fd事件

	int op; //操作类型
	if(ev->status == 1){
		op = EPOLL_CTL_MOD; //修改
	}else{
		op = EPOLL_CTL_ADD; //添加
		ev->status = 1;		//标志已经添加
	}
		
	if(epoll_ctl(epfd, op, ev->fd, &ep_ev) <0 ){ //绑定
		printf("event add failed [fd=%d], events[%d]\n", ev->fd, events);
		return -1;
	}

	return 0;
}

//io fd del 事件
int nty_event_del(int epfd, struct ntyevent* ev)
{
	struct epoll_event ep_ev = {0, {0}};
	if(ev->status != 1){ //没有添加过检测的fd事件
		return -1;
	}

	ep_ev.data.ptr = ev;
	ev->status = 0; //标志未添加
	epoll_ctl(epfd, EPOLL_CTL_DEL, ev->fd, &ep_ev);
	return 0;
}

5.  reactor的操作

//reactor扩展大小
int ntyreactor_alloc(struct ntyreactor* reactor)
{
	if(reactor == NULL) return -1;
	if(reactor->evblks == NULL) return -1;

	struct eventblock* blk = reactor->evblks; //块的头结点

	//找尾节点
	while(blk->next != NULL){  //找到尾节点
		blk = blk->next;
	}

	struct ntyevent* evs = (struct ntyevent*)malloc((MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));
	if (evs == NULL) {
		printf("ntyreactor_alloc ntyevent failed\n");
		return -2;
	}
	memset(evs, 0, (MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));

	struct eventblock *block = malloc(sizeof(struct eventblock));
	if (block == NULL) {
		printf("ntyreactor_alloc eventblock failed\n");
		return -3;
	}
	//io fd集合连接成块
	block->events = evs;
	block->next = NULL;

	//指向新块
	blk->next = block;
	reactor->blkcnt ++;

	return 0;
}

//根据io fd来找fd结构体
struct ntyevent *ntyreactor_idx(struct ntyreactor *reactor, int sockfd) {
	if (reactor == NULL) return NULL;
	if (reactor->evblks == NULL) return NULL;

	int blkidx = sockfd / MAX_EPOLL_EVENTS; //在哪一个块
	while (blkidx >= reactor->blkcnt) {		//大小不够扩容
		ntyreactor_alloc(reactor);
	}

	int i = 0;
	struct eventblock *blk = reactor->evblks; //头结点块
	while (i++ != blkidx && blk != NULL) {    //找到所在的块
		blk = blk->next;
	}

	return &blk->events[sockfd % MAX_EPOLL_EVENTS]; //返回fd结构体
}

//reactor初始化
int ntyreactor_init(struct ntyreactor* reactor)
{
	if(reactor == NULL) return -1;
	memset(reactor, 0, sizeof(struct ntyreactor));

	reactor->epfd = epoll_create(1); 
	if (reactor->epfd <= 0) {
		printf("create epfd in %s err %s\n", __func__, strerror(errno));
		return -2;
	}

	//创建第一个块
	struct ntyevent* evs = (struct ntyevent*)malloc((MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));
	if (evs == NULL) {
		printf("create epfd in %s err %s\n", __func__, strerror(errno));
		close(reactor->epfd);
		return -3;
	}
	memset(evs, 0, (MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));

	struct eventblock *block = malloc(sizeof(struct eventblock));
	if (block == NULL) {
		free(evs);
		close(reactor->epfd);
		return -3;
	}
	block->events = evs;
	block->next = NULL;

	reactor->evblks = block;
	reactor->blkcnt = 1;

	return 0;
}

//销毁reactor
int ntyreactor_destory(struct ntyreactor* reactor)
{
	close(reactor->epfd);

	struct eventblock *blk = reactor->evblks;
	struct eventblock *blk_next;
	while (blk != NULL) {
		blk_next = blk->next;

		free(blk->events);
		free(blk);
		
		blk = blk_next;
	}

	return 0;
}

6.  事件的回调函数

//recv回调
int recv_cb(int fd, int events, void* arg)
{
	struct ntyreactor* reactor = (struct ntyreactor*)arg;
	struct ntyevent* ev = ntyreactor_idx(reactor, fd);	

	if(ev == NULL)return -1;

	int len = recv(fd, ev->buffer, BUFFER_LENGTH, 0);
	nty_event_del(reactor->epfd, ev);

	if (len > 0) {
		
		ev->length = len;
		ev->buffer[len] = '\0';

		printf("recv [%d]:%s\n", fd, ev->buffer);

		//将fd 设置为发送事件
		nty_event_set(ev, fd, send_cb, reactor);
		nty_event_add(reactor->epfd, EPOLLOUT, ev);
		
		
	} else if (len == 0) {  //客户端断开连接

		nty_event_del(reactor->epfd, ev);
		printf("recv_cb --> disconnect\n");
		close(ev->fd);
		 
	} else { //返回错误

		if (errno == EAGAIN && errno == EWOULDBLOCK) { //
			
		} else if (errno == ECONNRESET){
			nty_event_del(reactor->epfd, ev);
			close(ev->fd);
		}
		printf("recv[fd=%d] error[%d]:%s\n", fd, errno, strerror(errno));
		
	}

	return len;
}



//send回调
int send_cb(int fd, int events, void* arg)
{
	struct ntyreactor* reactor = (struct ntyreactor*)arg;
	struct ntyevent* ev = ntyreactor_idx(reactor, fd);

	if (ev == NULL) return -1;

	int len = send(fd, ev->buffer, ev->length, 0);
	if (len > 0) {
		printf("send[fd=%d], [%d]%s\n", fd, len, ev->buffer);

		//发送后,将fd设置为接收事件
		nty_event_del(reactor->epfd, ev);
		nty_event_set(ev, fd, recv_cb, reactor);
		nty_event_add(reactor->epfd, EPOLLIN, ev);
		
	} else { //发送失败

		nty_event_del(reactor->epfd, ev);
		close(ev->fd);

		printf("send[fd=%d] error %s\n", fd, strerror(errno));

	}

	return len;
}


//客户端接入回调
int accept_cb(int fd, int events, void* arg)
{
	struct ntyreactor *reactor = (struct ntyreactor*)arg;
	if (reactor == NULL) return -1;

	struct sockaddr_in client_addr;
	socklen_t len = sizeof(client_addr);

	int clientfd;

	//客户端接入
	if ((clientfd = accept(fd, (struct sockaddr*)&client_addr, &len)) == -1) {
		if (errno != EAGAIN && errno != EINTR) {
			
		}
		printf("accept: %s\n", strerror(errno));
		return -1;
	}

	//设置非阻塞fd
	int flag = 0;
	if ((flag = fcntl(clientfd, F_SETFL, O_NONBLOCK)) < 0) {
		printf("%s: fcntl nonblocking failed, %d\n", __func__, MAX_EPOLL_EVENTS);
		return -1;
	}

	struct ntyevent *event = ntyreactor_idx(reactor, clientfd);

	if (event == NULL) return -1;

	//将该fd设置为recv
	nty_event_set(event, clientfd, recv_cb, reactor);
	nty_event_add(reactor->epfd, EPOLLIN, event);

	printf("new connect [%s:%d], pos[%d]\n", 
		inet_ntoa(client_addr.sin_addr), ntohs(client_addr.sin_port), clientfd);

	return 0;
}

 7.  完整代码和测试结果

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
#include <sys/epoll.h>
#include <arpa/inet.h>
#include <fcntl.h>
#include <unistd.h>
#include <errno.h>

#define  BUFFER_LENGTH  	1024
#define  MAX_EPOLL_EVENTS   1024  //epoll事件数量
#define  SERVER_PORT  		8888
#define  PORT_COUNT			100

typedef int NCALLBACK(int ,int ,void*);

//管理每一个io fd的结构体
struct ntyevent{
	int fd; //io fd
	int events;
	void *arg;
	int (*callback)(int fd, int events, void* arg); //执行回调函数

	int status;	//判断是否已有事件
	char buffer[BUFFER_LENGTH]; //用户缓冲区
	int length; //用户缓冲区长度
};

//管理ntyevent fd的块
struct eventblock{
	struct eventblock* next; //指向ntyevent fd集合
	struct ntyevent* events; //指向下一个ntyevent fd的块
};

//reacotr结点
struct ntyreactor{
	int epfd;	//epoll fd
	int blkcnt;	//ntyevent fd的块 计数

	struct eventblock* evblks;	//指向ntyevent fd的块头结点
};

int recv_cb(int fd, int events, void *arg);
int send_cb(int fd, int events, void *arg);
int accept_cb(int fd, int events, void* arg);

struct ntyevent *ntyreactor_idx(struct ntyreactor *reactor, int sockfd);

//io fd结构体设置
void nty_event_set(struct ntyevent* ev, int fd, NCALLBACK callback, void* arg)
{
	ev->fd = fd;
	ev->callback = callback;
	ev->events = 0;
	ev->arg = arg;

	return ;
}

//io fd add
int nty_event_add(int epfd, int events, struct ntyevent *ev)
{
	struct epoll_event ep_ev = {0, {0}};
	ep_ev.data.ptr = ev;				//io fd结构体
	ep_ev.events = ev->events = events; //需要检测的fd事件

	int op; //操作类型
	if(ev->status == 1){
		op = EPOLL_CTL_MOD; //修改
	}else{
		op = EPOLL_CTL_ADD; //添加
		ev->status = 1;		//标志已经添加
	}
		
	if(epoll_ctl(epfd, op, ev->fd, &ep_ev) <0 ){ //绑定
		printf("event add failed [fd=%d], events[%d]\n", ev->fd, events);
		return -1;
	}

	return 0;
}

//io fd del
int nty_event_del(int epfd, struct ntyevent* ev)
{
	struct epoll_event ep_ev = {0, {0}};
	if(ev->status != 1){ //没有添加过检测的fd事件
		return -1;
	}

	ep_ev.data.ptr = ev;
	ev->status = 0; //标志未添加
	epoll_ctl(epfd, EPOLL_CTL_DEL, ev->fd, &ep_ev);
	return 0;
}

//recv回调
int recv_cb(int fd, int events, void* arg)
{
	struct ntyreactor* reactor = (struct ntyreactor*)arg;
	struct ntyevent* ev = ntyreactor_idx(reactor, fd);	

	if(ev == NULL)return -1;

	int len = recv(fd, ev->buffer, BUFFER_LENGTH, 0);
	nty_event_del(reactor->epfd, ev);

	if (len > 0) {
		
		ev->length = len;
		ev->buffer[len] = '\0';

		printf("recv [%d]:%s\n", fd, ev->buffer);

		//将fd 设置为发送事件
		nty_event_set(ev, fd, send_cb, reactor);
		nty_event_add(reactor->epfd, EPOLLOUT, ev);
		
		
	} else if (len == 0) {  //客户端断开连接

		nty_event_del(reactor->epfd, ev);
		printf("recv_cb --> disconnect\n");
		close(ev->fd);
		 
	} else { //返回错误

		if (errno == EAGAIN && errno == EWOULDBLOCK) { //
			
		} else if (errno == ECONNRESET){
			nty_event_del(reactor->epfd, ev);
			close(ev->fd);
		}
		printf("recv[fd=%d] error[%d]:%s\n", fd, errno, strerror(errno));
		
	}

	return len;
}



//send回调
int send_cb(int fd, int events, void* arg)
{
	struct ntyreactor* reactor = (struct ntyreactor*)arg;
	struct ntyevent* ev = ntyreactor_idx(reactor, fd);

	if (ev == NULL) return -1;

	int len = send(fd, ev->buffer, ev->length, 0);
	if (len > 0) {
		printf("send[fd=%d], [%d]%s\n", fd, len, ev->buffer);

		//发送后,将fd设置为接收事件
		nty_event_del(reactor->epfd, ev);
		nty_event_set(ev, fd, recv_cb, reactor);
		nty_event_add(reactor->epfd, EPOLLIN, ev);
		
	} else { //发送失败

		nty_event_del(reactor->epfd, ev);
		close(ev->fd);

		printf("send[fd=%d] error %s\n", fd, strerror(errno));

	}

	return len;
}


//客户端接入回调
int accept_cb(int fd, int events, void* arg)
{
	struct ntyreactor *reactor = (struct ntyreactor*)arg;
	if (reactor == NULL) return -1;

	struct sockaddr_in client_addr;
	socklen_t len = sizeof(client_addr);

	int clientfd;

	//客户端接入
	if ((clientfd = accept(fd, (struct sockaddr*)&client_addr, &len)) == -1) {
		if (errno != EAGAIN && errno != EINTR) {
			
		}
		printf("accept: %s\n", strerror(errno));
		return -1;
	}

	//设置非阻塞fd
	int flag = 0;
	if ((flag = fcntl(clientfd, F_SETFL, O_NONBLOCK)) < 0) {
		printf("%s: fcntl nonblocking failed, %d\n", __func__, MAX_EPOLL_EVENTS);
		return -1;
	}

	struct ntyevent *event = ntyreactor_idx(reactor, clientfd);

	if (event == NULL) return -1;

	//将该fd设置为recv
	nty_event_set(event, clientfd, recv_cb, reactor);
	nty_event_add(reactor->epfd, EPOLLIN, event);

	printf("new connect [%s:%d], pos[%d]\n", 
		inet_ntoa(client_addr.sin_addr), ntohs(client_addr.sin_port), clientfd);

	return 0;
}

//创建socket监听
int init_sock(short port)
{
	int fd = socket(AF_INET, SOCK_STREAM, 0);
	fcntl(fd, F_SETFL, O_NONBLOCK);

	struct sockaddr_in server_addr;
	memset(&server_addr, 0, sizeof(server_addr));
	server_addr.sin_family = AF_INET;
	server_addr.sin_addr.s_addr = htonl(INADDR_ANY);
	server_addr.sin_port = htons(port);

	bind(fd, (struct sockaddr*)&server_addr, sizeof(server_addr));

	if (listen(fd, 20) < 0) {
		printf("listen failed : %s\n", strerror(errno));
		return -1;
	}

	printf("listen server port : %d\n", port);
	return fd;
}


//reactor扩展大小
int ntyreactor_alloc(struct ntyreactor* reactor)
{
	if(reactor == NULL) return -1;
	if(reactor->evblks == NULL) return -1;

	struct eventblock* blk = reactor->evblks; //块的头结点

	//找尾节点
	while(blk->next != NULL){  //找到尾节点
		blk = blk->next;
	}

	struct ntyevent* evs = (struct ntyevent*)malloc((MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));
	if (evs == NULL) {
		printf("ntyreactor_alloc ntyevent failed\n");
		return -2;
	}
	memset(evs, 0, (MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));

	struct eventblock *block = malloc(sizeof(struct eventblock));
	if (block == NULL) {
		printf("ntyreactor_alloc eventblock failed\n");
		return -3;
	}
	//io fd集合连接成块
	block->events = evs;
	block->next = NULL;

	//指向新块
	blk->next = block;
	reactor->blkcnt ++;

	return 0;
}

//根据io fd来找fd结构体
struct ntyevent *ntyreactor_idx(struct ntyreactor *reactor, int sockfd) {
	if (reactor == NULL) return NULL;
	if (reactor->evblks == NULL) return NULL;

	int blkidx = sockfd / MAX_EPOLL_EVENTS; //在哪一个块
	while (blkidx >= reactor->blkcnt) {		//大小不够扩容
		ntyreactor_alloc(reactor);
	}

	int i = 0;
	struct eventblock *blk = reactor->evblks; //头结点块
	while (i++ != blkidx && blk != NULL) {    //找到所在的块
		blk = blk->next;
	}

	return &blk->events[sockfd % MAX_EPOLL_EVENTS]; //返回fd结构体
}

//reactor初始化
int ntyreactor_init(struct ntyreactor* reactor)
{
	if(reactor == NULL) return -1;
	memset(reactor, 0, sizeof(struct ntyreactor));

	reactor->epfd = epoll_create(1); 
	if (reactor->epfd <= 0) {
		printf("create epfd in %s err %s\n", __func__, strerror(errno));
		return -2;
	}

	//创建第一个块
	struct ntyevent* evs = (struct ntyevent*)malloc((MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));
	if (evs == NULL) {
		printf("create epfd in %s err %s\n", __func__, strerror(errno));
		close(reactor->epfd);
		return -3;
	}
	memset(evs, 0, (MAX_EPOLL_EVENTS) * sizeof(struct ntyevent));

	struct eventblock *block = malloc(sizeof(struct eventblock));
	if (block == NULL) {
		free(evs);
		close(reactor->epfd);
		return -3;
	}
	block->events = evs;
	block->next = NULL;

	reactor->evblks = block;
	reactor->blkcnt = 1;

	return 0;
}

//销毁reactor
int ntyreactor_destory(struct ntyreactor* reactor)
{
	close(reactor->epfd);

	struct eventblock *blk = reactor->evblks;
	struct eventblock *blk_next;
	while (blk != NULL) {
		blk_next = blk->next;

		free(blk->events);
		free(blk);
		
		blk = blk_next;
	}

	return 0;
}

//初始化接收连接socket
int ntyreactor_addlistener(struct ntyreactor* reactor, int sockfd, NCALLBACK *acceptor){
	if (reactor == NULL) return -1;
	if (reactor->evblks == NULL) return -1;

	struct ntyevent* event = ntyreactor_idx(reactor, sockfd);
	if (event == NULL) return -1;

	nty_event_set(event, sockfd, acceptor, reactor);
	nty_event_add(reactor->epfd, EPOLLIN, event);

	return 0;
}

//reactor事件循环
int ntyreactor_run(struct ntyreactor* reactor)
{
	if (reactor == NULL) return -1;
	if (reactor->epfd < 0) return -1;
	if (reactor->evblks == NULL) return -1;
	
	struct epoll_event events[MAX_EPOLL_EVENTS+1];
	
	int checkpos = 0, i;

	while(1){
		int nready = epoll_wait(reactor->epfd, events, MAX_EPOLL_EVENTS, 1000);
		if (nready < 0) {
			printf("epoll_wait error, exit\n");
			continue;
		}

		for(i = 0;i < nready; i++){
			struct ntyevent* ev = (struct ntyevent*)events[i].data.ptr; //发生事件的io fd结构体

			if((events[i].events & EPOLLIN) && (ev->events & EPOLLIN)){
				ev->callback(ev->fd, events[i].events, ev->arg);
			}
			if((events[i].events & EPOLLOUT) && (ev->events & EPOLLOUT)){
				ev->callback(ev->fd, events[i].events, ev->arg);
			}
		
		}

	}

}

int main(int argc, char *argv[]) {

	struct ntyreactor *reactor = (struct ntyreactor*)malloc(sizeof(struct ntyreactor));
	ntyreactor_init(reactor);

	//起始的端口号
	unsigned short port = SERVER_PORT;
	if (argc == 2) {
		port = atoi(argv[1]);
	}

	int i = 0;
	int sockfds[PORT_COUNT] = {0};

	for (i = 0;i < PORT_COUNT;i ++) {
		sockfds[i] = init_sock(port+i);
		ntyreactor_addlistener(reactor, sockfds[i], accept_cb);
	}

	ntyreactor_run(reactor);

	ntyreactor_destory(reactor);
	
	for (i = 0;i < PORT_COUNT;i ++) {
		close(sockfds[i]);
	}
	free(reactor);

	return 0;
}






 运行结果:

总结

本章实现了一个网络经典模型,设计模式reactor 事件循环,事件驱动的反应堆模式.

组件:

事件处理器:回调函数callback    

事件分发器:(将事件分发给对应的事件处理器),

多路复用器:(select poll epoll 等操作系统提供的多路复用技术)

流程:

1. 注册读就绪事件和相应的事件处理器;
2. 事件分离器等待事件;
3. 事件到来,激活分离器,分离器调用事件对应的处理器;
4. 事件处理器完成实际的读操作,处理读到的数据,注册新的事件,然后返还控制
权。 

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值