Add documentation

Change-Id: Ib236d2061f5f375f7314993db7e6fc38d0f8750b

5 files changed, 77 insertions, 0 deletions

diff --git a/examples/coordinator.py b/examples/coordinator.py
new file mode 100644
index 0000000..c6d0792
--- /dev/null
+++ b/examples/coordinator.py
@@ -0,0 +1,5 @@
+from tooz import coordination
+
+coordinator = coordination.get_coordinator('zookeeper', b'host-1')
+coordinator.start()
+coordinator.stop()
diff --git a/examples/coordinator_heartbeat.py b/examples/coordinator_heartbeat.py
new file mode 100644
index 0000000..45539eb
--- /dev/null
+++ b/examples/coordinator_heartbeat.py
@@ -0,0 +1,12 @@
+import time
+
+from tooz import coordination
+
+coordinator = coordination.get_coordinator('memcached', b'host-1')
+coordinator.start()
+
+while True:
+    coordinator.heartbeat()
+    time.sleep(0.1)
+
+coordinator.stop()
diff --git a/examples/group_membership.py b/examples/group_membership.py
new file mode 100644
index 0000000..a94b5e5
--- /dev/null
+++ b/examples/group_membership.py
@@ -0,0 +1,14 @@
+from tooz import coordination
+
+coordinator = coordination.get_coordinator('zookeeper', b'host-1')
+coordinator.start()
+
+# Create a group
+request = coordinator.create_group(b"my group")
+request.get()
+
+# Join a group
+request = coordinator.join_group(b"my group")
+request.get()
+
+coordinator.stop()
diff --git a/examples/group_membership_watch.py b/examples/group_membership_watch.py
new file mode 100644
index 0000000..4da1963
--- /dev/null
+++ b/examples/group_membership_watch.py
@@ -0,0 +1,18 @@
+from tooz import coordination
+
+coordinator = coordination.get_coordinator('zookeeper', b'host-1')
+coordinator.start()
+
+# Create a group
+request = coordinator.create_group(b"my group")
+request.get()
+
+
+def group_joined(event):
+    # Event is an instance of tooz.coordination.MemberJoinedGroup
+    print(event.group_id, event.member_id)
+
+
+coordinator.watch_join_group(b"my group", group_joined)
+
+coordinator.stop()
diff --git a/examples/leader_election.py b/examples/leader_election.py
new file mode 100644
index 0000000..2daea4a
--- /dev/null
+++ b/examples/leader_election.py
@@ -0,0 +1,28 @@
+from tooz import coordination
+
+coordinator = coordination.get_coordinator('zookeeper', b'host-1')
+coordinator.start()
+
+# Create a group
+request = coordinator.create_group(b"my group")
+request.get()
+
+# Join a group
+request = coordinator.join_group(b"my group")
+request.get()
+
+
+def when_i_am_elected_leader(event):
+    # event is a LeaderElected event
+    print(event.group_id, event.member_id)
+
+
+# Propose to be a leader for the group
+coordinator.watch_elected_as_leader(b"my_group",
+                                    when_i_am_elected_leader)
+
+while True:
+    coordinator.heartbeat()
+    coordinator.run_watchers()
+
+coordinator.stop()