From a6a00586b9f14ee78bc27945f971efe2eacc02bd Mon Sep 17 00:00:00 2001 From: Timandes White Date: Mon, 6 Nov 2017 03:19:13 +0000 Subject: [PATCH] Update doc of pecl/zookeeper git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343367 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../functions/zookeeper_dispatch.xml | 70 ++++++++++ reference/zookeeper/reference.xml | 30 +++++ reference/zookeeper/versions.xml | 11 ++ reference/zookeeper/zookeeper.xml | 4 +- reference/zookeeper/zookeeper/addauth.xml | 6 + reference/zookeeper/zookeeper/connect.xml | 6 + reference/zookeeper/zookeeper/construct.xml | 6 + reference/zookeeper/zookeeper/create.xml | 7 + reference/zookeeper/zookeeper/delete.xml | 7 + reference/zookeeper/zookeeper/exists.xml | 6 + reference/zookeeper/zookeeper/get.xml | 6 + reference/zookeeper/zookeeper/getacl.xml | 6 + reference/zookeeper/zookeeper/getchildren.xml | 123 ++++++++++++++++++ reference/zookeeper/zookeeper/getclientid.xml | 6 + .../zookeeper/zookeeper/getrecvtimeout.xml | 6 + reference/zookeeper/zookeeper/getstate.xml | 6 + .../zookeeper/zookeeper/isrecoverable.xml | 6 + reference/zookeeper/zookeeper/set.xml | 6 + reference/zookeeper/zookeeper/setacl.xml | 6 + .../zookeeper/zookeeper/setdebuglevel.xml | 6 + .../zookeeper/setdeterministicconnorder.xml | 6 + .../zookeeper/zookeeper/setlogstream.xml | 6 + reference/zookeeper/zookeeper/setwatcher.xml | 6 + .../zookeeperauthenticationexception.xml | 73 +++++++++++ .../zookeeperconnectionexception.xml | 74 +++++++++++ reference/zookeeper/zookeeperexception.xml | 74 +++++++++++ .../zookeepermarshallingexception.xml | 74 +++++++++++ .../zookeeper/zookeepernonodeexception.xml | 74 +++++++++++ .../zookeeperoperationtimeoutexception.xml | 74 +++++++++++ .../zookeeper/zookeepersessionexception.xml | 74 +++++++++++ 30 files changed, 863 insertions(+), 2 deletions(-) create mode 100644 reference/zookeeper/functions/zookeeper_dispatch.xml create mode 100644 reference/zookeeper/reference.xml create mode 100644 reference/zookeeper/zookeeper/getchildren.xml create mode 100644 reference/zookeeper/zookeeperauthenticationexception.xml create mode 100644 reference/zookeeper/zookeeperconnectionexception.xml create mode 100644 reference/zookeeper/zookeeperexception.xml create mode 100644 reference/zookeeper/zookeepermarshallingexception.xml create mode 100644 reference/zookeeper/zookeepernonodeexception.xml create mode 100644 reference/zookeeper/zookeeperoperationtimeoutexception.xml create mode 100644 reference/zookeeper/zookeepersessionexception.xml diff --git a/reference/zookeeper/functions/zookeeper_dispatch.xml b/reference/zookeeper/functions/zookeeper_dispatch.xml new file mode 100644 index 0000000000..0b9b9cc5e2 --- /dev/null +++ b/reference/zookeeper/functions/zookeeper_dispatch.xml @@ -0,0 +1,70 @@ + + + + + zookeeper_dispatch + Calls callbacks for pending operations. + + + &reftitle.description; + + voidzookeeper_dispatch + + + + + The zookeeper_dispatch function calls the callbacks passwd by operations like Zookeeper::get or Zookeeper::exists. + + + + + Since version 0.4.0, this function must be called to achieve asynchronous operations. + + + + + + + &reftitle.errors; + + This method emits PHP warning when callback could not be invoked. + + + + + &reftitle.seealso; + + + Zookeeper::addAuth + Zookeeper::connect + Zookeeper::__construct + Zookeeper::exists + Zookeeper::get + Zookeeper::getChildren + Zookeeper::setWatcher + + + + + + + diff --git a/reference/zookeeper/reference.xml b/reference/zookeeper/reference.xml new file mode 100644 index 0000000000..f791b6a654 --- /dev/null +++ b/reference/zookeeper/reference.xml @@ -0,0 +1,30 @@ + + + + + ZooKeeper &Functions; + + &reference.zookeeper.entities.functions; + + + + diff --git a/reference/zookeeper/versions.xml b/reference/zookeeper/versions.xml index 150c1e5440..55b4e7a5c0 100644 --- a/reference/zookeeper/versions.xml +++ b/reference/zookeeper/versions.xml @@ -13,6 +13,7 @@ + @@ -23,6 +24,16 @@ + + + + + + + + + + + + + + Zookeeper::getChildren + Lists the children of a node synchronously. + + + + &reftitle.description; + + public + arrayZookeeper::getChildren + stringpath + callablewatcher_cbnull + + + + + &reftitle.parameters; + + + path + + + The name of the node. Expressed as a file name with slashes separating ancestors of the node. + + + + + watcher_cb + + + If nonzero, a watch will be set at the server to notify the client if the node changes. + + + + + + + + &reftitle.returnvalues; + + Returns an array with children paths on success, and false on failure. + + + + + &reftitle.errors; + + This method emits PHP error/warning when parameters count or types are wrong or fail to list children of a node. + + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + + + + + &reftitle.examples; + + <methodname>Zookeeper::getChildren</methodname> example + + Lists children of a node. + + +getchildren($path); +if ($r) + var_dump($r); +else + echo 'ERR'; +?> +]]> + + &example.outputs; + + + string(6) "config" +} +]]> + + + + + + &reftitle.seealso; + + Zookeeper::create + Zookeeper::delete + ZookeeperException + + + + + + diff --git a/reference/zookeeper/zookeeper/getclientid.xml b/reference/zookeeper/zookeeper/getclientid.xml index b4ae6c7edd..e002ec8e80 100644 --- a/reference/zookeeper/zookeeper/getclientid.xml +++ b/reference/zookeeper/zookeeper/getclientid.xml @@ -28,6 +28,11 @@ This method emits PHP error/warning when it could not get client session id. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -37,6 +42,7 @@ Zookeeper::connect Zookeeper::getState ZooKeeper States + ZookeeperException diff --git a/reference/zookeeper/zookeeper/getrecvtimeout.xml b/reference/zookeeper/zookeeper/getrecvtimeout.xml index a3444f6f54..a5b9f44aef 100644 --- a/reference/zookeeper/zookeeper/getrecvtimeout.xml +++ b/reference/zookeeper/zookeeper/getrecvtimeout.xml @@ -28,6 +28,11 @@ This method emits PHP error/warning when operation fails. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -35,6 +40,7 @@ Zookeeper::__construct Zookeeper::connect + ZookeeperException diff --git a/reference/zookeeper/zookeeper/getstate.xml b/reference/zookeeper/zookeeper/getstate.xml index 9891c2a59d..49dc83f7a7 100644 --- a/reference/zookeeper/zookeeper/getstate.xml +++ b/reference/zookeeper/zookeeper/getstate.xml @@ -28,6 +28,11 @@ This method emits PHP error/warning when it fails to get state of zookeeper connection. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -37,6 +42,7 @@ Zookeeper::connect Zookeeper::getClientId ZooKeeper States + ZookeeperException diff --git a/reference/zookeeper/zookeeper/isrecoverable.xml b/reference/zookeeper/zookeeper/isrecoverable.xml index 29fb93ccaf..ef2bc60ee0 100644 --- a/reference/zookeeper/zookeeper/isrecoverable.xml +++ b/reference/zookeeper/zookeeper/isrecoverable.xml @@ -31,6 +31,11 @@ This method emits PHP error/warning when operation fails. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -40,6 +45,7 @@ Zookeeper::connect Zookeeper::getClientId ZooKeeper States + ZookeeperException diff --git a/reference/zookeeper/zookeeper/set.xml b/reference/zookeeper/zookeeper/set.xml index 12f3accc43..e8f1aabcaf 100644 --- a/reference/zookeeper/zookeeper/set.xml +++ b/reference/zookeeper/zookeeper/set.xml @@ -69,6 +69,11 @@ This method emits PHP error/warning when parameters count or types are wrong or fail to save value to node. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -106,6 +111,7 @@ SUCCESS Zookeeper::create Zookeeper::get + ZookeeperException diff --git a/reference/zookeeper/zookeeper/setacl.xml b/reference/zookeeper/zookeeper/setacl.xml index 5da28820b8..daf80752b4 100644 --- a/reference/zookeeper/zookeeper/setacl.xml +++ b/reference/zookeeper/zookeeper/setacl.xml @@ -60,6 +60,11 @@ This method emits PHP error/warning when parameters count or types are wrong or fail to set ACL for a node. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -116,6 +121,7 @@ array(1) { Zookeeper::create Zookeeper::getAcl ZooKeeper Permissions + ZookeeperException diff --git a/reference/zookeeper/zookeeper/setdebuglevel.xml b/reference/zookeeper/zookeeper/setdebuglevel.xml index 72557aaa4f..4eaf1efb3d 100644 --- a/reference/zookeeper/zookeeper/setdebuglevel.xml +++ b/reference/zookeeper/zookeeper/setdebuglevel.xml @@ -43,6 +43,11 @@ This method emits PHP error/warning when parameters count or types are wrong or fail to set debug level. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -77,6 +82,7 @@ SUCCESS &reftitle.seealso; ZooKeeper Log Levels + ZookeeperException diff --git a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml b/reference/zookeeper/zookeeper/setdeterministicconnorder.xml index 5a7f3592a0..da30f259bf 100644 --- a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml +++ b/reference/zookeeper/zookeeper/setdeterministicconnorder.xml @@ -46,6 +46,11 @@ This method emits PHP error/warning when parameters count or types are wrong or operation fails. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -65,6 +70,7 @@ Zookeeper::__construct Zookeeper::connect + ZookeeperException diff --git a/reference/zookeeper/zookeeper/setlogstream.xml b/reference/zookeeper/zookeeper/setlogstream.xml index ec0a3e15bc..4e20be61ac 100644 --- a/reference/zookeeper/zookeeper/setlogstream.xml +++ b/reference/zookeeper/zookeeper/setlogstream.xml @@ -45,12 +45,18 @@ This method emits PHP error/warning when parameters count or types are wrong or operation fails. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + &reftitle.seealso; Zookeeper::setDebugLevel + ZookeeperException diff --git a/reference/zookeeper/zookeeper/setwatcher.xml b/reference/zookeeper/zookeeper/setwatcher.xml index c0e8e50655..c543ae5d01 100644 --- a/reference/zookeeper/zookeeper/setwatcher.xml +++ b/reference/zookeeper/zookeeper/setwatcher.xml @@ -42,6 +42,11 @@ This method emits PHP error/warning when parameters count or types are wrong or fail to set watcher. + + + Since version 0.3.0, this method emits ZookeeperException and it's derivatives. + + @@ -49,6 +54,7 @@ Zookeeper::exists Zookeeper::get + ZookeeperException diff --git a/reference/zookeeper/zookeeperauthenticationexception.xml b/reference/zookeeper/zookeeperauthenticationexception.xml new file mode 100644 index 0000000000..54bd1e0a7c --- /dev/null +++ b/reference/zookeeper/zookeeperauthenticationexception.xml @@ -0,0 +1,73 @@ + + + + + The ZookeeperAuthenticationException class + ZookeeperAuthenticationException + + + + +
+ &reftitle.intro; + + The ZooKeeper authentication exception handling class. + +
+ + +
+ &reftitle.classsynopsis; + + + + ZookeeperAuthenticationException + + + + + ZookeeperAuthenticationException + + + extends + ZookeeperException + + + &InheritedProperties; + + &InheritedMethods; + + + + +
+ +
+ +
+ + + diff --git a/reference/zookeeper/zookeeperconnectionexception.xml b/reference/zookeeper/zookeeperconnectionexception.xml new file mode 100644 index 0000000000..0ac09d2458 --- /dev/null +++ b/reference/zookeeper/zookeeperconnectionexception.xml @@ -0,0 +1,74 @@ + + + + + The ZookeeperConnectionException class + ZookeeperConnectionException + + + + +
+ &reftitle.intro; + + The ZooKeeper connection exception handling class. + +
+ + +
+ &reftitle.classsynopsis; + + + + ZookeeperConnectionException + + + + + ZookeeperConnectionException + + + extends + ZookeeperException + + + &InheritedProperties; + + &InheritedMethods; + + + + + +
+ +
+ +
+ + + diff --git a/reference/zookeeper/zookeeperexception.xml b/reference/zookeeper/zookeeperexception.xml new file mode 100644 index 0000000000..33e77c20f2 --- /dev/null +++ b/reference/zookeeper/zookeeperexception.xml @@ -0,0 +1,74 @@ + + + + + The ZookeeperException class + ZookeeperException + + + + +
+ &reftitle.intro; + + The ZooKeeper exception handling class. + +
+ + +
+ &reftitle.classsynopsis; + + + + ZookeeperException + + + + + ZookeeperException + + + extends + Exception + + + &InheritedProperties; + + &InheritedMethods; + + + + + +
+ +
+ +
+ + + diff --git a/reference/zookeeper/zookeepermarshallingexception.xml b/reference/zookeeper/zookeepermarshallingexception.xml new file mode 100644 index 0000000000..1531ac7915 --- /dev/null +++ b/reference/zookeeper/zookeepermarshallingexception.xml @@ -0,0 +1,74 @@ + + + + + The ZookeeperMarshallingException class + ZookeeperMarshallingException + + + + +
+ &reftitle.intro; + + The ZooKeeper exception (while marshalling or unmarshalling data) handling class. + +
+ + +
+ &reftitle.classsynopsis; + + + + ZookeeperMarshallingException + + + + + ZookeeperMarshallingException + + + extends + ZookeeperException + + + &InheritedProperties; + + &InheritedMethods; + + + + + +
+ +
+ +
+ + + diff --git a/reference/zookeeper/zookeepernonodeexception.xml b/reference/zookeeper/zookeepernonodeexception.xml new file mode 100644 index 0000000000..676c8fa75a --- /dev/null +++ b/reference/zookeeper/zookeepernonodeexception.xml @@ -0,0 +1,74 @@ + + + + + The ZookeeperNoNodeException class + ZookeeperNoNodeException + + + + +
+ &reftitle.intro; + + The ZooKeeper exception (when node does not exist) handling class. + +
+ + +
+ &reftitle.classsynopsis; + + + + ZookeeperNoNodeException + + + + + ZookeeperNoNodeException + + + extends + ZookeeperException + + + &InheritedProperties; + + &InheritedMethods; + + + + + +
+ +
+ +
+ + + diff --git a/reference/zookeeper/zookeeperoperationtimeoutexception.xml b/reference/zookeeper/zookeeperoperationtimeoutexception.xml new file mode 100644 index 0000000000..eb93971f7a --- /dev/null +++ b/reference/zookeeper/zookeeperoperationtimeoutexception.xml @@ -0,0 +1,74 @@ + + + + + The ZookeeperOperationTimeoutException class + ZookeeperOperationTimeoutException + + + + +
+ &reftitle.intro; + + The ZooKeeper operation timeout exception handling class. + +
+ + +
+ &reftitle.classsynopsis; + + + + ZookeeperOperationTimeoutException + + + + + ZookeeperOperationTimeoutException + + + extends + ZookeeperException + + + &InheritedProperties; + + &InheritedMethods; + + + + + +
+ +
+ +
+ + + diff --git a/reference/zookeeper/zookeepersessionexception.xml b/reference/zookeeper/zookeepersessionexception.xml new file mode 100644 index 0000000000..a42b151c6d --- /dev/null +++ b/reference/zookeeper/zookeepersessionexception.xml @@ -0,0 +1,74 @@ + + + + + The ZookeeperSessionException class + ZookeeperSessionException + + + + +
+ &reftitle.intro; + + The ZooKeeper session exception handling class. + +
+ + +
+ &reftitle.classsynopsis; + + + + ZookeeperSessionException + + + + + ZookeeperSessionException + + + extends + ZookeeperException + + + &InheritedProperties; + + &InheritedMethods; + + + + + +
+ +
+ +
+ + +