Hiredis异步API

异步API

Hiredis 拥有一个套异步API方便与一些事件库协同工作. Hiredis的代码中涵盖了hiredis与libev和libevent这两个库结合使用的例子.

连接

函数 redisAsyncConnect 用来建立到redis服务器的非阻塞连接. 返回一个 redisAsyncContext 结构体指针. 因为建立的连接是非阻塞的，无法立即返回目标主机的ip和端口是否可达。所以在建立连接后，我们应该检查 err 成员，来确认连接是否存在错误。

redisAsyncContext *c = redisAsyncConnect("127.0.0.1", 6379);
if (c->err) {
    printf("Error: %s\n", c->errstr);
    // 错误处理
}

redisAsyncContext包含一个连接断开回调函数(主动断开，或者发生错误都会调用)。此函数原型如下:

void(const redisAsyncContext *c, int status);

当用户主动断开连接时, 参数 status 被设置为 REDIS_OK ； 当发生错误而导致连接断开时 status 被设置为REDIS_ERR 。此时我们可以根据 err 成员变量判断错误产生的情况。

当我们需要进行断线重连时，可以在断开连接回调函数处理。

每个上下文(redisAsyncContext)实例只能设置一次断线回调函数，多次调用会返回REDIS_ERR错误。 使用以下函数设置断线回调函数:

int redisAsyncSetDisconnectCallback(redisAsyncContext *ac, redisDisconnectCallback *fn);

发送命令并设置回调

使用redisAsyncContext时，(每帧)发送的命令会自动pipelined(打包发送命令)。所以我们需要设置reply回调函数来进行命令执行后的处理工作。回调函数原型如下:

void(redisAsyncContext *c, void *reply, void *privdata);

参数 privdata 为用户数据，你可以设置成函数调用时所需要的任意数据。

使用以下函数发送异步命令:

int redisAsyncCommand(
  redisAsyncContext *ac, redisCallbackFn *fn, void *privdata,
  const char *format, ...);
int redisAsyncCommandArgv(
  redisAsyncContext *ac, redisCallbackFn *fn, void *privdata,
  int argc, const char **argv, const size_t *argvlen);

这两个函数和阻塞版本类似。命令成功添加到输出缓冲区时返回 REDIS_OK ，错误时返回 REDIS_ERR 。 例如：当连接被用户中断时，新命令无法被添加，所有类似 redisAsyncCommand 的函数调用都返回 REDIS_ERR错误码。

如果将回调函数设置成  NULL (? privdata，还是reply？需要实验一下 ?)内存被立即释放。当回调函数非空，则内存在调用后释放内存。reply参数只能在回调函数体中使用。

当上下文(redisAsyncContext)发生错误时所有未执行的命令所设置的回调函数都会被调用，回调函数中reply指针为空。

断开连接

异步连接可以使用以下函数终止:

void redisAsyncDisconnect(redisAsyncContext *ac);

当函数被调用时连接并不是立即被断开，而是新的命令不在被接受。(调用函数后)当所有未执行的指令都被写入到socket中，并且命令回调函数都被执行以后，连接才被中断(连接中断回调函数被调用，status为 REDIS_OK )、上下文对象被释放。.

绑定到事件库

There are a few hooks that need to be set on the context object after it is created. See the adapters/ directory for bindings to libev and libevent.