Skip to content

Commit

Permalink
doc: update heartbeat doc to use start_heart=True
Browse files Browse the repository at this point in the history
Change-Id: I5560b1ec1da7922586e5544d55b5e508c70a33fc
  • Loading branch information
jd committed Apr 27, 2017
1 parent 5946fef commit ba62597
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 17 deletions.
12 changes: 6 additions & 6 deletions doc/source/tutorial/coordinator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
12 changes: 1 addition & 11 deletions examples/coordinator_heartbeat.py
Original file line number Diff line number Diff line change
@@ -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()

0 comments on commit ba62597

Please sign in to comment.