diff options
Diffstat (limited to 'doc/source/user/tutorial/lock.rst')
| -rw-r--r-- | doc/source/user/tutorial/lock.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/source/user/tutorial/lock.rst b/doc/source/user/tutorial/lock.rst new file mode 100644 index 0000000..e3aaaae --- /dev/null +++ b/doc/source/user/tutorial/lock.rst @@ -0,0 +1,14 @@ +====== + Lock +====== + +Tooz provides distributed locks. A lock is identified by a name, and a lock can +only be acquired by one coordinator at a time. + +.. literalinclude:: ../../../../examples/lock.py + :language: python + +The method :meth:`tooz.coordination.CoordinationDriver.get_lock` allows +to create a lock identified by a name. Once you retrieve this lock, you can +use it as a context manager or use the :meth:`tooz.locking.Lock.acquire` and +:meth:`tooz.locking.Lock.release` methods to acquire and release the lock. |