org.gridgain.grid.spi.discovery.tcp.internal

Class GridTcpDiscoveryNodesRing

java.lang.Object

org.gridgain.grid.spi.discovery.tcp.internal.GridTcpDiscoveryNodesRing

public class GridTcpDiscoveryNodesRing
extends Object

Convenient way to represent topology for GridTcpDiscoverySpi

Constructor Summary

Constructors

Constructor and Description
GridTcpDiscoveryNodesRing()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(GridTcpDiscoveryNode node) Adds node to topology, also initializes node last update time with current system time.
Collection<GridTcpDiscoveryNode>	allNodes() Gets all nodes in the topology.
void	clear() Removes all remote nodes, leaves only local node.
GridTcpDiscoveryNode	coordinator() Finds coordinator in the topology.
GridTcpDiscoveryNode	coordinator(Collection<GridTcpDiscoveryNode> excluded) Finds coordinator in the topology filtering excluded nodes from the search.
boolean	hasRemoteNodes() Checks whether the topology has remote nodes in.
long	incrementTopologyVersion() Increments topology version and gets new value.
void	localNode(GridTcpDiscoveryNode locNode) Sets local node.
GridTcpDiscoveryNode	nextNode() Finds next node in the topology.
GridTcpDiscoveryNode	nextNode(Collection<GridTcpDiscoveryNode> excluded) Finds next node in the topology filtering excluded nodes from search.
long	nextNodeOrder() Increments topology version and gets new value.
GridTcpDiscoveryNode	node(UUID nodeId) Finds node by ID.
GridTcpDiscoveryNode	previousNode() Finds previous node in the topology.
GridTcpDiscoveryNode	previousNode(Collection<GridTcpDiscoveryNode> excluded) Finds previous node in the topology filtering excluded nodes from search.
Collection<GridTcpDiscoveryNode>	remoteNodes() Gets remote nodes.
GridTcpDiscoveryNode	removeNode(UUID nodeId) Removes node from the topology.
Collection<GridTcpDiscoveryNode>	removeNodes(Collection<UUID> nodeIds) Removes nodes from the topology.
void	restoreTopology(Iterable<GridTcpDiscoveryNode> nodes, long topVer) Restores topology from parameters values.
long	topologyVersion() Gets current topology version.
boolean	topologyVersion(long topVer) Sets new topology version.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GridTcpDiscoveryNodesRing

public GridTcpDiscoveryNodesRing()

Method Detail

localNode

public void localNode(GridTcpDiscoveryNode locNode)

Sets local node.

Parameters:

locNode - Local node.

allNodes

public Collection<GridTcpDiscoveryNode> allNodes()

Gets all nodes in the topology.

Returns:

Collection of all nodes.

remoteNodes

public Collection<GridTcpDiscoveryNode> remoteNodes()

Gets remote nodes.

Returns:

Collection of remote nodes in grid.

hasRemoteNodes

public boolean hasRemoteNodes()

Checks whether the topology has remote nodes in.

Returns:

true if the topology has remote nodes in.

add

public boolean add(GridTcpDiscoveryNode node)

Adds node to topology, also initializes node last update time with current system time.

Parameters:

node - Node to add.

Returns:

true if such node was added and did not present previously in the topology.

restoreTopology

public void restoreTopology(Iterable<GridTcpDiscoveryNode> nodes,
                   long topVer)

Restores topology from parameters values.

This method is called when new node receives topology from coordinator. In this case all nodes received are remote for local.

Also initializes nodes last update time with current system time.

Parameters:

nodes - List of remote nodes.

topVer - Topology version.

node

@Nullable
public GridTcpDiscoveryNode node(UUID nodeId)

Finds node by ID.

Parameters:

nodeId - Node id to find.

Returns:

Node with ID provided or null if not found.

removeNode

@Nullable
public GridTcpDiscoveryNode removeNode(UUID nodeId)

Removes node from the topology.

Parameters:

nodeId - ID of the node to remove.

Returns:

true if node was removed.

removeNodes

public Collection<GridTcpDiscoveryNode> removeNodes(Collection<UUID> nodeIds)

Removes nodes from the topology.

Parameters:

nodeIds - IDs of the nodes to remove.

Returns:

Collection of removed nodes.

clear

public void clear()

Removes all remote nodes, leaves only local node.

This should be called when SPI should be disconnected from topology and reconnected back after.

coordinator

@Nullable
public GridTcpDiscoveryNode coordinator()

Finds coordinator in the topology.

Returns:

Coordinator node that gives versions to topology (node with the smallest order).

coordinator

@Nullable
public GridTcpDiscoveryNode coordinator(@Nullable
                                        Collection<GridTcpDiscoveryNode> excluded)

Finds coordinator in the topology filtering excluded nodes from the search.

This may be used when handling current coordinator leave or failure.

Parameters:

excluded - Nodes to exclude from the search (optional).

Returns:

Coordinator node among remaining nodes or null if all nodes are excluded.

nextNode

@Nullable
public GridTcpDiscoveryNode nextNode()

Finds next node in the topology.

Returns:

Next node.

nextNode

@Nullable
public GridTcpDiscoveryNode nextNode(@Nullable
                                     Collection<GridTcpDiscoveryNode> excluded)

Finds next node in the topology filtering excluded nodes from search.

This may be used when detecting and handling nodes failure.

Parameters:

excluded - Nodes to exclude from the search (optional). If provided, cannot contain local node.

Returns:

Next node or null if all nodes were filtered out or topology contains less than two nodes.

previousNode

@Nullable
public GridTcpDiscoveryNode previousNode()

Finds previous node in the topology.

Returns:

Previous node.

previousNode

@Nullable
public GridTcpDiscoveryNode previousNode(@Nullable
                                         Collection<GridTcpDiscoveryNode> excluded)

Finds previous node in the topology filtering excluded nodes from search.

Parameters:

excluded - Nodes to exclude from the search (optional). If provided, cannot contain local node.

Returns:

Previous node or null if all nodes were filtered out or topology contains less than two nodes.

topologyVersion

public long topologyVersion()

Gets current topology version.

Returns:

Current topology version.

topologyVersion

public boolean topologyVersion(long topVer)

Sets new topology version.

Parameters:

topVer - New topology version (should be greater than current, otherwise no-op).

Returns:

True if topology has been changed.

incrementTopologyVersion

public long incrementTopologyVersion()

Increments topology version and gets new value.

Returns:

Topology version (incremented).

nextNodeOrder

public long nextNodeOrder()

Increments topology version and gets new value.

Returns:

Topology version (incremented).

toString

public String toString()

Overrides:

toString in class Object