本章主要来源《libevent参考手册（中文版）》。

使用 libevent 函数之前需要分配一个或者多个 event_base 结构体。每个 event_base 结构 体持有一个事件集合,可以检测以确定哪个事件是激活的。
如果设置 event_base 使用锁,则可以安全地在多个线程中访问它 。然而,其事件循环只能 运行在一个线程中。如果需要用多个线程检测 IO,则需要为每个线程使用一个 event_base。
每个 event_base 都有一种用于检测哪种事件已经就绪的 “方法”,或者说后端。可以识别的方法有:

  • select
  • poll
  • epoll
  • kqueue
  • devpoll
  • evport
  • win32

4.1 创建event_base

4.1.1 创建默认的event_base

event_base_new()函数分配并且返回一个新的具有默认设置的 event_base。函数会检测环境变量,返回一个到 event_base 的指针。如果发生错误,则返回 NULL。选择各种方法时,函数会选择 OS 支持的最快方法。

  1. struct event_base *event_base_new(void);

大多数程序使用这个函数就够了。

event_base_new()函数声明在中,首次出现在 libevent 1.4.3版。

4.1.2 创建复杂的event_base

要对取得什么类型的 event_base 有更多的控制,就需要使用 event_config。

event_config 是一个容纳 event_base 配置信息的不透明结构体。需要 event_base 时,将 event_config 传递给event_base_new_with_config ()。

创建接口

  1. struct event_config *event_config_new(void);
  3. struct event_base *
  4. event_base_new_with_config(const struct event_config *cfg);
  6. void event_config_free(struct event_config *cfg);

要使用这些函数分配 event_base,先调用 event_config_new()分配一个 event_config。 然后,对 event_config 调用其它函数,设置所需要的 event_base 特征。最后,调用 event_base_new_with_config()获取新的 event_base。完成工作后,使用 event_config_free ()释放 event_config。

  1. int event_config_avoid_method(struct event_config *cfg, const char *method);
  3. enum event_method_feature {
  4.     EV_FEATURE_ET = 0x01,
  5.     EV_FEATURE_O1 = 0x02,
  6.     EV_FEATURE_FDS = 0x04,
  7. };
  8. int event_config_require_features(struct event_config *cfg,
  9.                                   enum event_method_feature feature);
  11. enum event_base_config_flag {
  12.     EVENT_BASE_FLAG_NOLOCK = 0x01,
  13.     EVENT_BASE_FLAG_IGNORE_ENV = 0x02,
  14.     EVENT_BASE_FLAG_STARTUP_IOCP = 0x04,
  15.     EVENT_BASE_FLAG_NO_CACHE_TIME = 0x08,
  16.     EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST = 0x10,
  17.     EVENT_BASE_FLAG_PRECISE_TIMER = 0x20
  18. };
  19. int event_config_set_flag(struct event_config *cfg,
  20.     enum event_base_config_flag flag);

调用 event_config_avoid_method ()可以通过名字让 libevent 避免使用特定的可用后端 。 调用 event_config_require_feature ()让 libevent 不使用不能提供所有指定特征的后端。 调用 event_config_set_flag()让 libevent 在创建 event_base 时设置一个或者多个将在下面介绍的运行时标志。

event_config_require_features()可识别的特征值有:

  • EV_FEATURE_ET:要求支持边沿触发的后端
  • EV_FEATURE_O1:要求添加、删除单个事件,或者确定哪个事件激活的操作是 O(1)复杂度的后端
  • EV_FEATURE_FDS:要求支持任意文件描述符,而不仅仅是套接字的后端

event_config_set_flag()可识别的选项值有:

  • EVENT_BASE_FLAG_NOLOCK :不要为 event_base 分配锁。设置这个选项可以 为 event_base 节省一点用于锁定和解锁的时间,但是让在多个线程中访问 event_base 成为不安全的。
  • EVENTBASE_FLAG_IGNORE_ENV :选择使用的后端时,不要检测 EVENT* 环境 变量。使用这个标志需要三思:这会让用户更难调试你的程序与 libevent 的交互。
  • EVENT_BASE_FLAG_STARTUP_IOCP:仅用于 Windows,让 libevent 在启动时就 启用任何必需的 IOCP 分发逻辑,而不是按需启用。

  • EVENT_BASE_FLAG_NO_CACHE_TIME :不是在事件循环每次准备执行超时回调时 检测当前时间,而是在每次超时回调后进行检测。注意:这会消耗更多的 CPU时间。

  • EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST :告诉 libevent ,如果决定使 用 epoll 后端,可以安全地使用更快的基于 changelist 的后端。epoll-changelist 后端可以 在后端的分发函数调用之间,同样的 fd 多次修改其状态的情况下,避免不必要的系统 调用。但是如果传递任何使用 dup()或者其变体克隆的 fd 给 libevent,epoll-changelist 后端会触发一个内核 bug,导致不正确的结果。在不使用 epoll 后端的情况下,这个标 志是没有效果的。也可以通过设置

  • EVENT_EPOLL_USE_CHANGELIST 环境变量来 打开 epoll-changelist 选项。

