libevent （二） 接收TCP連接

libevent 接收TCP連接

Evconnlistener 機制為您提供了偵聽和接受傳入的 TCP 連接的方法。下面的函數全部包含在`<event2/listener.h>`中。

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`，其中第一個函數需要自己綁定套接字，而第二個函數會自動綁定套接字。`evconnlistener`根據`event_base`來判斷TCP連接請求，每當到來一個請求，它就會調用`evconnlistener_cb`回調函數來處理該請求。`ptr`是回調函數的參數，`backlog`指定了`listen`的個數，而`flag`參數如下：

* LEV_OPT_LEAVE_SOCKETS_BLOCKING 設置阻塞
* LEV_OPT_CLOSE_ON_FREE 釋放掉 `evconnlistener`會關閉socket
* LEV_OPT_CLOSE_ON_EXEC 
* LEV_OPT_REUSEABLE `socket`重用
* LEV_OPT_THREADSAFE 為socket增加鎖，用於多線程/多進程操作
* LEV_OPT_DISABLED
* LEV_OPT_DEFERRED_ACCEPT

回調函數如下：

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

`evconnlistener`為接收連接的`evconnlistener`對象，`sock`為套接字，`addr`和`len`為請求的地址和其長度，`ptr`是傳給`evconnlistener_new`的。

開啟和關閉連接監聽

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

改變回調函數

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

檢測當前evconnlistener

evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev); /* 獲取sockfd */
struct event_base *evconnlistener_get_base(struct evconnlistener *lev); /* 獲取event_base */

檢測錯誤

typedef void (*evconnlistener_errorcb)(struct evconnlistener *lis, void *ptr);
void evconnlistener_set_error_cb(struct evconnlistener *lev, evconnlistener_errorcb errorcb);

該函數為錯誤設置回調函數，每當`listener`發生錯誤都會觸發回調函數的執行。

例子

#include <iostream>
#include <event2/event.h>
#include <event2/listener.h>
#include <arpa/inet.h>
#include <stdlib.h>
#include <string.h>

using namespace std;


static void accept_conn_cb(struct evconnlistener *listener, evutil_socket_t fd, struct sockaddr* addr, int len, void *ptr)
{
    /* get libevent event_base from listener */
    struct event_base* base = evconnlistener_get_base(listener);
    cout<<"accept a link"<<endl;
}


int main(int argc, char** argv)
{
    struct event_base* base;

    base = event_base_new();

    struct sockaddr_in sin;

    /* init addr 初始化綁定地址和端口*/
    memset(&sin, 0, sizeof(sin));
    sin.sin_family = AF_INET;
    sin.sin_addr.s_addr = htonl(0);
    sin.sin_port = htons(6666);

    struct evconnlistener* listener;
　　
    /* init a libevent listener 給event_base綁定地址和端口，設置監聽屬性，設置回調函數 （如果使用evconnlistenner_new函數的話需要自己來綁定端口和初始化socket，並把socket_fd傳遞給該函數）*/
    listener = evconnlistener_new_bind(base, accept_conn_cb, NULL, LEV_OPT_CLOSE_ON_FREE|LEV_OPT_REUSEABLE, -1,(struct sockaddr*)&sin, sizeof(sin));

    /* start loop for accept_conn_cb */
    event_base_dispatch(base);

    return 0;
}

bufferevent

Libevent的evbuffer功能通過實現一個字節隊列，在隊列末尾添加數據，在隊列頭移除數據。

結構

struct bufferevent {
    struct event_base *ev_base;
    const struct bufferevent_ops *be_ops;
    struct event ev_read;
    struct event ev_write;
    struct evbuffer *input;
    struct evbuffer *output;
    ……
    bufferevent_data_cb readcb;
    bufferevent_data_cb writecb;
    bufferevent_event_cb errorcb;
    ……
};

創建基於套接字的bufferevent

基於套接字的bufferevent是最簡單的，它使用libevent的底層事件機制來檢測底層網絡套接字是否已經就緒，可以進行讀寫操作，並且使用底層網絡調用（如readv、writev、WSASend、WSARecv）來發送和接收數據。

struct bufferevent * bufferevent_socket_new(struct event_base *base, evutil_socket_t fd, int options);

struct bufferevent *bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE); //例子 

設置讀寫回調函數

void bufferevent_setcb(struct bufferevent *bufev, bufferevent_data_cb readcb, bufferevent_data_cb writecb, bufferevent_event_cb eventcb, void *cbarg);

bufferevent_setcb(bev, readcb, NULL, errorcb, NULL); //例子

啟用事件

int bufferevent_enable(struct bufferevent *bufev, short event);
bufferevent_enable(bev, EV_READ|EV_WRITE); //例子

線程安全

默認情況下，多線程同時訪問evbuffer是不安全的。如果您需要執行此操作，您可以在evbuffer上調用 evbuffer_enable_locking()函數。如果此函數的lock參數為 NULL，則 Libevent 通過evthread_set_lock_creation_callback函數分配一把新鎖。否則，它所使用的參數作為該鎖。

int evbuffer_enable_locking(struct evbuffer *buf, void *lock);
void evbuffer_lock(struct evbuffer *buf);
void evbuffer_unlock(struct evbuffer *buf);

實例

/* Example code: an echo server. */
#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)
{
    /* 獲取bufferevent中的讀和寫的指針 */
    /* 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)
{
    /* 初始化一個bufferevent用於數據的寫入和讀取，首先需要從Listerner中獲取event_base */
    /* 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);
    /* 設置buferevent的回調函數，這里設置了讀和事件的回調函數 */
　　 bufferevent_setcb(bev, echo_read_cb, NULL, echo_event_cb, NULL);
    /* 啟用該bufevent寫和讀 */
     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(); /* 初始化event_base */
    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);

    /* 初始化evconnlistener(綁定地址、設置回調函數以及連接屬性) */
    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;
    }

    /* 設置Listen錯誤回調函數 */
    evconnlistener_set_error_cb(listener, accept_error_cb);

    / 開始accept進入循環 */
    event_base_dispatch(base);
    return 0;
}