libevent學習筆記【使用篇】——8. 連接監聽：接收TCP連接

原文：blog.csdn.com/windeal3203
譯自：http://www.wangafu.net/~nickm/libevent-book/Ref8_listener.html

libevent 提供了一種用於監聽和接受TCP連接的便捷方式——evconnlistener機制

創建和釋放 evconnlistener 的接口

下面接口用於創建和釋放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和evconnlistener_new_bind都用於分配和返回一個新的用於監聽連接的對象。 每個用於監聽的對象都使用event_base來維護一個建立的連接。當有新的TCP 連接發生時，回調函數就會調用。
下面介紹以上接口使用到的參數“

• base： event_base對象。參考event_base。
• cb： 回調函數， 當有新的TCP連接發生時，會喚醒回調函數。
• ptr： 傳遞給回調函數的參數。
• flags： 一些標誌， 後面會進一步介紹。
• backlog： 監聽隊列允許容納的最大連接數。
• fd： 函數evconnlistener_new假設我們已經綁定了套接字到要監聽的端口上，fd參數就是我們已經綁定的socket套接字。
• sa： evconnlistener_new_bind幫助我們綁定監聽地址。sa就是傳入的監聽地址。
• socklen： sa的長度。

如果使用的是evconnlistener_new，需要保證傳入的socket套接字處於non-blocking模式，可以通過evutil_make_socket_nonblocking等方法進行設置

常用的flag值：

• LEV_OPT_LEAVE_SOCKETS_BLOCKING：默認情況下listener會把接收到的連接設置爲non-blocking模式。 這個flag則是將連接設置爲blocking狀態（少用）
• LEV_OPT_CLOSE_ON_FREE：釋放listener時，先關閉潛在的套接字
• LEV_OPT_REUSEABLE：一些系統平臺在默認情況下即使已經關閉了socket，也要等待一段時間才能使用對應的port， 而這個flag則設置成只要已關閉socket就是重新使用對應的port。

關於回調函數

回調函數原型如下：

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

參數解釋如下：

• listener： 即接受連接的lister
• sock： 新連接創建的新套接字
• addr： 連接發起者的地址
• len： 地址長度
• ptr： 從evconnlistener_new和evconnlistener_bind_new傳來的參數。

libevent提供調整回調函數的接口
下面接口可以重新設置回調函數，或者調整回調函數中的參數。

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

開啓和關閉監聽

listener允許臨時關閉和重新開啓監聽

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

Example

#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;
}