Browse Source

ZOOKEEPER-1831. Document remove watches details to the guide (Rakesh R via michim)

git-svn-id: https://svn.apache.org/repos/asf/zookeeper/trunk@1584459 13f79535-47bb-0310-9956-ffa450edef68
Michi Mutsuzaki 11 years ago
parent
commit
d74987b1a6
2 changed files with 25 additions and 1 deletions
  1. 3 0
      CHANGES.txt
  2. 22 1
      src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml

+ 3 - 0
CHANGES.txt

@@ -844,6 +844,9 @@ IMPROVEMENTS:
   ZOOKEEPER-1730. Make ZooKeeper easier to test - support simulating a session
   ZOOKEEPER-1730. Make ZooKeeper easier to test - support simulating a session
   expiration (Jordan Zimmerman via michim)
   expiration (Jordan Zimmerman via michim)
 
 
+  ZOOKEEPER-1831. Document remove watches details to the guide (Rakesh R via
+  michim)
+
 headers
 headers
 
 
 Release 3.4.0 - 
 Release 3.4.0 - 

+ 22 - 1
src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml

@@ -677,7 +677,28 @@
         </listitem>
         </listitem>
       </itemizedlist>
       </itemizedlist>
 	</section>
 	</section>
-	
+
+    <section id="sc_WatchRemoval">
+      <title>Remove Watches</title>
+      <para>We can remove the watches registered on a znode with a call to 
+      removeWatches. Also, a ZooKeeper client can remove watches locally even
+      if there is no server connection by setting the local flag to true. The 
+      following list details the events which will be triggered after the 
+      successful watch removal.
+      </para>
+      <itemizedlist>
+        <listitem>
+          <para><emphasis role="bold">Child Remove event:</emphasis></para>
+          <para>Watcher which was added with a call to getChildren.</para>
+        </listitem>
+        
+        <listitem>
+          <para><emphasis role="bold">Data Remove event:</emphasis></para>
+          <para>Watcher which was added with a call to exists or getData.</para>
+        </listitem>
+      </itemizedlist>
+   </section>
+
     <section id="sc_WatchGuarantees">
     <section id="sc_WatchGuarantees">
       <title>What ZooKeeper Guarantees about Watches</title>
       <title>What ZooKeeper Guarantees about Watches</title>