Merge pull request python-zk#451 from tonyseek/feature/treecache-recipe

Add back the TreeCache recipe
ceache · Jun 13, 2017 · dc3306e · dc3306e
2 parents b4967d1 + ec8b337
commit dc3306e
Show file tree

Hide file tree

Showing 4 changed files with 694 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -16,6 +16,7 @@ organized alphabetically by module name.
    api/interfaces
    api/protocol/states
    api/recipe/barrier
+   api/recipe/cache
    api/recipe/counter
    api/recipe/election
    api/recipe/lease

diff --git a/docs/api/recipe/cache.rst b/docs/api/recipe/cache.rst
@@ -0,0 +1,26 @@
+.. _cache_module:
+
+:mod:`kazoo.recipe.cache`
+----------------------------
+
+.. automodule:: kazoo.recipe.cache
+
+Public API
+++++++++++
+
+    .. autoclass:: TreeCache
+
+        .. automethod:: start
+        .. automethod:: close
+        .. automethod:: listen
+        .. automethod:: listen_fault
+        .. automethod:: get_data
+        .. automethod:: get_children
+
+    .. autoclass:: TreeEvent
+        :members:
+        :show-inheritance:
+
+    .. autoclass:: NodeData
+        :members:
+        :show-inheritance: