libevent学习笔记【使用篇】——3. 运行event loop

本文翻译自：http://www.wangafu.net/~nickm/libevent-book/Ref3_eventloop.html

文章出处： http://blog.csdn.net/windeal3203/article/details/52770759

运行loop

　　一旦一些events在event_base注册之后（下一节会讨论如何创建和注册events），就可以使Libevent等待events，并且在events准备好时能够通知你。
　　
　　默认情况下，event_base_loop()会在event_base上一直运行，直到其上已经没有注册的events了。运行loop时，它会重复检查那些已经注册的events是否触发了（比如，一个读event的文件描述符变得可读，或者后一个超时event已经超时）。一旦触发，该函数会将这些触发的events标记为active，并且开始运行回调函数。

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

　　可以通过设置一个或多个flag参数，来改变event_base_loop()函数的行为。如果设置了EVLOOP_ONCE，那么loop将会一直等待，直到一些events变为active，然后运行这些激活的events的回调函数，直到运行完所有激活的events为止，最后函数返回。如果设置了EVLOOP_NONBLOCK标志，则该函数不会等待events变为触发，它仅仅检查是否有事件准备好了，然后运行他们的回调函数，最后函数返回。
　　event_base_loop函数返回0表示正常退出，返回-1表示后端方法发生了错误。返回1表示已经没有pending或active状态的events了。
　　为了帮助理解，下面是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 eventsare 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 isactive) {
          Run all active events with priorityof p.
          break; /* Do not run any events of aless important priority */
       }
    }

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

　　方便起见，也可以使用下面的接口：
intevent_base_dispatch(struct event_base *base);
　　该函数等价于无标志的event_base_loop()函数。因此，直到没有注册的events，或者调用了event_base_loopbreak()、 event_base_loopexit()，该函数才会返回。

停止loop

　　如果希望在所有events移除之前，就停止event loop的运行，有两个略有不同的接口可以调用：

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在经过了给定的超时时间之后，停止运行loop。如果tv参数为NULL，则event_base会立即停止loop。如果event_base正在运行active events的回调函数，则只有在运行完所有的回调之后，才停止loop。
　　event_base_loopbreak()函数，使event_base立即退出loop。它与event_base_loopexit(base,NULL)不同之处在于，如果event_base当前正在运行任何激活events的回调函数，则会在当前的回调函数返回之后，就立即退出。
　　注意: 当event loop没有运行时，event_base_loopexit(base, NULL)和 event_base_loopbreak(base)的行为是不同的：loopexit使下一轮event loop在下一轮回调运行之后立即停止（就像设置了EVLOOP_ONCE一样），而loopbreak仅仅停止当前loop的运行，而且在event loop未运行时没有任何效果。
　　上述两个方法在成功是返回0， 失败时返回-1，。

立即停止：

#include 

/*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 triggerwhenever there are any bytes to
       read from a watchdog socket.  When that happens, we'll call the
       cb function, which will make the loop exitimmediately 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);
}

运行event loop10秒钟，然后退出。

#include 

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 of10-second intervals, printing
     "Tick" after each.  For a much better way to implement a10-second
     timer, see the section below aboutpersistent timer events. */
  while (1) {
     /* This schedules an exit ten seconds fromnow. */
     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(structevent_base *base)

　　上述函数，如果loop的停止是因为调用了event_base_loopexit()或event_base_break() ，则会返回True。否则，会返回False。他们的值会在下次启动eventloop时被重置。
　　上述函数在中声明。
　　

重新检查events

　　一般情况下，Libevent会检查events，然后从高优先级的激活events开始运行，然后再次检查events。有时，你可能希望在运行完当前运行的回调函数之后，告知Libevent重新检查events。与event_base_loopbreak()类似，这可以通过调用event_base_loopcontinue()实现。
int event_base_loopcontinue(struct event_base *);
　　如果当前没有运行events的回调函数的话，则该函数没有任何效果。

检查内部时间缓存

　　有时候可能需要在event回调函数内部，得到当前时间的近似视图，而且不希望使用gettimeoufday（可能是因为OS将gettimeofday()作为系统调用实现，而你希望避免系统调用的开销）。
　　在回调函数内部，可以在开始执行这一轮的回调时，得到Libevent的当前时间的视图：

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

　　如果event_base正在执行回调函数的话，那么event_base_gettimeofday_cached()函数会将tv_out参数设置为缓存的时间。否则，它会调用evutil_gettimeofday()得到当前实际的时间。该函数成功返回0，失败返回负数。
　　注意，因为当Libevent在开始执行回调的时候时间值才会被缓存，所以这个值会有一点不精确。如果回调执行很长时间，这个值将非常不精确。
　　为了使缓存能够立即刷新，可以调用：
int event_base_update_cache_time(struct event_base *base);
　　该函数在成功时返回0，失败时返回-1。而且在event_base没有运行eventloop时无效。
　　

转储event_base状态

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

　　为了调试程序的方便，有时会需要得到所有关联到event_base的events的列表以及他们的状态。调用event_base_dump_events()可以讲该列表输出到文件f中。
　　得到的列表格式是人可读的形式，将来版本 的Libevent可能会改变其格式。

event_base中的每个event运行同一个回调函数

typedef int (*event_base_foreach_event_cb)(const struct event_base *, const structevent *, void *);

int event_base_foreach_event(struct event_base *base,
                            event_base_foreach_event_cb fn,
                             void *arg);

　　调用函数event_base_foreach_event()，遍历运行与event_base关联的每一个active或pending的event。每一个event都会运行一次所提供的回调函数，运行顺序是未指定的。event_base_foreach_event()函数的第三个参数将会传递给回调函数的第三个参数。
　　回调函数必须返回0，才能继续执行遍历。否则会停止遍历。回调函数最终的返回值，就是event_base_foreach_function函数的返回值。
　　回调函数不可修改它接收到的events参数，也不能为event_base添加或删除events，或修改关联到event_base上的任何events。否则将会发生未定义的行为，甚至是崩溃。
　　在调用event_base_foreach_event期间，event_base的锁会被锁住。这样就会阻止其他线程使用该event_base，因而需要保证提供的回调函数不会运行太长时间。

废弃的loop函数

　　前面已经讨论过，老版本的Libevent具有“当前”event_base这样的全局概念。本文讨论的某些event loop函数具有操作当前event_base的变体函数。除了没有base参数外，这些函数跟当前新版本函数的行为相同。

当前函数	废弃的函数
event_base_dispatch()	event_dispatch()
event_base_loop()	event_loop()
event_base_loopexit()	event_loopexit()
event_base_loopbreak()	event_loopbreak()

注意，2.0版本之前的event_base是不支持锁的，所以这些老版本的函数并不是完全线程安全的：不允许在执行event loop的线程之外的其他线程中调用_loopbreak()或者_loopexit()函数。