libevent源代码分析--buffer的使用

你可能注意到随着我们代码变得越来越高效,程序也变得更加复杂。当我们产生一个进程的时候,我们没有必要为每一个链接管理一个buffer,我们只需要每个处理独立栈分配缓冲区就可以了。在读和写的时候,我们不必明确的跟踪每一个socket,这在我们的代码里是一个暗示,我们没有必要定义一个结构体去跟踪每一个操作什么时候完成,我们只需要使用循环栈变量就可以了。

         此外,如果你在windows网络编程方面有着丰富的经验,当你在使用上一篇博客中的例子时,你可能认识到libevent可能达不到最理想的性能。在windows上,你做的快速异步IO不是用的select,它使用的IOCP API。和其他的快速网络API不同,当你的程序执行完成,sock准备完成,IOCP不会通知你的程序,取而代之的是,程序告诉windows网络栈开启一个网络操作,并且当操作执行完成时,IOCP会告诉程序。

         幸运的是,libevent2 的bufferevents接口解决了上面的这些冲突,它使得程序更加容易写,并且为windows和unix提供了有效的接口。

分析:

libevent的bufferevent在event的基础上自己维护了一个buffer,这样的话,就不需要再自己管理一个buffer了,上一篇博客是自己维护一个buffer,维护过程复杂,且过程难以理解,既然libevent自己提供了bufferevent这个神器,且有API,何必自己维护呢?

先看看struct bufferevent这个结构体

[cpp] view plain copy
  1. struct bufferevent {  
  2.                struct event_base *ev_base;  
  3.         const struct bufferevent_ops *be_ops;  
  4.         struct event ev_read;  
  5.         struct event ev_write;  
  6.         struct evbuffer *input;  
  7.         struct evbuffer *output;  
  8.         ……  
  9.         bufferevent_data_cb readcb;  
  10.         bufferevent_data_cb writecb;  
  11.         bufferevent_event_cb errorcb;  
  12.         ……  
  13. }  

可以看出struct bufferevent内置了两个event(读/写)和对应的缓冲区。当有数据被读入(input)的时候,readcb被调用,当output被输出完成的时候,writecb被调用,当网络I/O出现错误,如链接中断,超时或其他错误时,errorcb被调用。

使用bufferevent的过程:

1. 设置sock为非阻塞的

[cpp] view plain copy
  1. eg:  evutil_make_socket_nonblocking(fd);  

2. 使用bufferevent_socket_new创建一个structbufferevent *bev,关联该sockfd,托管给event_base

函数原型为:

[cpp] view plain copy
  1. struct bufferevent * bufferevent_socket_new(struct event_base *base, evutil_socket_t fd,  int options)  
  2. eg:  struct bufferevent *bev;  
  3. bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);  

3. 设置读写对应的回调函数

函数原型为:
[cpp] view plain copy
  1. void bufferevent_setcb(struct bufferevent *bufev,  
  2.     bufferevent_data_cb readcb, bufferevent_data_cb writecb,  
  3.     bufferevent_event_cb eventcb, void *cbarg)  
  4. eg.  bufferevent_setcb(bev, readcb, NULL, errorcb, NULL);  

4. 启用读写事件,其实是调用了event_add将相应读写事件加入事件监听队列poll。正如文档所说,如果相应事件不置为true,bufferevent是不会读写数据的

函数原型:
[cpp] view plain copy
  1. int bufferevent_enable(struct bufferevent *bufev, short event)  
  2. eg.  bufferevent_enable(bev, EV_READ|EV_WRITE);  

5. 进入bufferevent_setcb回调函数:

在readcb里面从input中读取数据,处理完毕后填充到output中;

writecb对于服务端程序,只需要readcb就可以了,可以置为NULL;

errorcb用于处理一些错误信息。


针对这些使用过程进入源码进行分析:

1. bufferevent_socket_new

(1)在bufferevent_init_common中调用evbuffer_new()初始化input和output

(2)在event_assign中初始化bufferevent中的ev_read和ev_write事件。

(3)在evbuffer_add_cb中给output添加了一个callback bufferevent_socket_outbuf_cb

2. bufferevent_setcb

该函数的作用主要是赋值,把该函数后面的参数,赋值给第一个参数struct bufferevent *bufev定义的变量

3. bufferevent_enable

调用event_add将读写事件加入到事件监听队列中。

 

对bufferevent常用的几个函数进行分析:

