轉自：http://name5566.com/4190.html

?

參考文獻列表：
http://www.wangafu.net/~nickm/libevent-book/

此文編寫的時候，使用到的 Libevent 為 2.0.21

Libevent 之跨平臺

在處理大量 SOCKET 連接時，使用 select 并不高效。各個系統都提供了處理大量 SOCKET 連接時的解決方案：

1. Linux 下的 epoll()
2. BSD 下的 kqueue()
3. Solaris 下的 evports
4. Windows 下的 IOCP

由于各個平臺使用了不同的接口，那么我們需要編寫跨平臺的高性能異步程序時就需要做一層跨平臺封裝。
這個時候 Libevent 就成為一個較好的選擇，其最底層 API（event 和 event_base API）為各個平臺實現高性能異步程序提供了一致的接口。

Libevent 2 提供的 bufferevent 接口，一方面簡化了編程的難度，另一方面保證了在 Windows 和 Unix 上都很高效。

一些基本的概念

1. event 會綁定文件描述符、回調函數并表示一個或者多個條件（例如，文件描述符可以讀或者寫了、發生了超時等）。event 表示的條件如果被觸發了，那么 event 會變為活躍的，它綁定的回調函數就會被執行
2. event_base 用于持有一組 event 并進行事件循環，event_base 會存在一個后端（也叫做方法），常見的后端包括 epoll、kqueue 等

Libevent 的結構

組件：

1. evutil 用于抽象不同的平臺的網絡（基礎的）實現
2. event、event_base 為 Libevent 的核心，為不同的平臺下基于事件的非阻塞 I/O 提供了一套抽象的接口
3. bufferevent 對 Libevent 的基于事件的核心的封裝。應用程序的讀寫請求是基于緩沖區的
4. evbuffer 為 bufferevent 實現的緩沖區
5. evhttp 一個簡單的 HTTP client/server 的實現
6. evdns 一個簡單的 DNS client/server 的實現
7. evrpc 一個簡單的 RPC 實現

庫：

1. libevent_core 包括 util、event_base、evbuffer、bufferevent
2. libevent_extra 包括 HTTP、DNS、RPC
3. libevent 此庫由于歷史原因而存在，不要使用它
4. libevent_pthreads 此庫為基于 pthread 的線程和鎖的實現
5. libevent_openssl 此庫通過 openssl 和 bufferevent 提供了加密通訊

頭文件：
所有的公用頭文件位于 event2 目錄中。

編譯 Libevent 庫

Linux 下編譯的方式為（詳細見 README）：

1. $ ./ configure
2. $ make

常用的 configure 標志有：

1. -- disable - shared 只編譯靜態庫
2. -- disable - openssl 關閉 OpenSSL 加密支持

Windows 下編譯的方式為：

1. nmake / f Makefile . nmake

需要注意的是，雖然官方提供了此 makefile，但是此文件尚未編寫完善（詳見 Makefile.nmake 的注釋）
編譯完成之后，需要將 WIN32-Code 目錄加入到 VS 的 include paths 中去

設置 Libevent 庫

在具體的介紹之前，這里首先需要明確的一點是，我們總是先設置 Libevent，然后才去使用 Libevent。

關于輸出日志的設置

Libevent 的日志信息默認被寫入 stderr（標準錯誤），我們可以提供自己的日志處理函數給 Libevent：

1. // 日志的類型
2. #define EVENT_LOG_DEBUG 0
3. #define EVENT_LOG_MSG 1
4. #define EVENT_LOG_WARN 2
5. #define EVENT_LOG_ERR 3
6. ?
7. // 日志處理函數原型
8. // severity 參數對應了上面的各種日志類型
9. typedef void (* event_log_cb )( int severity , const char * msg );
10. ?
11. // 設置一個新的日志處理函數
12. void event_set_log_callback ( event_log_cb cb );

設置日志處理函數的范例：

