LibEvent中文帮助文档--第13章【连接监听器:接受一个TCP连接】



LiEvent中文帮助文档--第13章【连接监听器:接受一个TCP连接】

   返回主目录

Libevent

快速可移植非阻塞式网络编程

 

 

修订历史

版本

日期

作者

备注

V1.0

2016-11-15

周勇

Libevent编程中文帮助文档

 

文档是2009-2012年由Nick-Mathewson基于Attribution-Noncommercial-Share Alike许可协议3.0创建,未来版本将会使用约束性更低的许可来创建.

此外,本文档的源代码示例也是基于BSD的"3条款"或"修改"条款.详情请参考BSD文件全部条款.本文档最新下载地址:

英文:http://libevent.org/

中文:http://blog.csdn.net/zhouyongku/article/details/53431750

请下载并运行"gitclonegit://github.com/nmathewson/libevent- book.git"获取本文档描述的最新版本源码.

<<上一章>>

13.连接监听器:接受一个TCP连接

evconnlistener机制提供了一种监听并接受到来的TCP连接的方法.

 

所有的函数和类型这里都定义在event2/listener.h中.除非特别说明,它们首次出现在都在LibEvent2.0.2-alpha中.

 

13.1创建或释放一个evconnlistener

 

接口

struct evconnlistener* evconnlistener_new(struct event_base * base,evconnlistener_cb cb, void* ptr, unsigned flags, int backlog,evutil_socket_t fd);struct evconnlistener* evconnlistener_new_bind(struct event_base * base,evconnlistener_cb cb, void* ptr, unsigned flags, int backlog,const struct sockaddr* sa, int socklen);void evconnlistener_free(struct evconnlistener* lev);

两个 evconnlistener_new*()函数都分配和返回一个新的连接监听器对象.连接监听器使用event_base来得知什么时候在给定的监听套接字上有新的TCP连接.新连接到达时,监听器调用你给出的回调函数.

 

两个函数中,base参数都是监听器用于监听连接的event_base.cb是收到新连接时要调用的回调函数;如果cb为NULL,则监听器是禁用的,直到设置了回调函数为止.ptr指针将传递给回调函数.flags参数控制回调函数的行为,下面会更详细论述.backlog是任何时刻网络栈允许处于还未接受状态的最大未决连接数.更多细节请查看系统的listen()函数文档.如果backlog是负的,libevent会试图挑选一个较好的值;如果为0,libevent认为已

经对提供的套接字调用了 listen().

 

两个函数的不同在于如何建立监听套接字.evconnlistener_new()函数假定已经将套接字绑

定到要监听的端口,然后通过fd传入这个套接字.如果要libevent分配和绑定套接字,可

以调用 evconnlistener_new_bind(),传输要绑定到的地址和地址长度.

____________________________________________________________________________________________________
注意

当使用evconnlistener_new的时候务必确认你的监听socket是非阻塞模式,使用evutil_make_socket_nonblocking或手动设置socket的正确选项.当监听socket处于阻塞模式,将会导致一些无法预知的行为发生.

____________________________________________________________________________________________________

要释放连接监听器,应调用evconnlistener_free().

 

13.1.1可识别的标志

可以给 evconnlistener_new()函数的flags参数传入一些标志.可以用或(OR)运算任意连接下述标志:

• LEV_OPT_LEAVE_SOCKETS_BLOCKING:默认情况下,连接监听器接收新套接字后,会将其设置为非阻塞的,以便将其用于libevent .如果不想要这种行为,可以设置这个标志.

• LEV_OPT_CLOSE_ON_FREE:如果设置了这个选项,释放连接监听器会关闭底层套接字.

• LEV_OPT_CLOSE_ON_EXEC:如果设置了这个选项,连接监听器会为底层套接字设置close-on-exec标志.更多信息请查看fcntl和FD_CLOEXEC的平台文档.

• LEV_OPT_REUSEABLE:某些平台在默认情况下,关闭某监听套接字后,要过一会儿其他套接字才可以绑定到同一个端口.设置这个标志会让libevent标记套接字是可重用的,这样一旦关闭,可以立即打开其他套接字,在相同端口进行监听.

• LEV_OPT_THREADSAFE:为监听器分配锁,这样就可以在多个线程中安全地使用了.这是2.0.8-rc的新功能.

13.1.2连接监听器回调

接口

typedef void ( * evconnlistener_cb)(struct evconnlistener* listener,evutil_socket_t sock, struct sockaddr* addr, int len, void * ptr);