[cpp] view plain copy
  1. char *evbuffer_readln(struct evbuffer*buffer, size_t *n_read_out,enum evbuffer_eol_style eol_style);  

含义:Read a single line from an evbuffer.

返回值:读到的一行内容

[cpp] view plain copy
  1. int evbuffer_add(struct evbuffer *buf,const void *data, size_t datlen);  

含义:将数据添加到evbuffer的结尾

返回值:成功返回0,失败返回-1

[cpp] view plain copy
  1. int evbuffer_remove(struct evbuffer*buf, void *data, size_t datlen);  

含义:从evbuffer读取数据到data

返回值:成功返回0,失败返回-1

[cpp] view plain copy
  1. size_t evbuffer_get_length(const structevbuffer *buf);  

含义:返回evbuffer中存储的字节长度

暂时先分析到这里,下面是代码,客户端发送消息:HTTP/1.0, Client 0 send Message:

Request: Hello Server! over,服务端一条消息收完成后,会回复:Response ok! Hello Client!

服务端从bufferevent中取出消息是按行取的。代码可能有不完善的地方,由于才疏学浅,研究时间短(3天),希望高手提出宝贵意见。

libevent_eventbuffer_server.c

[cpp] view plain copy
  1. #include <netinet/in.h>  
  2. #include <sys/socket.h>  
  3. #include <fcntl.h>  
  4.   
  5. #include <event2/event.h>  
  6. #include <event2/buffer.h>  
  7. #include <event2/bufferevent.h>  
  8.   
  9. #include <assert.h>  
  10. #include <unistd.h>  
  11. #include <string.h>  
  12. #include <stdlib.h>  
  13. #include <stdio.h>  
  14. #include <errno.h>  
  15.   
  16. void do_read(evutil_socket_t fd, short events, void *arg);  
  17.   
  18. //struct bufferevent内建了两个event(read/write)和对应的缓冲区(struct evbuffer *input, *output),并提供相应的函数用来操作>  
  19. 缓冲区(或者直接操作bufferevent)  
  20. //接收到数据后,判断是不一样一条消息的结束,结束标志为"over"字符串  
  21. void readcb(struct bufferevent *bev, void *ctx)  
  22. {  
  23.     printf("called readcb!\n");  
  24.     struct evbuffer *input, *output;  
  25.     char *request_line;  
  26.     size_t len;  
  27.     input = bufferevent_get_input(bev);//其实就是取出bufferevent中的input  
  28.     output = bufferevent_get_output(bev);//其实就是取出bufferevent中的output  
  29.   
  30.     size_t input_len = evbuffer_get_length(input);  
  31.     printf("input_len: %d\n", input_len);  
  32.     size_t output_len = evbuffer_get_length(output);  
  33.     printf("output_len: %d\n", output_len);  
  34.   
  35.     while(1)  
  36.     {  
  37.         request_line = evbuffer_readln(input, &len, EVBUFFER_EOL_CRLF);//从evbuffer前面取出一行,用一个新分配的空字符结束  
  38. 的字符串返回这一行,EVBUFFER_EOL_CRLF表示行尾是一个可选的回车,后随一个换行符  
  39.         if(NULL == request_line)  
  40.         {  
  41.             printf("The first line has not arrived yet.\n");  
  42.             free(request_line);//之所以要进行free是因为 line = mm_malloc(n_to_copy+1)),在这里进行了malloc  
  43.             break;  
  44.         }  
  45.         else  
  46. <span style="white-space: pre;">    </span>{  
  47.             printf("Get one line date: %s\n", request_line);  
  48.             if(strstr(request_line, "over") != NULL)//用于判断是不是一条消息的结束  
  49.             {  
  50.                 char *response = "Response ok! Hello Client!\r\n";  
  51.                 evbuffer_add(output, response, strlen(response));//Adds data to an event buffer  
  52.                 printf("服务端接收一条数据完成,回复客户端一条消息: %s\n", response);  
  53.                 free(request_line);  
  54.                 break;  
  55.             }  
  56.         }  
  57.         free(request_line);  
  58.     }  
  59.   
  60.     size_t input_len1 = evbuffer_get_length(input);  
  61.     printf("input_len1: %d\n", input_len1);  
  62.     size_t output_len1 = evbuffer_get_length(output);  
  63.     printf("output_len1: %d\n\n", output_len1);  
  64. }  
  65.   
  66. void errorcb(struct bufferevent *bev, short error, void *ctx)  
  67. {  
  68.     if (error & BEV_EVENT_EOF)  
  69.     {  
  70.         /* connection has been closed, do any clean up here */  
  71.         printf("connection closed\n");  
  72.     }  
  73.     else if (error & BEV_EVENT_ERROR)  
  74.     {  
  75.         /* check errno to see what error occurred */  
  76.         printf("some other error\n");  
  77.     }  
  78.     else if (error & BEV_EVENT_TIMEOUT)  
  79.     {  
  80.         /* must be a timeout event handle, handle it */  
  81.         printf("Timed out\n");  
  82.     }  
  83.     bufferevent_free(bev);  
  84. }  
  85.   
  86. void do_accept(evutil_socket_t listener, short event, void *arg)  
  87. {  
  88.     struct event_base *base = arg;  
  89.     struct sockaddr_storage ss;  
  90.     socklen_t slen = sizeof(ss);  
  91.     int fd = accept(listener, (struct sockaddr*)&ss, &slen);  
  92.     if (fd < 0)  
  93.     {  
  94.         perror("accept");  
  95.     }  
  96.     else if (fd > FD_SETSIZE)  
  97.     {  
  98.         close(fd);  
  99.     }  
  100.     else  
  101.     {  
  102.         struct bufferevent *bev;  
  103.         evutil_make_socket_nonblocking(fd);  
  104.   
  105.         //使用bufferevent_socket_new创建一个struct bufferevent *bev,关联该sockfd,托管给event_base  
  106.         ////BEV_OPT_CLOSE_ON_FREE表示释放bufferevent时关闭底层传输端口。这将关闭底层套接字,释放底层bufferevent等。  
  107.         bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);  
  108.   
  109.         //设置读写对应的回调函数  
  110.         bufferevent_setcb(bev, readcb, NULL, errorcb, NULL);  
  111. //      bufferevent_setwatermark(bev, EV_READ, 0, MAX_LINE);  
  112.   
  113.         //启用读写事件,其实是调用了event_add将相应读写事件加入事件监听队列poll。正如文档所说,如果相应事件不置为true,buf  
  114. ferevent是不会读写数据的  
  115.         bufferevent_enable(bev, EV_READ|EV_WRITE);  
  116.     }  
  117. }  
  118.   
  119. void run(void)  
  120. {  
  121.     evutil_socket_t listener;  
  122.     struct sockaddr_in sin;  
  123.     struct event_base *base;  
  124.     struct event *listener_event;  
  125.   
  126.     base = event_base_new();  
  127.     if (!base)  
  128.         return/*XXXerr*/  
  129.   
  130.     sin.sin_family = AF_INET;  
  131.     sin.sin_addr.s_addr = 0;  
  132.     sin.sin_port = htons(8000);  
  133.   
  134.     listener = socket(AF_INET, SOCK_STREAM, 0);  
  135.     evutil_make_socket_nonblocking(listener);  
  136.   
  137. #ifndef WIN32  
  138.     {  
  139.         int one = 1;  
  140.         setsockopt(listener, SOL_SOCKET, SO_REUSEADDR, &one, sizeof(one));  
  141.     }  
  142. #endif  
  143.   
  144.     if (bind(listener, (struct sockaddr*)&sin, sizeof(sin)) < 0)  
  145.     {  
  146.         perror("bind");  
  147.         return;  
  148.     }  
  149. if (listen(listener, 16)<0)  
  150.     {  
  151.         perror("listen");  
  152.         return;  
  153.     }  
  154.   
  155.     listener_event = event_new(base, listener, EV_READ|EV_PERSIST, do_accept, (void*)base);  
  156.     /*XXX check it */  
  157.     event_add(listener_event, NULL);  
  158.   
  159.     event_base_dispatch(base);  
  160. }  
  161.   
  162. int main(int argc, char **argv)  
  163. {  
  164.     setvbuf(stdout, NULL, _IONBF, 0);  
  165.   
  166.     run();  
  167.     return 0;  
  168. }  

编译:gcc -I/usr/include-o test libevent_eventbuffer_server.c -L/usr/local/lib –levent

运行:

服务端:

libevent源代码分析--buffer的使用_第1张图片

客户端:

libevent源代码分析--buffer的使用_第2张图片


今晚博客暂时写完了,时间比较仓促,错误估计不会少,关于bufferevent很多API都还不是很熟悉,还有libevent 添加事件event_add是非线程安全的,如果使用多线程,需要保证event_add不能出现在多个线程中,以后有时间慢慢研究。

你可能感兴趣的:(libevent)