1 運行循環

一旦有了一個已經注冊了某些事件的event_base（關于如何創建和注冊事件請看下一節），就需要讓libevent等待事件并且通知事件的發生。

接口

#define EVLOOP_ONCE             0x01
#define EVLOOP_NONBLOCK         0x02
#define EVLOOP_NO_EXIT_ON_EMPTY 0x04

int event_base_loop(struct event_base *base, int flags);

默認情況下，event_base_loop（）函數運行event_base直到其中沒有已經注冊的事件為止。執行循環的時候，函數重復地檢查是否有任何已經注冊的事件被觸發（比如說，讀事件的文件描述符已經就緒，可以讀取了；或者超時事件的超時時間即將到達）。如果有事件被觸發，函數標記被觸發的事件為“激活的”，并且執行這些事件。

在flags參數中設置一個或者多個標志就可以改變event_base_loop（）的行為。如果設置了EVLOOP_ONCE，循環將等待某些事件成為激活的，執行激活的事件直到沒有更多的事件可以執行，然會返回。如果設置了EVLOOP_NONBLOCK，循環不會等待事件被觸發：循環將僅僅檢測是否有事件已經就緒，可以立即觸發，如果有，則執行事件的回調。

完成工作后，如果正常退出，event_base_loop（）返回0；如果因為后端中的某些未處理錯誤而退出，則返回-1。

為幫助理解，這里給出event_base_loop（）的算法概要：

偽代碼

