zookeeper c api 常见变量注释

参考 include/zookeeper.h

Watches
1）Zookeeper 所有的读操作——getData(), getChildren(), 和 exists() 都 可以设置监视(watch)，监视事件可以理解为一次性的触发器
2）客户端只有首先看到了监视事件后，才会感知到它所设置监视的 znode 发生了变化
3）数据监视和子节点监视(data watches and child watches) getData() and exists() 设置数据监视，getChildren() 设置子节点监视
因此， setData() 会触发设置在某一节点上所设置的数据监视(假定数据设置成功)，而一次成功的 create() 操作则会出发当前节点上所设置的数据监视以及父节点的子节点监视。一次成功的 delete() 操作将会触发当前节点的数据监视和子节点监视事件，同时也会触发该节点父节点的child watch。
=======================================================================================================================
与 znode 访问权限有关的常量

•const int ZOO_PERM_READ; //允许客户端读取 znode 节点的值以及子节点列表。

•const int ZOO_PERM_WRITE;// 允许客户端设置 znode 节点的值。

•const int ZOO_PERM_CREATE; //允许客户端在该 znode 节点下创建子节点。

•const int ZOO_PERM_DELETE;//允许客户端删除子节点。

•const int ZOO_PERM_ADMIN; //允许客户端执行 set_acl()。

•const int ZOO_PERM_ALL;//允许客户端执行所有操作，等价与上述所有标志的或(OR) 。

与 ACL IDs 相关的常量

•struct Id ZOO_ANYONE_ID_UNSAFE; //(‘world’,’anyone’)

•struct Id ZOO_AUTH_IDS;// (‘auth’,’’)

三种标准的 ACL

•struct ACL_vector ZOO_OPEN_ACL_UNSAFE; //(ZOO_PERM_ALL,ZOO_ANYONE_ID_UNSAFE)

•struct ACL_vector ZOO_READ_ACL_UNSAFE;// (ZOO_PERM_READ, ZOO_ANYONE_ID_UNSAFE)

•struct ACL_vector ZOO_CREATOR_ALL_ACL; //(ZOO_PERM_ALL,ZOO_AUTH_IDS)

zoo_create 函数标志，ZOO_EPHEMERAL 用来标识创建临时节点，ZOO_SEQUENCE 用来标识节点命名具有递增的后缀序号

=======================================================================================================================
Zookeeper C 常用返回值

ZOK  正常返回
 
ZCONNECTIONLOSS  Zookeeper 客户端与服务器端失去连接
 
ZNONODE  节点不存在(Node does not exist)
 
ZNOAUTH  没有经过授权(Not authenticated)
 
ZNOCHILDRENFOREPHEMERALS  临时节点不能拥有子节点(Ephemeral nodes may not have children)
 
ZNODEEXISTS  节点已经存在(The node already exists)
 
ZNOTEMPTY  该节点具有自身的子节点(The node has children)
 
ZSESSIONEXPIRED  会话过期(The session has been expired by the server)
 
ZINVALIDCALLBACK  非法的回调函数(Invalid callback specified)
 
ZINVALIDACL  非法的ACL(Invalid ACL specified)
 
ZAUTHFAILED  客户端授权失败(Client authentication failed)
 
ZCLOSING  Zookeeper 连接关闭(ZooKeeper is closing)
=======================================================================================================================
与监视类型(Watch Types)相关的常量
以下常量标识监视事件的类型，他们通常用作监视器回调函数的第一个参数。
•ZOO_CREATED_EVENT; // 节点被创建(此前该节点不存在)，通过 zoo_exists() 设置监视。
•ZOO_DELETED_EVENT; // 节点被删除，通过 zoo_exists() 和 zoo_get() 设置监视。
•ZOO_CHANGED_EVENT; // 节点发生变化，通过 zoo_exists() 和 zoo_get() 设置监视。
•ZOO_CHILD_EVENT; // 子节点事件，通过zoo_get_children() 和 zoo_get_children2()设置监视。
•ZOO_SESSION_EVENT; // 会话丢失
•ZOO_NOTWATCHING_EVENT; // 监视被移除。
=======================================================================================================================
与连接状态 Stat 相关的常量
以下常量均与 Zookeeper 连接状态有关，他们通常用作监视器回调函数的参数。
ZOOAPI const int  ZOO_EXPIRED_SESSION_STATE
ZOOAPI const int  ZOO_AUTH_FAILED_STATE
ZOOAPI const int  ZOO_CONNECTING_STATE
ZOOAPI const int  ZOO_ASSOCIATING_STATE
ZOOAPI const int  ZOO_CONNECTED_STATE
=======================================================================================================================
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).

=======================================================================================================================
一些注意：
zoo_init是一个异步函数，如果紧接着有需要stat状态非零的参数，需进行初始化等待的操作。
一般而言，定义两种以上的watcher，其中一个watcher是专门用来监视初始化和关闭状态的。
同步和异步两套接口需要看情况使用，同步的效率没有异步高，但是保证了结果。