接口
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_free()。
可識別的標志
可以給evconnlistener_new()函數的flags參數傳入一些標志。可以用或(OR)運算任意連接下述標志:
l LEV_OPT_LEAVE_SOCKETS_BLOCKING
默認情況下,連接監聽器接收新套接字后,會將其設置為非阻塞的,以便將其用于libevent。如果不想要這種行為,可以設置這個標志。
l LEV_OPT_CLOSE_ON_FREE
如果設置了這個選項,釋放連接監聽器會關閉底層套接字。
l LEV_OPT_CLOSE_ON_EXEC
如果設置了這個選項,連接監聽器會為底層套接字設置close-on-exec標志。更多信息請查看fcntl和FD_CLOEXEC的平臺文檔。
l LEV_OPT_REUSEABLE
某些平臺在默認情況下,關閉某監聽套接字后,要過一會兒其他套接字才可以綁定到同一個端口。設置這個標志會讓libevent標記套接字是可重用的,這樣一旦關閉,可以立即打開其他套接字,在相同端口進行監聽。
l LEV_OPT_THREADSAFE
為監聽器分配鎖,這樣就可以在多個線程中安全地使用了。這是2.0.8-rc的新功能。
連接監聽器回調
接口
typedef void (*evconnlistener_cb)(struct evconnlistener *listener,
evutil_socket_t sock, struct sockaddr *addr, int len, void *ptr);
接收到新連接會調用提供的回調函數。listener參數是接收連接的連接監聽器。sock參數是新接收的套接字。addr和len參數是接收連接的地址和地址長度。ptr是調用evconnlistener_new()時用戶提供的指針。
2 啟用和禁用evconnlistener
接口
int evconnlistener_disable(struct evconnlistener *lev);
int evconnlistener_enable(struct evconnlistener *lev);
這兩個函數暫時禁止或者重新允許監聽新連接。
3 調整evconnlistener的回調函數
接口
void evconnlistener_set_cb(struct evconnlistener *lev,
evconnlistener_cb cb, void *arg);
函數調整evconnlistener的回調函數和其參數。它是2.0.9-rc版本引入的。
4 檢測evconnlistener
接口
evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev);
struct event_base *evconnlistener_get_base(struct evconnlistener *lev);
這些函數分別返回監聽器關聯的套接字和event_base。
evconnlistener_get_fd()函數首次出現在2.0.3-alpha版本。
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。
這個函數在2.0.8-rc版本引入。
6 示例代碼:回顯服務器
示例
#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;
}