Zookeeper C API之回调函数

监视回调函数

原型:

Typedef void (*watcher_fn)(zhandle_t *zh, int type, int state, const char *path, void *watcherCtx);

监视函数原型的各个参数说明如下:

zh Zookeeper句柄(handle)
type 事件类型(event type),_EVENT常量之一
state 连接状态(connection state),状态值为
_STATE常量之一
path 触发监视事件的znode节点的路径,若为NULL,则事件为ZOO_SESSION_EVENT
watcherCtx 监视器上下文(watcher context)

其它回调函数

Zookeeper中有几种在异步API(一般以zoo_a*开头的函数)中使用的回调函数,根据回调函数处理异步函数返回值类型的不同分为以下几类。

// 处理返回 void 类型的回调函数
typedef void(* void_completion_t)(int rc, const void *data);

// 处理返回 Stat 结构的回调函数
typedef void(* stat_completion_t)(int rc, const struct Stat *stat, const void *data);

// 处理返回字符串的回调函数
typedef void(* string_completion_t)(int rc, const char *value, const void *data);

// 处理返回数据的回调函数
typedef void(* data_completion_t)(int rc, const char *value, int value_len, const struct Stat *stat, const void *data);

// 处理返回字符串列表(a list of string)的回调函数
typedef void(* strings_completion_t)(int rc, const struct String_vector *strings, const void *data);

// 同时处理返回字符串列表(a list of string)和 Stat 结构的回调函数
typedef void(* strings_stat_completion_t)(int rc, const struct String_vector *strings, const struct Stat *stat, const void *data);

// 处理以及返回 ACL 信息的回调函数
typedef void(* acl_completion_t)(int rc, struct ACL_vector *acl, struct Stat *stat, const void *data);

处理返回void类型的回调函数
一般在异步API调用结束或zookeeper客户端失去连接时被调用,原型如下:

typedef void(* void_completion_t)(int rc, const void *data);

参数说明如下:

rc:异步函数调用返回的错误码。连接丢失/超时将触发该回调函数,并且错误码为ZCONNECTIONLOSS(zookeeper客户端与服务器端的连接丢失)或者ZOPERATIONTIMEOUT(连接超时);而与数据相关的事件也会触发该回调函数,同时置相应的错误码。
data:由调用者传入的指针,调用者可以通过该指针向回调函数传入自定义的参数。开发人员需要负责此指针所指向内存的释放。

处理返回Stat结构的回调函数
一般在异步API调用结束或zookeeper客户端失去连接时被调用,原型如下:

typedef void(* stat_completion_t)(int rc, const struct Stat *stat, const void *data);

参数说明:

rc:异步函数调用返回的错误码。连接丢失/超时将触发该回调函数,并且错误码为ZCONNECTIONLOSS(zookeeper客户端与服务器端的连接丢失)或者ZOPERATIONTIMEOUT(连接超时);而与数据相关的事件也会触发该回调函数,同时置相应的错误码。
stat:指向与该znode节点相关的Stat信息。如果返回非0值(异步调用函数出错),stat所指向的区域是未定义的,开发者不负责释放stat所指向的内存空间。
data:由调用者传入的指针,调用者可以通过该指针向回调函数传入自定义的参数。开发人员需要负责此指针所指向内存的释放。

处理返回字符串的回调函数
一般在异步API调用结束或zookeeper客户端失去连接时被调用,原型如下:

typedef void(* string_completion_t)(int rc, const char *value, const void *data)

参数说明:

rc:异步函数调用返回的错误码。连接丢失/超时将触发该回调函数,并且错误码为ZCONNECTIONLOSS(zookeeper客户端与服务器端的连接丢失)或者ZOPERATIONTIMEOUT(连接超时);而与数据相关的事件也会触发该回调函数,同时置相应的错误码。
value:返回的字符串
data:由调用者传入的指针,调用者可以通过该指针向回调函数传入自定义的参数。开发人员需要负责此指针所指向内存的释放。

处理返回数据的回调函数
一般在异步API调用结束或zookeeper客户端失去连接时被调用,原型如下:

