天天看點

Libevent學習-- bufferevent和evconnlistener用法libevent 接收TCP連接配接

libevent 接收TCP連接配接

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

evconnlistener

Libevent源碼分析-----連接配接監聽器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;
}      

參考

//在伺服器上監聽一個端口來接受新的連接配接.
//傳統的方法是調用 socket、bind、listen、accept 等函數.
//libevent為我們提供了一個封裝 evconnlistener , 隻要設定好回調函數即可接受處理新連接配接.

//evconnlistener回調函數的原型.
//當接受到一個新連接配接并且幫我們accept好後,會調用這個函數.
//sock是新連接配接的fd , addr是該連接配接的位址,ptr是evconnlistener_new()傳入的參數.
//typedef void (*evconnlistener_cb)(struct evconnlistener *listener,
//    evutil_socket_t sock, struct sockaddr *addr, int len, void *ptr);

//建立evconnlistener.(傳入一個fd,這個fd已經綁定到一個端口).
//如果cb參數為NULL,則暫時不能接受連接配接,直到我們設定了回調函數.
//flag參數傳入一些選項,可以控制evconnlistener的行為.
//backlog參數是listen()函數的第二個參數,如果為負數,libevent會選擇一個恰當的值.
//struct evconnlistener *evconnlistener_new(struct event_base *base,
//    evconnlistener_cb cb, void *ptr, unsigned flags, int backlog,
//    evutil_socket_t fd);

//建立evconnlistener.(其他同上函數,不同的是這個函數幫我們建立fd并bind)
//struct evconnlistener *evconnlistener_new_bind(struct event_base *base,
//    evconnlistener_cb cb, void *ptr, unsigned flags, int backlog,
//    const struct sockaddr *sa, int socklen);

//銷毀evconnlistener.
//void evconnlistener_free(struct evconnlistener *lev);

//建立evconnlistener時的flag可以是下列選項的組合.
//1.LEV_OPT_LEAVE_SOCKETS_BLOCKING : 預設在accept新連接配接後會設為非阻塞,這個選項取消非阻塞設定.
//2.LEV_OPT_CLOSE_ON_FREE : 當銷毀evconnlistener的時候關閉監聽的socket.
//3.LEV_OPT_CLOSE_ON_EXEC : 在監聽的socket上設定 FD_CLOEXEC 選項.
//4.LEV_OPT_REUSEABLE : 監聽端口關閉後端口可立即重用.
//5.LEV_OPT_THREADSAFE : 給evconnlistener加鎖. (Libevent 2.0.8-rc.)

//暫時啟用/禁用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);

//擷取監聽fd(Libevent 2.0.3-alpha)
//evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev);

//擷取event_base
//struct event_base *evconnlistener_get_base(struct evconnlistener *lev);

//設定錯誤回調函數,監聽發生錯誤的時候調用.(Libevent 2.0.8-rc)
//錯誤回調函數的原型: typedef void (*evconnlistener_errorcb)(struct evconnlistener *lis, void *ptr);
//void evconnlistener_set_error_cb(struct evconnlistener *lev,evconnlistener_errorcb errorcb);


//下面是一個簡單的echo server

#include <event2/listener.h>
#include <event2/bufferevent.h>
#include <event2/buffer.h>
#include <errno.h>
#include <string.h>

//用戶端讀回調函數.(從用戶端讀到資料,并且資料已經自動存到input buffer裡面了).
static void echo_read_cb(struct bufferevent *bev, void *ctx)
{
	//分别從bufferevent裡拿到 input buffer 和 output buffer.
	struct evbuffer *input = bufferevent_get_input(bev);
	struct evbuffer *output = bufferevent_get_output(bev);

	//将input buffer裡面收到的資料全部搬到output buffer , libevent會為我們自動發送給用戶端.
	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);
	}
}

//接受連接配接回調函數(接受到一個新連接配接.并且accept成功)
static void accept_conn_cb(struct evconnlistener *listener,
    evutil_socket_t fd, struct sockaddr *address, int socklen,void *ctx)
{
	struct event_base *base = evconnlistener_get_base(listener);
	//我們為新連接配接建立一個bufferevent來處理新連接配接.
	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(){
	//
	struct event_base *base = event_base_new();
	//
	int port = 9999;
	struct sockaddr_in sin;
	memset(&sin, 0, sizeof(sin));
	sin.sin_family = AF_INET;
	sin.sin_addr.s_addr = htonl(0);
	sin.sin_port = htons(port);
	//
	struct evconnlistener *listener = evconnlistener_new_bind( 
		base , accept_conn_cb , NULL , LEV_OPT_CLOSE_ON_FREE|LEV_OPT_REUSEABLE , -1 
		, (struct sockaddr*)&sin, sizeof(sin)
	);
	//
	evconnlistener_set_error_cb(listener, accept_error_cb);
	//
	event_base_dispatch(base);
	//
	evconnlistener_free(listener);
	event_base_free(base);
}
           

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

http://blog.csdn.net/mhpmii/article/details/49583121

版權聲明:本文為CSDN部落客「weixin_33826609」的原創文章,遵循CC 4.0 BY-SA版權協定,轉載請附上原文出處連結及本聲明。

原文連結:https://blog.csdn.net/weixin_33826609/article/details/92487362