1. #include <event2/event.h>
2. #include <stdio.h>
3. ?
4. static void discard_cb ( int severity , const char * msg )
5. {
6. // 此函數不做任何事情
7. }
8. ?
9. static FILE * logfile = NULL ;
10. static void write_to_file_cb ( int severity , const char * msg )
11. {
12. const char * s ;
13. if (! logfile )
14. return ;
15. switch ( severity ) {
16. case _EVENT_LOG_DEBUG : s = "debug" ; break ;
17. case _EVENT_LOG_MSG : s = "msg" ; break ;
18. case _EVENT_LOG_WARN : s = "warn" ; break ;
19. case _EVENT_LOG_ERR : s = "error" ; break ;
20. default : s = "?" ; break ; /* never reached */
21. }
22. fprintf ( logfile , "[%s] %s\n" , s , msg );
23. }
24. ?
25. // 關閉 Libevent 的日志信息的輸出
26. void suppress_logging ( void )
27. {
28. event_set_log_callback ( discard_cb );
29. }
30. ?
31. // 設置 Libevent 的日志信息輸出到特定文件
32. void set_logfile ( FILE * f )
33. {
34. logfile = f ;
35. event_set_log_callback ( write_to_file_cb );
36. }

關于日志的注意事項：

1. 日志處理函數中不要調用任何的 Libevent 函數
2. Debug 日志信息默認不會被輸出，一般也不需要

Libevent 處理致命錯誤的做法是調用 exit() 或者 abort() 函數，你可以修改此行為（例如，你希望此時輸出調用棧信息）：

1. typedef void (* event_fatal_cb )( int err );
2. void event_set_fatal_callback ( event_fatal_cb cb );

注意事項：

1. 我們定義的 event_fatal_cb 函數不要將控制權再返回給 Libevent
2. 不要在 event_fatal_cb 函數中調用任何的 Libevent 函數

為 Libevent 定義自己的內存管理器

默認的情況下 Libevent 使用 C 庫的內存管理函數從堆上分配內存。替換 Libevent 默認內存管理函數主要有以下幾個目的：

1. 更加高效的分配內存
2. 檢測內存泄漏

設置自己定義的內存管理函數：

1. void event_set_mem_functions ( void *(* malloc_fn )( size_t sz ),
2. void *(* realloc_fn )( void * ptr , size_t sz ),
3. void (* free_fn )( void * ptr ));

替換 Libevent 內存管理函數時需要注意的地方：

1. 正如前面說到的，所有設置應該在 Libevent 被使用之前完成，對于內存管理的配置來說更加是如此，否則可能引起崩潰
2. 你設定的內存管理函數必須是線程安全的
3. 你設定的 malloc 和 realloc 返回的內存地址的對齊需要和 C 庫一致
4. 你設定的 realloc 需要能夠處理 realloc(NULL, sz)
5. 你設定的 realloc 需要能夠處理 realloc(ptr, 0)

關閉和清理

我們關閉程序的時候，需要完成一些清理工作：

1. void libevent_global_shutdown ( void );

此函數在 2.1.1-alpha 才被引入。

Libevent 多線程的問題

如果你希望 Libevent 函數分配的結構能夠被多個線程共享，那么首先需要告知 Libevent 我們使用的鎖定函數。如果使用 pthreads 庫或者使用 Windows 線程，可以調用以下函數來進行設置：

1. // 這兩個函數成功返回 0 失敗返回 -1
2. #ifdef WIN32
3. int evthread_use_windows_threads ( void );
4. #define EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED
5. #endif
6. #ifdef _EVENT_HAVE_PTHREADS
7. int evthread_use_pthreads ( void );
8. #define EVTHREAD_USE_PTHREADS_IMPLEMENTED
9. #endif

void evthread_enable_lock_debuging(void) 函數可以讓 Libevent 通過 assert 告知我們關于鎖的一些錯誤信息，主要是告知我們解鎖了一個未持有的鎖。我們需要在任意一個鎖被創建或使用之前調用此函數。

void event_enable_debug_mode(void) 函數可以讓 Libevent 檢測 event 使用上的一些錯誤：

1. 認為一個未初始化的 event 已經初始化了
2. 嘗試重新初始化一個 pending event（pending event 為一個術語，之后的文章會談到）

注意的是，開啟 debug 模式（也就是調用 event_enable_debug_mode）后，會有額外的內存和 CPU 開銷，所以應該在真正調試的時候再開啟。event_enable_debug_mode 函數需要在任意的 event_base 被創建前調用。

Libevent（1）— 簡介、編譯、配置