typedef void(* data_completion_t)(int rc, const char *value, int value_len, const struct Stat *stat, const void *data);

参数说明:

rc:异步函数调用返回的错误码。连接丢失/超时将触发该回调函数,并且错误码为ZCONNECTIONLOSS(zookeeper客户端与服务器端的连接丢失)或者ZOPERATIONTIMEOUT(连接超时);而与数据相关的事件也会触发该回调函数,同时置相应的错误码。
value:异步调用的返回值。如果返回非0,则value所指向的区域是未定义的,开发者不用释放value所指向的内存空间。
value_len:返回value数据字节数(bytes)
stat:指向该znode节点相关的Stat信息。如果返回非0值(异步调用函数出错),stat所指向的区域是未定义的,开发者不负责释放stat所指向的内存空间。
data:由调用者传入的指针,调用者可以通过该指针向回调函数传入自定义的参数。开发人员需要负责此指针所指向内存的释放。

处理返回字符串列表的回调函数
一般在异步API调用结束或zookeeper客户端失去连接时被调用,原型如下:

typedef void(* strings_completion_t)(int rc, const struct String_vector *strings, const void *data);

参数说明:

rc:异步函数调用返回的错误码。连接丢失/超时将触发该回调函数,并且错误码为ZCONNECTIONLOSS(zookeeper客户端与服务器端的连接丢失)或者ZOPERATIONTIMEOUT(连接超时);而与数据相关的事件也会触发该回调函数,同时置相应的错误码。
strings:指向包含了某znode节点的所有子节点名称列表的结构。如果返回非0值,strings所指向的区域是未定义的,开发者不负责释放strings所指向的内存空间。
data:由调用者传入的指针,调用者可以通过该指针向回调函数传入自定义的参数。开发人员需要负责此指针所指向内存的释放。

处理返回字符串列表和Stat结构的回调函数
一般在异步API调用结束或zookeeper客户端失去连接时被调用,原型如下:

typedef void(* strings_stat_completion_t)(int rc, const struct String_vector *strings, const struct Stat *stat, const void *data);

参数说明:

rc:异步函数调用返回的错误码。连接丢失/超时将触发该回调函数,并且错误码为ZCONNECTIONLOSS(zookeeper客户端与服务器端的连接丢失)或者ZOPERATIONTIMEOUT(连接超时);而与数据相关的事件也会触发该回调函数,同时置相应的错误码。
strings:指向包含了某znode节点的所有子节点名称列表的结构。如果返回非0值,strings所指向的区域是未定义的,开发者不负责释放strings所指向的内存空间。
stat:指向该znode节点相关的Stat信息。如果返回非0值(异步调用函数出错),stat所指向的区域是未定义的,开发者不负责释放stat所指向的内存空间。
data:由调用者传入的指针,调用者可以通过该指针向回调函数传入自定义的参数,开发人员需要负责此指针所指向内存的释放。

处理返回ACL信息的回调函数
一般在异步API调用结束或zookeeper客户端失去连接时被调用,原型如下:

typedef void(* acl_completion_t)(int rc, struct ACL_vector *acl, struct Stat *stat, const void *data);

参数说明:

rc:异步函数调用返回的错误码。连接丢失/超时将触发该回调函数,并且错误码为ZCONNECTIONLOSS(zookeeper客户端与服务器端的连接丢失)或者ZOPERATIONTIMEOUT(连接超时);而与数据相关的事件也会触发该回调函数,同时置相应的错误码。
acl:指向包含某znode节点ACL信息的指针。如果返回非0值(异步调用函数出错),acl所指向的区域是未定义的,开发者不负责释放acl所指向的内存空间。
stat:指向该znode节点相关的Stat信息。如果返回非0值(异步调用函数出错),stat所指向的区域是未定义的,开发者不负责释放stat所指向的内存空间。
data:由调用者传入的指针,调用者可以通过该指针向回调函数传入自定义的参数,开发人员需要负责此指针所指向内存的释放。

猜你喜欢

转载自blog.csdn.net/qq_41688455/article/details/83660373