Libevent 学习六：Libevent 定时器事件

与信号类似，Libevent 定时器事件 API 也是一系列宏定义的接口，对 event_ 等基础函数做了一个简单的封装，源码如下：

// 给一个定时器事件赋值，需要传递事件指针，不常用
#define evtimer_assign(ev, b, cb, arg) \
	event_assign((ev), (b), -1, 0, (cb), (arg))

// 新建一个定时器事件对象
#define evtimer_new(b, cb, arg)		event_new((b), -1, 0, (cb), (arg))

// 将定时器事件接加入libevent中，状态变为待决
#define evtimer_add(ev, tv)		event_add((ev), (tv))

// 从libevent中删除定时器事件
#define evtimer_del(ev)			event_del(ev)

// 判断定时器事件是否为待决状态
#define evtimer_pending(ev, tv)		event_pending((ev), EV_TIMEOUT, (tv))

// 判断定时器事件是否为已初始化状态
#define evtimer_initialized(ev)		event_initialized(ev)

注意，与信号不同，evtimer_new 创建的事件是非持久化的，即默认情况下只会响应一次。超时时间的结构体名称为 struct timeval，Linux 下位于 <sys/time.h> 中，定义如下：

struct timeval {
    time_t tv_sec;      	/* 秒 [long int] */
    suseconds_t tv_usec;    /* 微秒 [long int] */
};

这个结构体在 Windows 中也有定义，两个字段都是 long 类型，表示的含义与 Linux 中一样。Libevent 有两种方式跟踪未决事件的超时值：

• 默认使用二叉堆（binary heap），添加和删除的时间复杂度为 O(logN) 。可使用完全二叉树实现，分大根堆和小根堆。Libevent 使用小根堆，最近的超时时间在堆顶。
• 双链队列，添加和删除的时间复杂度为 O(1) 。适用于具有大量相同超时值的情况，可以调用函数 event_base_init_common_timeout 设置。

定时器事件的实例代码如下：

#include <iostream>
#include <time.h>
#include <thread>
#include <chrono>
#include "event.h"

static struct timeval tv1 = { 1, 0 };
static struct timeval tv2 = { 1, 500000 };

// 定时器回调函数
void timer1_cb(evutil_socket_t fd, short what, void *arg) {
    std::cout << "[timer1_cb] time: " << time(NULL) << std::endl;

    // 重新添加到libevent中，类似于持久化
    event *ev = (event*)arg;
    if (!evtimer_pending(ev, &tv1)) {
        evtimer_del(ev);
        evtimer_add(ev, &tv1);
    }
}

// 定时器回调函数
void timer2_cb(evutil_socket_t fd, short what, void *arg) {
    std::cout << "[timer2_cb] time: " << time(NULL) << std::endl;
    std::this_thread::sleep_for(std::chrono::seconds(3));
}

// 定时器回调函数
void timer3_cb(evutil_socket_t fd, short what, void *arg) {
    std::cout << "[timer3_cb] time: " << time(NULL) << std::endl;
}

int main(int argc, char* argv[])
{
#ifdef _WIN32
    // 初始化socket库
    WSADATA wsa;
    WSAStartup(MAKEWORD(2, 2), &wsa);
#else
    // 忽略管道信号，因为发送数据给已关闭的socket会生成SIGPIPE信号，导致进程退出
    if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
        return -1;
#endif

    std::cout << "libevent timer test" << std::endl;
    // 创建libevent上下文
    event_base *base = event_base_new();
    if (!base) {
        std::cout << "event_base_new failed" << std::endl;
        return -1;
    }
    std::cout << "event_base_new success" << std::endl;

    /**
     * #define evtimer_new(b, cb, arg)	event_new((b), -1, 0, (cb), (arg))
     * #define evtimer_add(ev, tv)		event_add((ev), (tv))
     * #define evtimer_del(ev)			event_del(ev)
     */
    // 创建定时器事件
    event *ev1 = evtimer_new(base, timer1_cb, event_self_cbarg());
    if (!ev1) {
        std::cout << "evtimer_new ev1 failed" << std::endl;
        return -1;
    }
    evtimer_add(ev1, &tv1);

    // 持久化事件
    event *ev2 = event_new(base, -1, EV_PERSIST, timer2_cb, NULL);
    if (!ev2) {
        std::cout << "event_new ev2 failed" << std::endl;
        return -1;
    }
    evtimer_add(ev2, &tv2);

    // 超时优化，默认event用二叉堆（完全二叉树）存储，插入删除复杂度 O(logn)
    // 优化到双向队列，插入删除复杂度 O(1)
    struct timeval tv_in = { 3, 0 };
    const timeval *tv3 = event_base_init_common_timeout(base, &tv_in);
    event *ev3 = event_new(base, -1, EV_PERSIST, timer3_cb, NULL);
    evtimer_add(ev3, tv3);      // 插入性能 O(1)

    // 事件分发处理
    event_base_dispatch(base);

    // 释放资源
    event_free(ev1);
    event_free(ev2);
    event_free(ev3);
    event_base_free(base);

#ifdef _WIN32
    WSACleanup();
#endif

    return 0;
}

注意，上面代码是为了演示定时器事件创建的两种方法，本质上是一样的，都是调用 event_add 接口。实际使用过程中不用如此麻烦，可以直接调用 evtimer_new 创建定时器事件。