akka.cluster
Class HeartbeatNodeRing

java.lang.Object
  extended by akka.cluster.HeartbeatNodeRing
All Implemented Interfaces:
java.io.Serializable, scala.Equals, scala.Product

public class HeartbeatNodeRing
extends java.lang.Object
implements scala.Product, scala.Serializable

INTERNAL API

Data structure for picking heartbeat receivers. The node ring is shuffled by deterministic hashing to avoid picking physically co-located neighbors.

It is immutable, i.e. the methods return new instances.

See Also:
Serialized Form

Constructor Summary
HeartbeatNodeRing(UniqueAddress selfAddress, scala.collection.immutable.Set<UniqueAddress> nodes, scala.collection.immutable.Set<UniqueAddress> unreachable, int monitoredByNrOfMembers)
           
 
Method Summary
 int monitoredByNrOfMembers()
           
 scala.collection.immutable.Set<UniqueAddress> myReceivers()
          Receivers for selfAddress.
 scala.collection.immutable.Set<UniqueAddress> nodes()
           
 scala.collection.immutable.Set<UniqueAddress> receivers(UniqueAddress sender)
          The receivers to use from a specified sender.
 UniqueAddress selfAddress()
           
 scala.collection.immutable.Set<UniqueAddress> unreachable()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface scala.Product
productArity, productElement, productIterator, productPrefix
 
Methods inherited from interface scala.Equals
canEqual, equals
 

Constructor Detail

HeartbeatNodeRing

public HeartbeatNodeRing(UniqueAddress selfAddress,
                         scala.collection.immutable.Set<UniqueAddress> nodes,
                         scala.collection.immutable.Set<UniqueAddress> unreachable,
                         int monitoredByNrOfMembers)
Method Detail

selfAddress

public UniqueAddress selfAddress()

nodes

public scala.collection.immutable.Set<UniqueAddress> nodes()

unreachable

public scala.collection.immutable.Set<UniqueAddress> unreachable()

monitoredByNrOfMembers

public int monitoredByNrOfMembers()

myReceivers

public scala.collection.immutable.Set<UniqueAddress> myReceivers()
Receivers for selfAddress. Cached for subsequent access.

Returns:
(undocumented)

receivers

public scala.collection.immutable.Set<UniqueAddress> receivers(UniqueAddress sender)
The receivers to use from a specified sender.

Parameters:
sender - (undocumented)
Returns:
(undocumented)