libevent簡介[翻譯]11 連線監聽:接收一個TCP連線
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.\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;
}