libuv 句柄解读-空闲(idle)
解读
idle handle可以被译为空闲句柄，如果程序中启动了 idle handle 后，那么它在每次事件循环的时候都会被执行一遍。
回顾一下 libuv 的事件循环过程，它有一个uv__run_idle()函数会被执行，就是在事件循环迭代的过程中处理 idle handle。
数据类型
uv_idle_t 是 idle handle 的数据类型，通过它可以定义一个 idle handle 的实例。
typedef struct uv_idle_s uv_idle_t;
idle handle的回调函数
typedef void (*uv_idle_cb)(uv_idle_t* handle);
如果 idle handle 的实例想要执行回调函数，则需要传递一个uv_idle_cb类型的回调函数到uv_idle_start()函数中。
API
- 初始化句柄。
int uv_idle_init(uv_loop_t* loop, uv_idle_t* idle)
- 以给定的回调函数开始句柄。
int uv_idle_start(uv_idle_t* idle, uv_idle_cb cb)
- 停止句柄，回调函数将不会再被调用。
int uv_idle_stop(uv_idle_t* idle)
样例解读
说了那么多，首先放个idle handle的例子吧，通过例子去讲解idle handle相关的知识。
#include <stdio.h>
#include <stdlib.h>
#include <uv.h>
int64_t num = 0;
void my_idle_cb(uv_idle_t* handle)
{
num++;
if (num >= 10e6) {
printf("idle stop, num = %ld\n", num);
uv_idle_stop(handle);
}
}
int main()
{
uv_idle_t idler;
uv_idle_init(uv_default_loop(), &idler);
printf("idle start, num = %ld\n", num);
uv_idle_start(&idler, my_idle_cb);
uv_run(uv_default_loop(), UV_RUN_DEFAULT);
return 0;
}
main函数的处理过程：
- 定义 idler 实例。
- 初始化 idler 实例。
- 启动 idler 实例，并传入对应的回调函数
my_idle_cb。 - 启动事件循环。
- 在结束后退出。
my_idle_cb回调函数的处理：
- 在每次调用回调函数的时候，对全局变量计数。
- 在计数值达到
10e6后，停止idle handle。
包含的 API 函数如下：
uv_idle_init()uv_idle_start()uv_idle_stop()
libuv 内部调用的 api 函数：
- uv__run_idle()
- uv__idle_close()
其实你如果直接全局搜索 uv_idle_init 这个函数的话，是找不到它的，因为 libuv 做了很骚的操作，将 idle、prepare 以及 check 相关的函数都通过 C 语言的##连接符统一用宏定义了，并且在编译器预处理的时候产生对应的函数代码，具体源码如下：
src\unix\loop-watcher.c文件内容
#include "uv.h"
#include "internal.h"
#define UV_LOOP_WATCHER_DEFINE(name, type) \
int uv_##name##_init(uv_loop_t* loop, uv_##name##_t* handle) { \
uv__handle_init(loop, (uv_handle_t*)handle, UV_##type); \
handle->name##_cb = NULL; \
return 0; \
} \
\
int uv_##name##_start(uv_##name##_t* handle, uv_##name##_cb cb) { \
if (uv__is_active(handle)) return 0; \
if (cb == NULL) return UV_EINVAL; \
QUEUE_INSERT_HEAD(&handle->loop->name##_handles, &handle->queue); \
handle->name##_cb = cb; \
uv__handle_start(handle); \
return 0; \
} \
\
int uv_##name##_stop(uv_##name##_t* handle) { \
if (!uv__is_active(handle)) return 0; \
QUEUE_REMOVE(&handle->queue); \
uv__handle_stop(handle); \
return 0; \
} \
\
void uv__run_##name(uv_loop_t* loop) { \
uv_##name##_t* h; \
QUEUE queue; \
QUEUE* q; \
QUEUE_MOVE(&loop->name##_handles, &queue); \
while (!QUEUE_EMPTY(&queue)) { \
q = QUEUE_HEAD(&queue); \
h = QUEUE_DATA(q, uv_##name##_t, queue); \
QUEUE_REMOVE(q); \
QUEUE_INSERT_TAIL(&loop->name##_handles, q); \
h->name##_cb(h); \
} \
} \
\
void uv__##name##_close(uv_##name##_t* handle) { \
uv_##name##_stop(handle); \
}
UV_LOOP_WATCHER_DEFINE(prepare, PREPARE)
UV_LOOP_WATCHER_DEFINE(check, CHECK)
UV_LOOP_WATCHER_DEFINE(idle, IDLE)
它利用宏定义，在预处理阶段拓展成三个不同类型，但是处理逻辑一样的代码。有三种类型，分别是 prepare，check，idle。
如果你将代码中的##name或者name##或者##name##替换为idle，##type替换为IDLE，就可以得到以下的代码：
- 这就是编译器预处理生成的 idle handle 相关的代码：
int uv_idle_init(uv_loop_t* loop, uv_idle_t* handle) {
uv__handle_init(loop, (uv_handle_t*)handle, UV_IDLE);
handle->idle_cb = NULL;
return 0;
}
int uv_idle_start(uv_idle_t* handle, uv_idle_cb cb) {
if (uv__is_active(handle)) return 0;
if (cb == NULL) return UV_EINVAL;
QUEUE_INSERT_HEAD(&handle->loop->idle_handles, &handle->queue);
handle->idle_cb = cb;
uv__handle_start(handle);
return 0;
}
int uv_idle_stop(uv_idle_t* handle) {
if (!uv__is_active(handle)) return 0;
QUEUE_REMOVE(&handle->queue);
uv__handle_stop(handle);
return 0;
}
void uv__run_idle(uv_loop_t* loop) {
uv_idle_t* h;
QUEUE queue;
QUEUE* q;
QUEUE_MOVE(&loop->idle_handles, &queue);
while (!QUEUE_EMPTY(&queue)) {
q = QUEUE_HEAD(&queue);
h = QUEUE_DATA(q, uv_idle_t, queue);
QUEUE_REMOVE(q);
QUEUE_INSERT_TAIL(&loop->idle_handles, q);
h->idle_cb(h);
}
}
void uv__idle_close(uv_idle_t* handle) {
uv_idle_stop(handle);
}