http://www.wangafu.net/~nickm/libevent-book/Ref8_listener.html
创建和释放一个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*()函数都是创建并且返回一个新的连接监听结构体。当有新的TCP连接进来时,一个连接监听使用event_base通知。当一个新的连接到达时,会调用你给定的回调函数。
这两个函数,base参数都是你用来监听连接的event_base。cb是回调函数,当一个连接到达时,会被调用;如果cb是NULL,监听就是禁用的,知道回调函数设置了。ptr指针会被传递到回调函数中。flags控制着监听的行为。backlog参数控制着最大挂起的连接数,也就是网络栈允许在没有接收时等待的个数。如果backlog是负数,Libevent试着使用合适的数值,如果是0,Libevent就认为你已经调用了listen。
这些函数在设置监听socket的时候不一样。evconnlistener_new()认为你已经把socket绑定到对应端口了。如果你想创建并且绑定一起做,可以调用evconnlistener_new_bind(),传递一个sockaddr用来绑定。
提示
如果使用evconnlistener_new,确保你的监听socket是非阻塞的,使用evutil_make_socket_nonblocking设置或是自己手动设置正确。如果传递了阻塞IO,会触发不可预知的错误。
调用evconnlistener_free()释放监听连接
建议的标识
这里有些标识可以通过flags参数传递给evconnlistener_new()。可以传递任意标识,使用或组合在一起。
- LEV_OPT_LEAVE_SOCKETS_BLOCKING
默认情况,当连接监听接收到一个新的socket时,设置位非阻塞,一遍你可以和libevent的一些功能一起使用。如果你不想要这种特性,可以设置这个参数。
- LEV_OPT_CLOSE_ON_FREE
如果设置了这个参数,在释放连接监听的时候,会释放底层的socket
- LEV_OPT_CLOSE_ON_EXEC
设置了这个参数,监听连接就会在底层的监听socket上设置close-on-exec的标识,更多信息参考系统上的fcntl和FD_CLOEXEC
- LEV_OPT_REUSEABLE
在一些平台上,默认情况下,一个监听socket关闭后,另一个socket并不能立马绑定这个端口,为了避免这个问题,设置这个参数可以是libevent标记socket为可用模式,这样,一个关闭后,另一个socket就可以直接在同一个端口打开监听。
- LEV_OPT_THREADSAFE
为监听申请锁,多线程情况下使用是安全的
- LEV_OPT_DISABLED
初始化监听是不可用的,而不是可用的。你可以使用evconnlistener_enable()手动打开
- LEV_OPT_DEFERRED_ACCEPT
如果可能,告诉内核当socket到达时不通知,直到第一份数据可读的时候再通知。如果你的协议在连接开启时不发送数据,不要使用这个设置,因为这样的话会是内核永远都不告诉你连接到达了。并不是所有的平台都支持这个设置,如果不支持,这个设置将不会起任何作用
连接监听回调
接口
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()调用时传递的参数指针。
启用和禁止一个evconnlistener
接口
int evconnlistener_disable(struct evconnlistener *lev);
int evconnlistener_enable(struct evconnlistener *lev);
修改evconnlistener的回调函数
**接口
void evconnlistener_set_cb(struct evconnlistener *lev,
evconnlistener_cb cb, void *arg);
检查evconnlistener
接口
evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev);
struct event_base *evconnlistener_get_base(struct evconnlistener *lev);
这个函数返回listener相关的socket和event_base
检测错误
你可以设置一个出错回调函数,在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作为第二个参数
示例:一个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 void
accept_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.
", 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;
}