while (any events are registered with the loop,
        or EVLOOP_NO_EXIT_ON_EMPTY was set) {

    if (EVLOOP_NONBLOCK was set, or any events are already active)
        If any registered events have triggered, mark them active.
    else
        Wait until at least one event has triggered, and mark it active.

    for (p = 0; p < n_priorities; ++p {
       if (any event with priority of p is active) {
          Run all active events with priority of p.
          break; /* Do not run any events of a less important priority */
       }
    }

    if (EVLOOP_ONCE was set or EVLOOP_NONBLOCK was set)
       break;
}

為方便起見，也可以調用

接口

int event_base_dispatch(struct event_base *base);

event_base_dispatch（）等同于沒有設置標志的event_base_loop（）。所以，event_base_dispatch（）將一直運行，直到沒有已經注冊的事件了，或者調用了event_base_loopbreak（）或者event_base_loopexit（）為止。

這些函數定義在<event2/event.h>中，從libevent 1.0版就存在了。

2 停止循環

如果想在移除所有已注冊的事件之前停止活動的事件循環，可以調用兩個稍有不同的函數。

接口

int event_base_loopexit(struct event_base *base,
                        const struct timeval *tv);
int event_base_loopbreak(struct event_base *base);

event_base_loopexit（）讓event_base在給定時間之后停止循環。如果tv參數為NULL，event_base會立即停止循環，沒有延時。如果event_base當前正在執行任何激活事件的回調，則回調會繼續運行，直到運行完所有激活事件的回調之才退出。

event_base_loopbreak（）讓event_base立即退出循環。它與event_base_loopexit（base,NULL）的不同在于，如果event_base當前正在執行激活事件的回調，它將在執行完當前正在處理的事件后立即退出。

注意event_base_loopexit(base,NULL)和event_base_loopbreak(base)在事件循環沒有運行時的行為不同：前者安排下一次事件循環在下一輪回調完成后立即停止（就好像帶EVLOOP_ONCE標志調用一樣）；后者卻僅僅停止當前正在運行的循環，如果事件循環沒有運行，則沒有任何效果。

這兩個函數都在成功時返回0，失敗時返回-1。

示例：立即關閉

#include <event2/event.h>

/* Here's a callback function that calls loopbreak */
void cb(int sock, short what, void *arg)
{
    struct event_base *base = arg;
    event_base_loopbreak(base);
}

void main_loop(struct event_base *base, evutil_socket_t watchdog_fd)
{
    struct event *watchdog_event;

    /* Construct a new event to trigger whenever there are any bytes to
       read from a watchdog socket.  When that happens, we'll call the
       cb function, which will make the loop exit immediately without
       running any other active events at all.
     */
    watchdog_event = event_new(base, watchdog_fd, EV_READ, cb, base);

    event_add(watchdog_event, NULL);

    event_base_dispatch(base);
}

示例：執行事件循環10秒，然后退出

#include <event2/event.h>

void run_base_with_ticks(struct event_base *base)
{
  struct timeval ten_sec;

  ten_sec.tv_sec = 10;
  ten_sec.tv_usec = 0;

  /* Now we run the event_base for a series of 10-second intervals, printing
     "Tick" after each.  For a much better way to implement a 10-second
     timer, see the section below about persistent timer events. */
  while (1) {
     /* This schedules an exit ten seconds from now. */
     event_base_loopexit(base, &ten_sec);

     event_base_dispatch(base);
     puts("Tick");
  }
}

有時候需要知道對event_base_dispatch（）或者event_base_loop（）的調用是正常退出的，還是因為調用event_base_loopexit（）或者event_base_break（）而退出的。可以調用下述函數來確定是否調用了loopexit或者break函數。

接口

int event_base_got_exit(struct event_base *base);
int event_base_got_break(struct event_base *base);

這兩個函數分別會在循環是因為調用event_base_loopexit（）或者event_base_break（）而退出的時候返回true，否則返回false。下次啟動事件循環的時候，這些值會被重設。

這些函數聲明在<event2/event.h>中。event_break_loopexit()函數首次在libevent 1.0c版本中實現；event_break_loopbreak()首次在libevent 1.4.3版本中實現。

3 檢查內部時間緩存

有時候需要在事件回調中獲取當前時間的近似視圖，但不想調用gettimeofday()（可能是因為OS將gettimeofday()作為系統調用實現，而你試圖避免系統調用的開銷）。

在回調中，可以請求libevent開始本輪回調時的當前時間視圖。

接口

int event_base_gettimeofday_cached(struct event_base *base,
    struct timeval *tv_out);

如果當前正在執行回調，event_base_gettimeofday_cached()函數設置tv_out參數的值為緩存的時間。否則，函數調用evutil_gettimeofday()獲取真正的當前時間。成功時函數返回0，失敗時返回負數。

注意，因為libevent在開始執行回調的時候緩存時間值，所以這個值至少是有一點不精確的。如果回調執行很長時間，這個值將非常不精確。

這個函數是libevent 2.0.4-alpha新引入的。

4 轉儲event_base的狀態

接口

void event_base_dump_events(struct event_base *base, FILE *f);

為幫助調試程序（或者調試libevent），有時候可能需要加入到event_base的事件及其狀態的完整列表。調用event_base_dump_events()可以將這個列表輸出到指定的文件中。

這個列表是人可讀的，未來版本的libevent將會改變其格式。

這個函數在libevent 2.0.1-alpha版本中引入。

5 廢棄的事件循環函數

前面已經討論過，老版本的libevent 具有“當前”event_base的概念。

本文討論的某些事件循環函數具有操作當前event_base的變體。除了沒有base參數外，這些函數跟當前新版本函數的行為相同。

注意

2.0版本之前的event_base是不支持鎖的，所以這些函數并不是完全線程安全的：不允許在執行事件循環的線程之外的其他線程中調用_loopbreak()或者_loopexit()函數。

實際運作

    這里我將結合具體的代碼分析libevent是如何操作上面那個隊列式的evbuffer的，先看一些輔助函數：

    該函數主要操作一些指標，當每次從evbuffer里讀取數據時，libevent便會將buffer指針后移，同時增大misalign，減小off，
而該函數正是做這件事的。說白了，該函數就是用于調整緩沖隊列的前向指標。

    該函數用于擴充evbuffer的容量。每次向evbuffer寫數據時，都是將數據寫到buffer+off后，buffer到buffer+off之間已被
使用，保存的是有效數據，而orig_buffer和buffer之間則是因為讀取數據移動指標而形成的無效區域。
    evbuffer_expand的擴充策略在于，首先判斷如果讓出orig_buffer和buffer之間的空閑區域是否可以容納添加的數據，如果
可以，則移動buffer和buffer+off之間的數據到orig_buffer和orig_buffer+off之間(有可能發生內存重疊，所以這里移動調用的
是memmove)，然后把新的數據拷貝到orig_buffer+off之后；如果不可以容納，那么重新分配更大的空間(realloc)，同樣會移動
數據。
    擴充內存的策略為：確保新的內存區域最小尺寸為256，且以乘以2的方式逐步擴大(256、512、1024、...)。

    了解了以上兩個函數，看其他函數就比較簡單了。可以看看具體的讀數據和寫數據：

    該函數用于添加一段用戶數據到evbuffer中。很簡單，就是先判斷是否有足夠的空閑內存，如果沒有則調用evbuffer_expand
擴充之，然后直接memcpy，更新off指標。

    該函數用于將evbuffer中的數據復制給用戶空間(讀數據)。簡單地將數據memcpy，然后調用evbuffer_drain移動相關指標。

動態分配一個struct evbuffer結構，需要調用evbuffer_free釋放內存。

void evbuffer_free(struct evbuffer *buffer)

釋放buffer所占用的內存。

int evbuffer_add_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf)

