summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJiangge Zhang <tonyseek@gmail.com>2017-06-12 15:29:27 +0800
committerJiangge Zhang <tonyseek@gmail.com>2017-06-13 12:43:04 +0800
commitec8b337e6f1a4ff12e669f4b96ca98fb37ee5d8a (patch)
tree9e3365381dc68df7803c64e62773f67dae5f170f /docs
parentb4967d16b3daa4b1a00c0f408888b4f61e5486cc (diff)
downloadkazoo-ec8b337e6f1a4ff12e669f4b96ca98fb37ee5d8a.tar.gz
feat(recipe): Add TreeCache recipe
Kazoo implementation of Apache Curator's TreeCache recipe. See also: http://curator.apache.org/curator-recipes/tree-cache.html
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst1
-rw-r--r--docs/api/recipe/cache.rst26
2 files changed, 27 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 744b012..ff921c0 100644
--- 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
new file mode 100644
index 0000000..fb7f372
--- /dev/null
+++ 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: