org.gridgain.grid.spi.discovery

Interface GridDiscoverySpi

All Superinterfaces:

GridSpi

All Known Implementing Classes:

GridTcpDiscoverySpi

public interface GridDiscoverySpi
extends GridSpi

Grid discovery SPI allows to discover remote nodes in grid.

The default discovery SPI is GridTcpDiscoverySpi with default configuration which allows all nodes in local network (with enabled multicast) to discover each other.

Gridgain provides the following GridDeploymentSpi implementation:

• GridTcpDiscoverySpi

NOTE: this SPI (i.e. methods in this interface) should never be used directly. SPIs provide internal view on the subsystem and is used internally by GridGain kernal. In rare use cases when access to a specific implementation of this SPI is required - an instance of this SPI can be obtained via Grid.configuration() method to check its configuration properties or call other non-SPI methods. Note again that calling methods from this interface on the obtained instance can lead to undefined behavior and explicitly not supported.

Method Summary

Methods

Modifier and Type	Method and Description
void	disconnect() Tells discovery SPI to disconnect from topology.
long	getGridStartTime() Gets start time of the very first node in the grid.
GridNode	getLocalNode() Gets local node.
GridNode	getNode(UUID nodeId) Gets node by ID.
Collection<GridNode>	getRemoteNodes() Gets collection of remote nodes in grid or empty collection if no remote nodes found.
boolean	pingNode(UUID nodeId) Pings the remote node to see if it's alive.
void	reconnect() Tells discovery SPI to reconnect to topology.
void	setAuthenticator(GridDiscoverySpiNodeAuthenticator auth) Sets discovery SPI node authenticator.
void	setDataExchange(GridDiscoverySpiDataExchange exchange) Sets a handler for initial data exchange between GridGain nodes.
void	setListener(GridDiscoverySpiListener lsnr) Sets a listener for discovery events.
void	setMetricsProvider(GridDiscoveryMetricsProvider metricsProvider) Sets discovery metrics provider.
void	setNodeAttributes(Map<String,Object> attrs, GridProductVersion ver) Sets node attributes and node version which will be distributed in grid during join process.

Methods inherited from interface org.gridgain.grid.spi.GridSpi

getName, getNodeAttributes, onContextDestroyed, onContextInitialized, spiStart, spiStop

Method Detail

getRemoteNodes

Collection<GridNode> getRemoteNodes()

Gets collection of remote nodes in grid or empty collection if no remote nodes found.

Returns:

Collection of remote nodes.

getLocalNode

GridNode getLocalNode()

Gets local node.

Returns:

Local node.

getNode

@Nullable
GridNode getNode(UUID nodeId)

Gets node by ID.

Parameters:

nodeId - Node ID.

Returns:

Node with given ID or null if node is not found.

pingNode

boolean pingNode(UUID nodeId)

Pings the remote node to see if it's alive.

Parameters:

nodeId - Node Id.

Returns:

true if node alive, false otherwise.

setNodeAttributes

void setNodeAttributes(Map<String,Object> attrs,
                     GridProductVersion ver)

Sets node attributes and node version which will be distributed in grid during join process. Note that these attributes cannot be changed and set only once.

Parameters:

attrs - Map of node attributes.

ver - Product version.

setListener

void setListener(@Nullable
               GridDiscoverySpiListener lsnr)

Sets a listener for discovery events. Refer to GridDiscoveryEvent for a set of all possible discovery events.

Note that as of GridGain 3.0.2 this method is called before method GridSpi.spiStart(String) is called. This is done to avoid potential window when SPI is started but the listener is not registered yet.

Parameters:

lsnr - Listener to discovery events or null to unset the listener.

setDataExchange

void setDataExchange(GridDiscoverySpiDataExchange exchange)

Sets a handler for initial data exchange between GridGain nodes.

Parameters:

exchange - Discovery data exchange handler.

setMetricsProvider

void setMetricsProvider(GridDiscoveryMetricsProvider metricsProvider)

Sets discovery metrics provider. Use metrics provided by GridDiscoveryMetricsProvider.getMetrics() method to exchange dynamic metrics between nodes.

Parameters:

metricsProvider - Provider of metrics data.

disconnect

void disconnect()
                throws GridSpiException

Tells discovery SPI to disconnect from topology. This is very close to calling GridSpi.spiStop() with accounting that it is not a full stop, but disconnect before reconnect (i.e. some internal threads and resources may be preserved on disconnect and reused on reconnect again).

Throws:

GridSpiException - If any error occurs.

See Also:

reconnect()

reconnect

void reconnect()
               throws GridSpiException

Tells discovery SPI to reconnect to topology. This is very close to calling GridSpi.spiStart(String) with accounting that it is not a full start, but reconnect (i.e. some internal threads and resources may be preserved on disconnect and reused on reconnect again).

Prior to calling this method manager will ensure, that it is in the correct network segment.

Throws:

GridSpiException - If any error occurs.

See Also:

disconnect()

setAuthenticator

void setAuthenticator(GridDiscoverySpiNodeAuthenticator auth)

Sets discovery SPI node authenticator. This method is called before SPI start() method.

Parameters:

auth - Discovery SPI authenticator.

getGridStartTime

long getGridStartTime()

Gets start time of the very first node in the grid. This value should be the same on all nodes in the grid and it should not change even if very first node fails of leaves grid.

Returns:

Start time of the first node in grid or 0 if SPI implementation does not support this method.