接口
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);
兩個(gè)evconnlistener_new*()函數(shù)都分配和返回一個(gè)新的連接監(jiān)聽器對(duì)象。連接監(jiān)聽器使用event_base來得知什么時(shí)候在給定的監(jiān)聽套接字上有新的TCP連接。新連接到達(dá)時(shí)，監(jiān)聽器調(diào)用你給出的回調(diào)函數(shù)。
兩個(gè)函數(shù)中，base參數(shù)都是監(jiān)聽器用于監(jiān)聽連接的event_base。cb是收到新連接時(shí)要調(diào)用的回調(diào)函數(shù)；如果cb為NULL，則監(jiān)聽器是禁用的，直到設(shè)置了回調(diào)函數(shù)為止。ptr指針將傳遞給回調(diào)函數(shù)。flags參數(shù)控制回調(diào)函數(shù)的行為，下面會(huì)更詳細(xì)論述。backlog是任何時(shí)刻網(wǎng)絡(luò)棧允許處于還未接受狀態(tài)的最大未決連接數(shù)。更多細(xì)節(jié)請(qǐng)查看系統(tǒng)的listen()函數(shù)文檔。如果backlog是負(fù)的，libevent會(huì)試圖挑選一個(gè)較好的值；如果為0，libevent認(rèn)為已經(jīng)對(duì)提供的套接字調(diào)用了listen()。
兩個(gè)函數(shù)的不同在于如何建立監(jiān)聽套接字。evconnlistener_new()函數(shù)假定已經(jīng)將套接字綁定到要監(jiān)聽的端口，然后通過fd傳入這個(gè)套接字。如果要libevent分配和綁定套接字，可以調(diào)用evconnlistener_new_bind()，傳輸要綁定到的地址和地址長度。
要釋放連接監(jiān)聽器，調(diào)用evconnlistener_free()。
可識(shí)別的標(biāo)志
可以給evconnlistener_new()函數(shù)的flags參數(shù)傳入一些標(biāo)志。可以用或(OR)運(yùn)算任意連接下述標(biāo)志：
l LEV_OPT_LEAVE_SOCKETS_BLOCKING
默認(rèn)情況下，連接監(jiān)聽器接收新套接字后，會(huì)將其設(shè)置為非阻塞的，以便將其用于libevent。如果不想要這種行為，可以設(shè)置這個(gè)標(biāo)志。
l LEV_OPT_CLOSE_ON_FREE
如果設(shè)置了這個(gè)選項(xiàng)，釋放連接監(jiān)聽器會(huì)關(guān)閉底層套接字。
l LEV_OPT_CLOSE_ON_EXEC
如果設(shè)置了這個(gè)選項(xiàng)，連接監(jiān)聽器會(huì)為底層套接字設(shè)置close-on-exec標(biāo)志。更多信息請(qǐng)查看fcntl和FD_CLOEXEC的平臺(tái)文檔。
l LEV_OPT_REUSEABLE
某些平臺(tái)在默認(rèn)情況下，關(guān)閉某監(jiān)聽套接字后，要過一會(huì)兒其他套接字才可以綁定到同一個(gè)端口。設(shè)置這個(gè)標(biāo)志會(huì)讓libevent標(biāo)記套接字是可重用的，這樣一旦關(guān)閉，可以立即打開其他套接字，在相同端口進(jìn)行監(jiān)聽。
l LEV_OPT_THREADSAFE
為監(jiān)聽器分配鎖，這樣就可以在多個(gè)線程中安全地使用了。這是2.0.8-rc的新功能。
連接監(jiān)聽器回調(diào)
接口
typedef void (*evconnlistener_cb)(struct evconnlistener *listener,
evutil_socket_t sock, struct sockaddr *addr, int len, void *ptr);
接收到新連接會(huì)調(diào)用提供的回調(diào)函數(shù)。listener參數(shù)是接收連接的連接監(jiān)聽器。sock參數(shù)是新接收的套接字。addr和len參數(shù)是接收連接的地址和地址長度。ptr是調(diào)用evconnlistener_new()時(shí)用戶提供的指針。
2 啟用和禁用evconnlistener
接口
int evconnlistener_disable(struct evconnlistener *lev);
int evconnlistener_enable(struct evconnlistener *lev);
這兩個(gè)函數(shù)暫時(shí)禁止或者重新允許監(jiān)聽新連接。
3 調(diào)整evconnlistener的回調(diào)函數(shù)
接口
void evconnlistener_set_cb(struct evconnlistener *lev,
evconnlistener_cb cb, void *arg);
函數(shù)調(diào)整evconnlistener的回調(diào)函數(shù)和其參數(shù)。它是2.0.9-rc版本引入的。
4 檢測(cè)evconnlistener
接口
evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev);
struct event_base *evconnlistener_get_base(struct evconnlistener *lev);
這些函數(shù)分別返回監(jiān)聽器關(guān)聯(lián)的套接字和event_base。
evconnlistener_get_fd()函數(shù)首次出現(xiàn)在2.0.3-alpha版本。
5 偵測(cè)錯(cuò)誤
可以設(shè)置一個(gè)一旦監(jiān)聽器上的accept()調(diào)用失敗就被調(diào)用的錯(cuò)誤回調(diào)函數(shù)。對(duì)于一個(gè)不解決就會(huì)鎖定進(jìn)程的錯(cuò)誤條件，這很重要。
接口
typedef void (*evconnlistener_errorcb)(struct evconnlistener *lis, void *ptr);
void evconnlistener_set_error_cb(struct evconnlistener *lev,
evconnlistener_errorcb errorcb);
如果使用evconnlistener_set_error_cb()為監(jiān)聽器設(shè)置了錯(cuò)誤回調(diào)函數(shù)，則監(jiān)聽器發(fā)生錯(cuò)誤時(shí)回調(diào)函數(shù)就會(huì)被調(diào)用。第一個(gè)參數(shù)是監(jiān)聽器，第二個(gè)參數(shù)是調(diào)用evconnlistener_new()時(shí)傳入的ptr。
這個(gè)函數(shù)在2.0.8-rc版本引入。
6 示例代碼：回顯服務(wù)器
示例
#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.\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;
}