summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLars Albertsson <lalle@spotify.com>2014-03-12 18:54:56 +0100
committerLars Albertsson <lalle@schibsted.com>2015-03-21 00:25:49 +0100
commit5018efa090e6a580ce596356e26b51dbe88c40a1 (patch)
tree8fe3e60d46545e006a4f7b7a6761ff44ef93da44 /docs
parentfe4df8aa5b661f07a7e310859b617f96a3a76ba7 (diff)
downloadkazoo-5018efa090e6a580ce596356e26b51dbe88c40a1.tar.gz
Add lease recipe.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst1
-rw-r--r--docs/api/recipe/lease.rst19
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 463b4aa..744b012 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -18,6 +18,7 @@ organized alphabetically by module name.
api/recipe/barrier
api/recipe/counter
api/recipe/election
+ api/recipe/lease
api/recipe/lock
api/recipe/partitioner
api/recipe/party
diff --git a/docs/api/recipe/lease.rst b/docs/api/recipe/lease.rst
new file mode 100644
index 0000000..71a961c
--- /dev/null
+++ b/docs/api/recipe/lease.rst
@@ -0,0 +1,19 @@
+.. _lease_module:
+
+:mod:`kazoo.recipe.lease`
+----------------------------
+
+.. automodule:: kazoo.recipe.lease
+
+Public API
+++++++++++
+
+ .. autoclass:: NonBlockingLease
+ :members:
+
+ .. automethod:: __init__
+
+ .. autoclass:: MultiNonBlockingLease
+ :members:
+
+ .. automethod:: __init__