当一个新的连接到来,提供的回调函数将会被调用.参数listener是用于接受连接的连接监听器.产生sock是新的socket.参数addr和len分别是接受的连接地址和地址的长度.参数ptr是传到evconnlistener_new()的用户提供的指针.

 

13.2启用和禁用evconnlistener

 

接口

int evconnlistener_disable(struct evconnlistener* lev);int evconnlistener_enable(struct evconnlistener* lev);

这两个函数临时启用或禁用监听新的连接的功能.

 

13.3调整evconnlistener的回调函数

 

接口

void evconnlistener_set_cb(struct evconnlistener* lev,evconnlistener_cb cb, void* arg);

该函数调整已有evconnlistener的回调函数和回调函数参数.该函数出现在LibEvent2.0.9-rc版本中.

 

13.4检查evconnlistener

 

接口

evutil_socket_t evconnlistener_get_fd(struct evconnlistener* lev);struct event_base* evconnlistener_get_base(struct evconnlistener * lev);

这些函数分别返回了监听器关联的socket和event_base.

evconnlistener_get_fd()函数出现在LibEvent2.0.3-alpha版本中.

 

13.5检查错误

设置一个错误回调函数,当在监听器上调用accept()函数调用失败的时候收集错误信息.在当面临一个不解决就可能锁掉进程的错误条件的时候则显得非常重要.

 

接口

typedef void ( * evconnlistener_errorcb)(struct evconnlistener* lis, void * ptr);void evconnlistener_set_error_cb(struct evconnlistener* lev,evconnlistener_errorcb errorcb);

如果调用 evconnlistener_set_error_cb()函数为监听器设置一个错误回调函数,每次监听器出现错误的时候该函数都会返回.该函数接收监听器作为其第一个参数,传递到evconnlistener_new()接口的参数ptr作为其第二个参数.

 

函数首次出现在LibEvent2.0.8-rc版本中.

 

13.6示例程序:一个echo服务器

 

示例

#include <event2/listener.h>#include <event2/bufferevent.h>#include <event2/buffer.h>#include <arpa/inet.h>#include <string.h>#include <stdlib.h>#include <stdio.h>#include <errno.h>static void echo_read_cb(struct bufferevent* bev, void * ctx){/* This callback is invoked when there is data to read on bev.*/struct evbuffer* input = bufferevent_get_input(bev);struct evbuffer* output = bufferevent_get_output(bev);/* Copy all the data from the input buffer to the output buffer.*/evbuffer_add_buffer(output, input);}static void echo_event_cb(struct bufferevent* bev, short events, void * ctx){if (events & BEV_EVENT_ERROR)perror("Error from bufferevent");if (events & (BEV_EVENT_EOF | BEV_EVENT_ERROR)) {bufferevent_free(bev);}}static voidaccept_conn_cb(struct evconnlistener* listener,evutil_socket_t fd, struct sockaddr* address, int socklen,void* ctx){/* We got a new connection! Set up a bufferevent for it.*/struct event_base* base = evconnlistener_get_base(listener);struct bufferevent* bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);bufferevent_setcb(bev, echo_read_cb, NULL, echo_event_cb, NULL);bufferevent_enable(bev, EV_READ|EV_WRITE);}static void accept_error_cb(struct evconnlistener* listener, void * ctx){struct event_base* base = evconnlistener_get_base(listener);int err = EVUTIL_SOCKET_ERROR();fprintf(stderr, "Got an error %d (%s) on the listener. ""Shutting down.\n", err, evutil_socket_error_to_string(err));event_base_loopexit(base, NULL);}int main(int argc, char** argv){struct event_base* base;struct evconnlistener* listener;struct sockaddr_in sin;int port = 9876;if (argc > 1) {port = atoi(argv[1]);}if (port<=0 || port>65535) {puts("Invalid port");return 1;}base = event_base_new();if (!base) {puts("Couldn’t open event base");return 1;}/* Clear the sockaddr before using it, in case there are extra*platform-specific fields that can mess us up.*/memset(&sin, 0, sizeof(sin));/* This is an INET address*/sin.sin_family = AF_INET;/* Listen on 0.0.0.0*/sin.sin_addr.s_addr = htonl(0);/* Listen on the given port.*/sin.sin_port = htons(port);listener = evconnlistener_new_bind(base, accept_conn_cb, NULL,LEV_OPT_CLOSE_ON_FREE|LEV_OPT_REUSEABLE, -1,(struct sockaddr * )&sin, sizeof(sin));if (!listener) {perror("Couldn’t create listener");return 1;}evconnlistener_set_error_cb(listener, accept_error_cb);event_base_dispatch(base);return 0;}

<<下一章>>