libuv系列文章

check handle可以被译为检查句柄，如果程序中启动了check handle后，在事件循环中，每当I/O循环退出阻塞的时候都会被执行一遍，它与prepare刚好是相互呼应的，prepare是在I/O循环进入阻塞前，check是在I/O循环退出阻塞后被调用。

这种设计机制应该是libuv留个用户的接口，在退出I/O循环的阻塞状态后执行用户自定义的校验操作。

回顾一下libuv的事件循环过程，它有一个uv__run_check()函数会被执行，就是在事件循环迭代的过程中处理check handle。

数据类型

uv_check_t 是check handle的数据类型，通过它可以定义一个 check handle 的实例。

typedef struct uv_check_s uv_check_t;

check handle的回调函数

typedef void (*uv_check_cb)(uv_check_t* handle);

如果 check handle 的实例想要执行回调函数，则需要传递一个uv_check_cb类型的回调函数到uv_check_start()函数中。

API

初始化句柄。

int uv_check_init(uv_loop_t* loop, uv_check_t* check)

以给定的回调函数开始句柄。

int uv_check_start(uv_check_t* check, uv_check_cb cb)

停止句柄，回调函数将不会再被调用。

int uv_check_stop(uv_check_t* check)

example

说了那么多，首先方个check handle的例子吧，通过例子去讲解check handle相关的知识。

#include <stdio.h>
#include <stdlib.h>
#include <uv.h>

int64_t num = 0;

void my_idle_cb(uv_idle_t* handle)
{
    num++;
    printf("idle callback\n");
    if (num >= 5) {
        printf("idle stop, num = %ld\n", num);
        uv_stop(uv_default_loop());
    }
}

void my_check_cb(uv_check_t *handle) 
{
    printf("check callback\n");
}

int main() 
{
    uv_idle_t idler;
    uv_check_t check;

    uv_idle_init(uv_default_loop(), &idler);
    uv_idle_start(&idler, my_idle_cb);

    uv_check_init(uv_default_loop(), &check);
    uv_check_start(&check, my_check_cb);

    uv_run(uv_default_loop(), UV_RUN_DEFAULT);

    return 0;
}

main函数的处理过程：

定义idler实例。
定义check实例。
初始化idler实例。
初始化check实例。
启动idler实例，并传入对应的回调函数my_idler_cb。
启动check实例，并传入对应的回调函数my_check_cb。
启动事件循环。
在结束后退出。

my_check_cb回调函数的处理：

打印相关的信息

my_idle_cb回调函数的处理：

在每次调用回调函数的时候，对全局变量计数。
在计数值达到5后，停止事件循环uv_stop()。

其实你如果直接全局搜索uv_check_init这个函数的话，是找不到它的，因为libuv做了很骚的操作，将check、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，check。

如果你将代码中的##name或者name##或者##name##替换为check，##type替换为IDLE，就可以得到以下的代码：

这就是编译器预处理生成的check handle相关的代码：

int uv_check_init(uv_loop_t* loop, uv_check_t* handle) {
    /* 初始化handle的类型，所属loop，设置UV_HANDLE_REF标志，并且把handle插入loop->handle_queue队列的队尾 */
    uv__handle_init(loop, (uv_handle_t*)handle, UV_IDLE);

    handle->check_cb = NULL;
    return 0;
}

int uv_check_start(uv_check_t* handle, uv_check_cb cb) { 
    /* 如果已经执行过start函数则直接返回 */
    if (uv__is_active(handle)) return 0;

    /* 回调函数不允许为空 */ 
    if (cb == NULL) return UV_EINVAL; 

    /* 把handle插入loop中check_handles队列，loop有prepare，check和check三个队列 */
    QUEUE_INSERT_HEAD(&handle->loop->check_handles, &handle->queue);

    /* 指定回调函数，在事件循环迭代的时候被执行 */
    handle->check_cb = cb; 

    /* 启动check handle，设置UV_HANDLE_ACTIVE标记并且将loop中的handle的active计数加一，
       init的时候只是把handle挂载到loop，start的时候handle才处于激活态 */
    uv__handle_start(handle);
    return 0;
}

int uv_check_stop(uv_check_t* handle) { 
    /* 如果check handle没有被启动则直接返回 */
    if (!uv__is_active(handle)) return 0;

    /* 把handle从loop中相应的队列移除，但是还挂载到handle_queue中 */
    QUEUE_REMOVE(&handle->queue);

    /* 清除UV_HANDLE_ACTIVE标记并且减去loop中handle的active计数 */
    uv__handle_stop(handle);
    return 0;
}

/* 在每一轮循环中执行该函数，具体见uv_run */
void uv__run_check(uv_loop_t* loop) { 
    uv_check_t* h;
    QUEUE queue;
    QUEUE* q;

    /* 把loop的check_handles队列中所有节点摘下来挂载到queue变量 */
    QUEUE_MOVE(&loop->check_handles, &queue);

    /* while循环遍历队列，执行每个节点里面的函数 */
    while (!QUEUE_EMPTY(&queue)) {

        /* 取下当前待处理的节点 */
        q = QUEUE_HEAD(&queue);

        /* 取得该节点对应的整个结构体的基地址 */
        h = QUEUE_DATA(q, uv_check_t, queue);

        /* 把该节点移出当前队列 */
        QUEUE_REMOVE(q); 

        /* 重新插入loop->check_handles队列 */
        QUEUE_INSERT_TAIL(&loop->check_handles, q); 

        /* 执行对应的回调函数 */
        h->check_cb(h); 
    } 
}

/* 关闭这个check handle */
void uv__check_close(uv_check_t* handle) { 
    uv_check_stop(handle);
}