移動數據從一個evbuffer到另一個evbuffer。

實際上還是調用了evbuffer_add添加數據到outbuf中。但會清除inbuf中的數據。

返回值：成功返回0， 失敗返回-1。

int evbuffer_add_printf( struct evbuffer *, const char* fmt, )

添加一個格式化的字符串到evbuffer尾部。

u_char *evbuffer_find(struct evbuffer *buffer, const u_char *what, size_t len)

查找緩沖區中是否存在指定的字符串what。

注意這里使用的是u_char類型，說明有可能查找的數據不是以’\0’結尾

如果存在返回指向字符串what的指針，沒有則返回NULL。

int evbuffer_read(struct evbuffer *buf, int fd, int howmuch)

調用read/recv函數，從文件描述符fd上讀取數據到evbuffer中。如果緩沖區不夠，調用evbuffer_expand擴充緩沖區。

int evbuffer_write(struct evbuffer *buffer, int fd)

把緩沖區中的數據，調用send/write函數寫入文件描述符fd上， 如果send/write函數寫入的字節數大于0，則調用evbuffer_drain刪除已寫的數據。

char *evbuffer_readline(struct evbuffer *buffer)

讀取數據以"\r\n","\n\r", "\r" 或者 "\n"結尾。

返回動態分配內存，需要調用者自己使用free來釋放內存。返回一個以“\0”結尾的字符串。

void evbuffer_setcb(struct evbuffer *buffer,
    void (*cb)(struct evbuffer *, size_t, size_t, void *),
    void *cbarg)

設置回調函數。當緩沖區中發生變化時， 調用設置的回調函數。

Evbuffer提供的API已經全部介紹完畢，接下來我們通過一個實例進一步學習如何使用evbuffer, 想要使用evbuffer，系統里必須已經安裝了libevent。

例子代碼如下：evbuffer-test.c

#include <stdio.h>
#include <string.h>
#include <assert.h>

//引入libevent頭文件
#include "event.h"

int main(int argc, char** argv)
{
    struct evbuffer* buff = NULL;
    char c, c2[3] = {0};
    
    buff = evbuffer_new();
    assert(buff != NULL);
    
    evbuffer_add(buff, "1", 1);
    evbuffer_add(buff, "2", 1);
    evbuffer_add(buff, "3", 1);
    evbuffer_add_printf(buff, "%d%d", 4, 5);
    assert(buff->off == 5);

    evbuffer_remove(buff, &c, sizeof(char));
    assert(c == '1');
    evbuffer_remove(buff, &c, sizeof(char));
    assert(c == '2');
    evbuffer_remove(buff, &c, sizeof(char));
    assert(c == '3');
    evbuffer_remove(buff, c2, 2);
    assert(strcmp(c2, "45") == 0);
    
    assert(buff->off == 0);
  
    evbuffer_add(buff, "test\r\n", 6);
    assert(buff->off == 6);
    
    char* line = evbuffer_readline(buff);
    assert(strcmp(line, "test") ==0);
    assert(buff->off == 0);
    free(line);
   
    evbuffer_free(buff);
    
    printf("ok\n");
    
    return 0;
}