上述操作 event_config 的函数都在成功时返回0,失败时返回-1。

设置 event_config,请求 OS 不能提供的后端是很容易的 。比如说,对于 libevent 2.0.1-alpha, 在 Windows 中是没有 O(1)后端的;在 Linux 中也没有同时提供 EV_FEATURE_FDS 和 EV_FEATURE_O1 特征的后端。如果创建了 libevent 不能满足的配置, event_base_new_with_config ()会返回 NULL。

4.2 检查event_base后端

有时候需要检查 event_base 支持哪些特征,或者当前使用哪种方法。

4.2.1 接口1

  1. const char **event_get_supported_methods(void);

event_get_supported_methods()函数返回一个指针 ,指向 libevent 支持的方法名字数组 。 这个数组的最后一个元素是 NULL。

实例：

  1. int i;
  2. const char **methods = event_get_supported_methods();
  3. printf("Starting Libevent %s.  Available methods are:\n",
  4.     event_get_version());
  5. for (i=0; methods[i] != NULL; ++i) {
  6.     printf("    %s\n", methods[i]);
  7. }

这个函数返回 libevent 被编译以支持的方法列表 。然而 libevent 运行的时候,操作系统可能 不能支持所有方法。比如说,可能 OS X 版本中的 kqueue 的 bug 太多,无法使用。

4.2.2 接口2

  1. const char *
  2. event_base_get_method(const struct event_base *base);
  4. enum event_method_feature 
  5. event_base_get_features(const struct event_base *base);

event_base_get_method()返回 event_base 正在使用的方法。

event_base_get_features ()返回 event_base 支持的特征的比特掩码。

实例

  1. struct event_base *base;
  2. enum event_method_feature f;
  4. base = event_base_new();
  5. if (!base) {
  6.     puts("Couldn't get an event_base!");
  7. } else {
  8.     printf("Using Libevent with backend method %s.",
  9.         event_base_get_method(base));
  10.     f = event_base_get_features(base);
  11.     if ((f & EV_FEATURE_ET))
  12.         printf("  Edge-triggered events are supported.");
  13.     if ((f & EV_FEATURE_O1))
  14.         printf("  O(1) event notification is supported.");
  15.     if ((f & EV_FEATURE_FDS))
  16.         printf("  All FD types are supported.");
  17.     puts("");
  18. }

4.3 释放event_base

使用完 event_base 之后,使用 event_base_free()进行释放。

  1. void event_base_free(struct event_base *base);

注意:这个函数不会释放当前与 event_base 关联的任何事件,或者关闭他们的套接字 ,或 者释放任何指针。

event_base_free()定义在中,首次由 libevent 1.2实现。

4.4 event_base优先级

libevent支持为事件设置多个优先级。然而, event_base默认只支持单个优先级。可以调用 event_base_priority_init()设置 event_base 的优先级数目。

  1. int event_base_priority_init(struct event_base *base, int n_priorities);

成功时这个函数返回 0,失败时返回 -1。base 是要修改的 event_base,n_priorities 是要支 持的优先级数目,这个数目至少是 1 。每个新的事件可用的优先级将从 0 (最高) 到 n_priorities-1(最低)。

常量 EVENT_MAX_PRIORITIES 表示 n_priorities 的上限。调用这个函数时为 n_priorities 给出更大的值是错误的。

必须在任何事件激活之前调用这个函数,最好在创建 event_base 后立刻调用。

4.5 event_base和fork

不是所有事件后端都在调用 fork()之后可以正确工作。所以,如果在使用 fork()或者其 他相关系统调用启动新进程之后,希望在新进程中继续使用 event_base,就需要进行重新初始化。

  1. int event_reinit(struct event_base *base);

成功时这个函数返回 0,失败时返回 -1。

实例

  1. struct event_base *base = event_base_new();
  3. /* ... add some events to the event_base ... */
  5. if (fork()) {
  6.     /* In parent */
  7.     continue_running_parent(base); /*...*/
  8. } else {
  9.     /* In child */
  10.     event_reinit(base);
  11.     continue_running_child(base); /*...*/
  12. }

event_reinit()定义在中,在 libevent 1.4.3-alpha 版中首次可用。