DOC: document Cluster's user API
Some stuff you can do:
val node = Cluster(system) node.registerListener(new MembershipChangeListener { def notify(currentMemberRing: SortedSet[Member]) { .. } }) val membershipStatus = node.status // JOINING, UP, EXITING, LEAVING, REMOVED, DOWN if (node.convergence.isDefined) { .. } // do we have cluster ring convergence? if (node.isLeader) { .. } // is this node the leader? if (node.isAvailable) { .. } // is this node currently considered available? if (node.failureDetector.isAvailable(otherNodeAddress)) { .. } // is the other node available? val likelyhoodBeingDown = node.failureDetector.phi(otherNodeAddress) // how likely is it that he is down?
Leave a comment
on 2012-05-03 09:13 *
By Jonas Bonér
Description changed from Some stuff you can do:
to Some stuff you can do:
Summary changed from DOC: document Node's user API to DOC: document Cluster's user API
on 2012-08-13 09:46 *
By Patrik Nordwall
I'll add a first API/usage description of the membership part when I have implemented the new way of subscribing to membership changes (instead of callback listeners). Before that there is no sensible API to use.
on 2012-08-27 10:19 *
By Patrik Nordwall
First part for membership https://github.com/akka/akka/pull/651
First part merged to master. Closing this ticket, since it too wide. Will document as features are added, or by adding smaller doc tickets.
Updating tickets (#620, #679, #725, #750, #752, #753, #754, #763, #789, #870, #893, #922, #953, #954, #971, #977, #983, #985, #987, #991, #1026, #1045, #1051, #1060, #1061, #1084, #1098, #1099, #1133, #1134, #1135, #1136, #1137, #1194, #1225, #1226, #1243, #1245, #1247, #1248, #1254, #1261, #1300, #1317, #1391, #1412, #1791, #1793, #1901, #1908, #1911, #1912, #1913, #1914, #1915, #1916, #1917, #1922, #1983, #1987, #1996, #1997, #1998, #2066, #2077, #2105, #2117, #2133, #2143, #2149, #2151, #2152, #2153, #2155, #2157, #2158, #2159, #2160, #2161, #2162, #2163, #2164, #2165, #2167, #2171, #2175, #2176, #2177, #2180, #2182, #2184, #2185, #2193, #2199, #2202, #2204, #2206, #2207, #2209, #2210)