Merge pull request #1585 from akka/wip-3470-doc-empty-CurrentClusterState-patriknw

DOC: clarify empty CurrentClusterState for early subscribers, see #3470
This commit is contained in:
Roland Kuhn 2013-07-04 06:40:30 -07:00
commit a858d1bfcf
2 changed files with 10 additions and 0 deletions

View file

@ -186,6 +186,11 @@ You can subscribe to change notifications of the cluster membership by using
``akka.cluster.ClusterEvent.CurrentClusterState``, is sent to the subscriber
as the first event, followed by events for incremental updates.
Note that you may receive an empty ``CurrentClusterState``, containing no members,
if you start the subscription before the initial join procedure has completed.
This is expected behavior. When the node has been accepted in the cluster you will
receive ``MemberUp`` for that node, and other nodes.
The events to track the life-cycle of members are:
* ``ClusterEvent.MemberUp`` - A new member has joined the cluster and its status has been changed to ``Up``.