openstack/deb-python-tooz
Code Issues Proposed changes

doc: update heartbeat doc to use start_heart=True

Browse Source 
Change-Id: I5560b1ec1da7922586e5544d55b5e508c70a33fc
This commit is contained in:
Julien Danjou 2017-04-27 16:40:57 +02:00
parent 5946fef119
commit ba62597183
2 changed files with 7 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/tutorial/coordinator.rst
View File

@ -26,16 +26,16 @@ identifying the running program.
After the coordinator is created, it can be used to use the various features
provided.
In order to keep the connection to the coordination server active, you must
call regularly the :meth:`~tooz.coordination.CoordinationDriver.heartbeat`
method. This will ensure that the coordinator is not considered dead by
other program participating in the coordination.
In order to keep the connection to the coordination server active, the method
:meth:`~tooz.coordination.CoordinationDriver.heartbeat` method must be called
regularly. This will ensure that the coordinator is not considered dead by
other program participating in the coordination. Unless you want to call it
manually, you can use tooz builtin heartbeat manager by passing the
`start_heart` argument.
.. literalinclude:: ../../../examples/coordinator_heartbeat.py
:language: python
We use a pretty simple mechanism in this example to send a heartbeat every
once in a while, but depending on your application, you may want to send the
heartbeat at different moment or intervals.
Note that certain drivers, such as `memcached` are heavily based on timeout,

12
examples/coordinator_heartbeat.py
View File

@ -1,15 +1,5 @@
import time
from tooz import coordination
ALIVE_TIME = 5
coordinator = coordination.get_coordinator('zake://', b'host-1')
coordinator.start()
start = time.time()
while time.time() - start < ALIVE_TIME:
coordinator.heartbeat()
time.sleep(0.1)
coordinator.start(start_heart=True)
coordinator.stop()