GridTcpDiscoverySpi (gridgain-core 6.1.9 API)

java.lang.Object
- org.gridgain.grid.spi.GridSpiAdapter
- - org.gridgain.grid.spi.discovery.tcp.GridTcpDiscoverySpi

All Implemented Interfaces:

GridDiscoverySpi, GridTcpDiscoverySpiMBean, GridSpi, GridSpiManagementMBean
```
@GridSpiMultipleInstancesSupport(value=true)
@GridDiscoverySpiOrderSupport(value=true)
@GridDiscoverySpiReconnectSupport(value=true)
@GridDiscoverySpiHistorySupport(value=true)
public class GridTcpDiscoverySpi
extends GridSpiAdapter
implements GridDiscoverySpi, GridTcpDiscoverySpiMBean
```
Discovery SPI implementation that uses TCP/IP for node discovery.
Nodes are organized in ring. So almost all network exchange (except few cases) is done across it.
At startup SPI tries to send messages to random IP taken from GridTcpDiscoveryIpFinder about self start (stops when send succeeds) and then this info goes to coordinator. When coordinator processes join request and issues node added messages and all other nodes then receive info about new node.
Configuration

Mandatory
There are no mandatory configuration parameters.
Optional
The following configuration parameters are optional:
- IP finder to share info about nodes IP addresses (see setIpFinder(GridTcpDiscoveryIpFinder)). See the following IP finder implementations for details on configuration:
  - GridTcpDiscoverySharedFsIpFinder
  - GridTcpDiscoveryS3IpFinder
  - GridTcpDiscoveryJdbcIpFinder
  - GridTcpDiscoveryVmIpFinder
  - GridTcpDiscoveryMulticastIpFinder - default
- Metrics store (see setMetricsStore(GridTcpDiscoveryMetricsStore))
- Local address (see setLocalAddress(String))
- Local port to bind to (see setLocalPort(int))
- Local port range to try binding to if previous ports are in use (see setLocalPortRange(int))
- Heartbeat frequency (see setHeartbeatFrequency(long))
- Max missed heartbeats (see setMaxMissedHeartbeats(int))
- Number of times node tries to (re)establish connection to another node (see setReconnectCount(int))
- Network timeout (see setNetworkTimeout(long))
- Socket timeout (see setSocketTimeout(long))
- Message acknowledgement timeout (see setAckTimeout(long))
- Maximum message acknowledgement timeout (see setMaxAckTimeout(long))
- Join timeout (see setJoinTimeout(long))
- Thread priority for threads started by SPI (see setThreadPriority(int))
- IP finder and Metrics Store clean frequency (see setStoresCleanFrequency(long))
- Statistics print frequency (see setStatisticsPrintFrequency(long)
Java Example
```
 GridTcpDiscoverySpi spi = new GridTcpDiscoverySpi();

 GridTcpDiscoveryVmIpFinder finder =
     new GridTcpDiscoveryVmIpFinder();

 spi.setIpFinder(finder);

 GridConfiguration cfg = new GridConfiguration();

 // Override default discovery SPI.
 cfg.setDiscoverySpi(spi);

 // Start grid.
 GridGain.start(cfg);
 
```
Spring Example
GridTcpDiscoverySpi can be configured from Spring XML configuration file:
```
 <bean id="grid.custom.cfg" class="org.gridgain.grid.GridConfiguration" singleton="true">
         ...
         <property name="discoverySpi">
             <bean class="org.gridgain.grid.spi.discovery.tcp.GridTcpDiscoverySpi">
                 <property name="ipFinder">
                     <bean class="org.gridgain.grid.spi.discovery.tcp.ipfinder.vm.GridTcpDiscoveryVmIpFinder" />
                 </property>
             </bean>
         </property>
         ...
 </bean>
 
```
For information about Spring framework visit www.springframework.org
See Also:
GridDiscoverySpi

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTR_EXT_ADDRS` Node attribute that is mapped to node's external addresses (value is `disc.tcp.ext-addrs`).
`static long`	`DFLT_ACK_TIMEOUT` Default timeout for receiving message acknowledgement in milliseconds (value is `5,000ms`).
`static long`	`DFLT_HEARTBEAT_FREQ` Default heartbeat messages issuing frequency (value is `2,000ms`).
`static long`	`DFLT_JOIN_TIMEOUT` Default timeout for joining topology (value is `0`).
`static long`	`DFLT_MAX_ACK_TIMEOUT` Maximum ack timeout value for receiving message acknowledgement in milliseconds (value is `600,000ms`).
`static int`	`DFLT_MAX_MISSED_HEARTBEATS` Default max heartbeats count node can miss without initiating status check (value is `1`).
`static long`	`DFLT_NETWORK_TIMEOUT` Default network timeout in milliseconds (value is `5,000ms`).
`static int`	`DFLT_PORT` Default port to listen (value is `47500`).
`static int`	`DFLT_PORT_RANGE` Default local port range (value is `100`).
`static int`	`DFLT_RECONNECT_CNT` Default reconnect attempts count (value is `10`).
`static long`	`DFLT_SOCK_TIMEOUT` Default socket operations timeout in milliseconds (value is `2,000ms`).
`static long`	`DFLT_STATS_PRINT_FREQ` Default statistics print frequency in milliseconds (value is `0ms`).
`static long`	`DFLT_STORES_CLEAN_FREQ` Default stores (IP finder clean and metrics store) frequency in milliseconds (value is `60,000ms`).
`static int`	`DFLT_THREAD_PRI` Default value for thread priority (value is `10`).
`static int`	`DFLT_TOP_HISTORY_SIZE` Default size of topology snapshots history.

Constructor Summary

Constructors
Constructor and Description

GridTcpDiscoverySpi()

Constructors
Constructor and Description
`GridTcpDiscoverySpi()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`disconnect()` Tells discovery SPI to disconnect from topology.
`long`	`getAckTimeout()` Gets message acknowledgement timeout.
`GridAddressResolver`	`getAddressResolver()` Gets address resolver.
`long`	`getAvgMessageProcessingTime()` Gets avg message processing time.
`UUID`	`getCoordinator()` Gets current coordinator.
`long`	`getCoordinatorSinceTimestamp()` Gets time local node has been coordinator since.
`long`	`getGridStartTime()` Gets start time of the very first node in the grid.
`long`	`getHeartbeatFrequency()` Gets delay between heartbeat messages sent by coordinator.
`GridTcpDiscoveryIpFinder`	`getIpFinder()` Gets IP finder for IP addresses sharing and storing.
`String`	`getIpFinderFormatted()` Gets `GridTcpDiscoveryIpFinder` (string representation).
`long`	`getJoinTimeout()` Gets join timeout.
`String`	`getLocalAddress()` Gets local address that was set to SPI with `setLocalAddress(String)` method.
`GridNode`	`getLocalNode()` Gets local node.
`int`	`getLocalPort()` Gets local TCP port SPI listens to.
`int`	`getLocalPortRange()` Gets local TCP port range.
`long`	`getMaxAckTimeout()` Gets maximum message acknowledgement timeout.
`long`	`getMaxMessageProcessingTime()` Gets max message processing time.
`int`	`getMaxMissedHeartbeats()` Gets max heartbeats count node can miss without initiating status check.
`int`	`getMessageWorkerQueueSize()` Gets message worker queue current size.
`String`	`getMetricsStoreFormatted()` Gets `GridTcpDiscoveryMetricsStore` (string representation).
`long`	`getNetworkTimeout()` Gets network timeout.
`GridNode`	`getNode(UUID nodeId)` Gets node by ID.
`long`	`getNodesFailed()` Gets failed nodes count.
`long`	`getNodesJoined()` Gets joined nodes count.
`long`	`getNodesLeft()` Gets left nodes count.
`long`	`getPendingMessagesDiscarded()` Gets pending messages discarded count.
`long`	`getPendingMessagesRegistered()` Gets pending messages registered count.
`Map<String,Integer>`	`getProcessedMessages()` Gets processed messages counts (grouped by type).
`Map<String,Integer>`	`getReceivedMessages()` Gets received messages counts (grouped by type).
`int`	`getReconnectCount()` Gets number of connection attempts.
`Collection<GridNode>`	`getRemoteNodes()` Gets collection of remote nodes in grid or empty collection if no remote nodes found.
`long`	`getSocketTimeout()` Gets socket timeout.
`protected GridSpiContext`	`getSpiContext()` Gets SPI context.
`String`	`getSpiState()` Gets current SPI state.
`long`	`getStatisticsPrintFrequency()` Gets statistics print frequency.
`long`	`getStoresCleanFrequency()` Gets stores (IP finder and metrics store) clean frequency.
`int`	`getThreadPriority()` Gets thread priority.
`long`	`getTopHistorySize()`
`int`	`getTotalProcessedMessages()` Gets total processed messages count.
`int`	`getTotalReceivedMessages()` Gets total received messages count.
`Collection<Object>`	`injectables()` This method returns SPI internal instances that need to be injected as well.
`protected void`	`onContextDestroyed0()` Method to be called in the beginning of onContextDestroyed() method.
`void`	`onContextInitialized0(GridSpiContext spiCtx)` Method to be called in the end of onContextInitialized method.
`boolean`	`pingNode(UUID nodeId)` Pings the remote node to see if it's alive.
`void`	`reconnect()` Tells discovery SPI to reconnect to topology.
`void`	`setAckTimeout(long ackTimeout)` Sets timeout for receiving acknowledgement for sent message.
`void`	`setAddressResolver(GridAddressResolver addrRslvr)` Sets address resolver.
`void`	`setAuthenticator(GridDiscoverySpiNodeAuthenticator nodeAuth)` Sets discovery SPI node authenticator.
`void`	`setDataExchange(GridDiscoverySpiDataExchange exchange)` Sets a handler for initial data exchange between GridGain nodes.
`void`	`setHeartbeatFrequency(long hbFreq)` Sets delay between issuing of heartbeat messages.
`void`	`setIpFinder(GridTcpDiscoveryIpFinder ipFinder)` Sets IP finder for IP addresses sharing and storing.
`void`	`setJoinTimeout(long joinTimeout)` Sets join timeout.
`void`	`setListener(GridDiscoverySpiListener lsnr)` Sets a listener for discovery events.
`void`	`setLocalAddress(String locAddr)` Sets local host IP address that discovery SPI uses.
`void`	`setLocalPort(int locPort)` Sets local port to listen to.
`void`	`setLocalPortRange(int locPortRange)` Range for local ports.
`void`	`setMaxAckTimeout(long maxAckTimeout)` Sets maximum timeout for receiving acknowledgement for sent message.
`void`	`setMaxMissedHeartbeats(int maxMissedHbs)` Sets max heartbeats count node can miss without initiating status check.
`void`	`setMetricsProvider(GridDiscoveryMetricsProvider metricsProvider)` Sets discovery metrics provider.
`void`	`setMetricsStore(GridTcpDiscoveryMetricsStore metricsStore)` Sets metrics store.
`void`	`setNetworkTimeout(long netTimeout)` Sets maximum network timeout to use for network operations.
`void`	`setNodeAttributes(Map<String,Object> attrs, GridProductVersion ver)` Sets node attributes and node version which will be distributed in grid during join process.
`void`	`setReconnectCount(int reconCnt)` Number of times node tries to (re)establish connection to another node.
`void`	`setSocketTimeout(long sockTimeout)` Sets socket operations timeout.
`void`	`setStatisticsPrintFrequency(long statsPrintFreq)` Sets statistics print frequency.
`void`	`setStoresCleanFrequency(long storesCleanFreq)` Sets stores (IP finder and metrics store) clean frequency in milliseconds.
`void`	`setThreadPriority(int threadPri)` Sets thread priority.
`void`	`setTopHistorySize(int topHistSize)` Sets size of topology snapshots history.
`void`	`spiStart(String gridName)` This method is called to start SPI.
`void`	`spiStop()` This method is called to stop SPI.
`String`	`toString()`

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter
assertParameter, checkConfigurationConsistency0, configInfo, createSpiAttributeName, getConsistentAttributeNames, getGridGainHome, getLocalNodeId, getName, getNodeAttributes, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, onContextDestroyed, onContextInitialized, registerMBean, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gridgain.grid.spi.GridSpi
getName, getNodeAttributes, onContextDestroyed, onContextInitialized

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean
getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted

- Field Detail
  - DFLT_PORT
```
public static final int DFLT_PORT
```
    Default port to listen (value is 47500).
    
    See Also:
    Constant Field Values
  - DFLT_PORT_RANGE
```
public static final int DFLT_PORT_RANGE
```
    Default local port range (value is 100).
    
    See Also:
    Constant Field Values
  - DFLT_NETWORK_TIMEOUT
```
public static final long DFLT_NETWORK_TIMEOUT
```
    Default network timeout in milliseconds (value is 5,000ms).
    
    See Also:
    Constant Field Values
  - DFLT_SOCK_TIMEOUT
```
public static final long DFLT_SOCK_TIMEOUT
```
    Default socket operations timeout in milliseconds (value is 2,000ms).
    
    See Also:
    Constant Field Values
  - DFLT_ACK_TIMEOUT
```
public static final long DFLT_ACK_TIMEOUT
```
    Default timeout for receiving message acknowledgement in milliseconds (value is 5,000ms).
    
    See Also:
    Constant Field Values
  - DFLT_JOIN_TIMEOUT
```
public static final long DFLT_JOIN_TIMEOUT
```
    Default timeout for joining topology (value is 0).
    
    See Also:
    Constant Field Values
  - DFLT_RECONNECT_CNT
```
public static final int DFLT_RECONNECT_CNT
```
    Default reconnect attempts count (value is 10).
    
    See Also:
    Constant Field Values
  - DFLT_HEARTBEAT_FREQ
```
public static final long DFLT_HEARTBEAT_FREQ
```
    Default heartbeat messages issuing frequency (value is 2,000ms).
    
    See Also:
    Constant Field Values
  - DFLT_MAX_MISSED_HEARTBEATS
```
public static final int DFLT_MAX_MISSED_HEARTBEATS
```
    Default max heartbeats count node can miss without initiating status check (value is 1).
    
    See Also:
    Constant Field Values
  - DFLT_THREAD_PRI
```
public static final int DFLT_THREAD_PRI
```
    Default value for thread priority (value is 10).
    
    See Also:
    Constant Field Values
  - DFLT_STORES_CLEAN_FREQ
```
public static final long DFLT_STORES_CLEAN_FREQ
```
    Default stores (IP finder clean and metrics store) frequency in milliseconds (value is 60,000ms).
    
    See Also:
    Constant Field Values
  - DFLT_STATS_PRINT_FREQ
```
public static final long DFLT_STATS_PRINT_FREQ
```
    Default statistics print frequency in milliseconds (value is 0ms).
    
    See Also:
    Constant Field Values
  - DFLT_MAX_ACK_TIMEOUT
```
public static final long DFLT_MAX_ACK_TIMEOUT
```
    Maximum ack timeout value for receiving message acknowledgement in milliseconds (value is 600,000ms).
    
    See Also:
    Constant Field Values
  - DFLT_TOP_HISTORY_SIZE
```
public static final int DFLT_TOP_HISTORY_SIZE
```
    Default size of topology snapshots history.
    
    See Also:
    Constant Field Values
  - ATTR_EXT_ADDRS
```
public static final String ATTR_EXT_ADDRS
```
    Node attribute that is mapped to node's external addresses (value is disc.tcp.ext-addrs).
    
    See Also:
    Constant Field Values
- Constructor Detail
  - GridTcpDiscoverySpi
```
public GridTcpDiscoverySpi()
```
- Method Detail
  - setLocalAddress
```
@GridSpiConfiguration(optional=true)
@GridLocalHostResource
public void setLocalAddress(String locAddr)
```
    Sets local host IP address that discovery SPI uses.
    If not provided, by default a first found non-loopback address will be used. If there is no non-loopback address available, then InetAddress.getLocalHost() will be used.
    
    Parameters:
    locAddr - IP address.
  - getLocalAddress
```
public String getLocalAddress()
```
    Gets local address that was set to SPI with setLocalAddress(String) method.
    
    Returns:
    local address.
  - setAddressResolver
```
@GridSpiConfiguration(optional=true)
@GridAddressResolverResource
public void setAddressResolver(GridAddressResolver addrRslvr)
```
    Sets address resolver.
    
    Parameters:
    addrRslvr - Address resolver.
  - getAddressResolver
```
public GridAddressResolver getAddressResolver()
```
    Gets address resolver.
    
    Returns:
    Address resolver.
  - getReconnectCount
```
public int getReconnectCount()
```
    Gets number of connection attempts.
    
    Specified by:
    
    getReconnectCount in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Number of connection attempts.
  - setReconnectCount
```
@GridSpiConfiguration(optional=true)
public void setReconnectCount(int reconCnt)
```
    Number of times node tries to (re)establish connection to another node.
    Note that SPI implementation will increase ackTimeout by factor 2 on every retry.
    If not specified, default is DFLT_RECONNECT_CNT.
    
    Parameters:
    reconCnt - Number of retries during message sending.
    See Also:
    setAckTimeout(long)
  - getNetworkTimeout
```
public long getNetworkTimeout()
```
    Gets network timeout.
    
    Specified by:
    
    getNetworkTimeout in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Network timeout.
  - setTopHistorySize
```
@GridSpiConfiguration(optional=true)
public void setTopHistorySize(int topHistSize)
```
    Sets size of topology snapshots history. Specified size should be greater than or equal to default size DFLT_TOP_HISTORY_SIZE.
    
    Parameters:
    topHistSize - Size of topology snapshots history.
  - getTopHistorySize
```
public long getTopHistorySize()
```
    Returns:
    Size of topology snapshots history.
  - setNetworkTimeout
```
@GridSpiConfiguration(optional=true)
public void setNetworkTimeout(long netTimeout)
```
    Sets maximum network timeout to use for network operations.
    If not specified, default is DFLT_NETWORK_TIMEOUT.
    
    Parameters:
    netTimeout - Network timeout.
  - getAckTimeout
```
public long getAckTimeout()
```
    Gets message acknowledgement timeout.
    
    Specified by:
    
    getAckTimeout in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Message acknowledgement timeout.
  - setAckTimeout
```
@GridSpiConfiguration(optional=true)
public void setAckTimeout(long ackTimeout)
```
    Sets timeout for receiving acknowledgement for sent message.
    If acknowledgement is not received within this timeout, sending is considered as failed and SPI tries to repeat message sending.
    If not specified, default is DFLT_ACK_TIMEOUT.
    
    Parameters:
    ackTimeout - Acknowledgement timeout.
  - getMaxAckTimeout
```
public long getMaxAckTimeout()
```
    Gets maximum message acknowledgement timeout.
    
    Specified by:
    
    getMaxAckTimeout in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Maximum message acknowledgement timeout.
  - setMaxAckTimeout
```
@GridSpiConfiguration(optional=true)
public void setMaxAckTimeout(long maxAckTimeout)
```
    Sets maximum timeout for receiving acknowledgement for sent message.
    If acknowledgement is not received within this timeout, sending is considered as failed and SPI tries to repeat message sending. Every time SPI retries messing sending, ack timeout will be increased. If no acknowledgement is received and maxAckTimeout is reached, then the process of message sending is considered as failed.
    If not specified, default is DFLT_MAX_ACK_TIMEOUT.
    
    Parameters:
    maxAckTimeout - Maximum acknowledgement timeout.
  - getSocketTimeout
```
public long getSocketTimeout()
```
    Gets socket timeout.
    
    Specified by:
    
    getSocketTimeout in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Socket timeout.
  - setSocketTimeout
```
@GridSpiConfiguration(optional=true)
public void setSocketTimeout(long sockTimeout)
```
    Sets socket operations timeout. This timeout is used to limit connection time and write-to-socket time.
    Note that when running GridGain on Amazon EC2, socket timeout must be set to a value significantly greater than the default (e.g. to 30000).
    If not specified, default is DFLT_SOCK_TIMEOUT.
    
    Parameters:
    sockTimeout - Socket connection timeout.
  - getJoinTimeout
```
public long getJoinTimeout()
```
    Gets join timeout.
    
    Specified by:
    
    getJoinTimeout in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Join timeout.
  - setJoinTimeout
```
@GridSpiConfiguration(optional=true)
public void setJoinTimeout(long joinTimeout)
```
    Sets join timeout.
    If non-shared IP finder is used and node fails to connect to any address from IP finder, node keeps trying to join within this timeout. If all addresses are still unresponsive, exception is thrown and node startup fails.
    If not specified, default is DFLT_JOIN_TIMEOUT.
    
    Parameters:
    joinTimeout - Join timeout (0 means wait forever).
    See Also:
    GridTcpDiscoveryIpFinder.isShared()
  - getLocalPort
```
public int getLocalPort()
```
    Gets local TCP port SPI listens to.
    
    Specified by:
    
    getLocalPort in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Local port range.
  - setLocalPort
```
@GridSpiConfiguration(optional=true)
public void setLocalPort(int locPort)
```
    Sets local port to listen to.
    If not specified, default is DFLT_PORT.
    
    Parameters:
    locPort - Local port to bind.
  - getLocalPortRange
```
public int getLocalPortRange()
```
    Gets local TCP port range.
    
    Specified by:
    
    getLocalPortRange in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Local port range.
  - setLocalPortRange
```
@GridSpiConfiguration(optional=true)
public void setLocalPortRange(int locPortRange)
```
    Range for local ports. Local node will try to bind on first available port starting from getLocalPort() up until getLocalPort() + locPortRange.
    If not specified, default is DFLT_PORT_RANGE.
    
    Parameters:
    locPortRange - Local port range to bind.
  - getHeartbeatFrequency
```
public long getHeartbeatFrequency()
```
    Gets delay between heartbeat messages sent by coordinator.
    
    Specified by:
    
    getHeartbeatFrequency in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Time period in milliseconds.
  - setHeartbeatFrequency
```
@GridSpiConfiguration(optional=true)
public void setHeartbeatFrequency(long hbFreq)
```
    Sets delay between issuing of heartbeat messages. SPI sends heartbeat messages in configurable time interval to other nodes to notify them about its state.
    If not provided, default value is DFLT_HEARTBEAT_FREQ.
    
    Parameters:
    hbFreq - Heartbeat frequency in milliseconds.
  - getMaxMissedHeartbeats
```
public int getMaxMissedHeartbeats()
```
    Gets max heartbeats count node can miss without initiating status check.
    
    Specified by:
    
    getMaxMissedHeartbeats in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Max missed heartbeats.
  - setMaxMissedHeartbeats
```
@GridSpiConfiguration(optional=true)
public void setMaxMissedHeartbeats(int maxMissedHbs)
```
    Sets max heartbeats count node can miss without initiating status check.
    If not provided, default value is DFLT_MAX_MISSED_HEARTBEATS.
    
    Parameters:
    maxMissedHbs - Max missed heartbeats.
  - getStatisticsPrintFrequency
```
public long getStatisticsPrintFrequency()
```
    Gets statistics print frequency.
    
    Specified by:
    
    getStatisticsPrintFrequency in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Statistics print frequency in milliseconds.
  - setStatisticsPrintFrequency
```
@GridSpiConfiguration(optional=true)
public void setStatisticsPrintFrequency(long statsPrintFreq)
```
    Sets statistics print frequency.
    If not set default value is DFLT_STATS_PRINT_FREQ. 0 indicates that no print is required. If value is greater than 0 and log is not quiet then statistics are printed out with INFO level.
    This may be very helpful for tracing topology problems.
    
    Parameters:
    statsPrintFreq - Statistics print frequency in milliseconds.
  - getIpFinder
```
public GridTcpDiscoveryIpFinder getIpFinder()
```
    Gets IP finder for IP addresses sharing and storing.
    
    Returns:
    IP finder for IP addresses sharing and storing.
  - setIpFinder
```
@GridSpiConfiguration(optional=true)
public void setIpFinder(GridTcpDiscoveryIpFinder ipFinder)
```
    Sets IP finder for IP addresses sharing and storing.
    If not provided GridTcpDiscoveryMulticastIpFinder will be used by default.
    
    Parameters:
    ipFinder - IP finder.
  - getThreadPriority
```
public int getThreadPriority()
```
    Gets thread priority. All threads within SPI will be started with it.
    
    Specified by:
    
    getThreadPriority in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Thread priority.
  - setThreadPriority
```
@GridSpiConfiguration(optional=true)
public void setThreadPriority(int threadPri)
```
    Sets thread priority. All threads within SPI will be started with it.
    If not provided, default value is DFLT_THREAD_PRI
    
    Parameters:
    threadPri - Thread priority.
  - getStoresCleanFrequency
```
public long getStoresCleanFrequency()
```
    Gets stores (IP finder and metrics store) clean frequency.
    
    Specified by:
    
    getStoresCleanFrequency in interface GridTcpDiscoverySpiMBean
    
    Returns:
    IP finder clean frequency.
  - setStoresCleanFrequency
```
@GridSpiConfiguration(optional=true)
public void setStoresCleanFrequency(long storesCleanFreq)
```
    Sets stores (IP finder and metrics store) clean frequency in milliseconds.
    If not provided, default value is DFLT_STORES_CLEAN_FREQ
    
    Parameters:
    storesCleanFreq - Stores clean frequency.
  - getSpiState
```
public String getSpiState()
```
    Gets current SPI state.
    
    Specified by:
    
    getSpiState in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Current SPI state.
  - getIpFinderFormatted
```
public String getIpFinderFormatted()
```
    Gets GridTcpDiscoveryIpFinder (string representation).
    
    Specified by:
    
    getIpFinderFormatted in interface GridTcpDiscoverySpiMBean
    
    Returns:
    IPFinder (string representation).
  - getMetricsStoreFormatted
```
@Nullable
public String getMetricsStoreFormatted()
```
    Gets GridTcpDiscoveryMetricsStore (string representation).
    
    Specified by:
    
    getMetricsStoreFormatted in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Metrics store string representation or null if SPI does not use metrics store.
  - getMessageWorkerQueueSize
```
public int getMessageWorkerQueueSize()
```
    Gets message worker queue current size.
    
    Specified by:
    
    getMessageWorkerQueueSize in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Message worker queue current size.
  - getNodesJoined
```
public long getNodesJoined()
```
    Gets joined nodes count.
    
    Specified by:
    
    getNodesJoined in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Nodes joined count.
  - getNodesLeft
```
public long getNodesLeft()
```
    Gets left nodes count.
    
    Specified by:
    
    getNodesLeft in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Left nodes count.
  - getNodesFailed
```
public long getNodesFailed()
```
    Gets failed nodes count.
    
    Specified by:
    
    getNodesFailed in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Failed nodes count.
  - getPendingMessagesRegistered
```
public long getPendingMessagesRegistered()
```
    Gets pending messages registered count.
    
    Specified by:
    
    getPendingMessagesRegistered in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Pending messages registered count.
  - getPendingMessagesDiscarded
```
public long getPendingMessagesDiscarded()
```
    Gets pending messages discarded count.
    
    Specified by:
    
    getPendingMessagesDiscarded in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Pending messages registered count.
  - getAvgMessageProcessingTime
```
public long getAvgMessageProcessingTime()
```
    Gets avg message processing time.
    
    Specified by:
    
    getAvgMessageProcessingTime in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Avg message processing time.
  - getMaxMessageProcessingTime
```
public long getMaxMessageProcessingTime()
```
    Gets max message processing time.
    
    Specified by:
    
    getMaxMessageProcessingTime in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Max message processing time.
  - getTotalReceivedMessages
```
public int getTotalReceivedMessages()
```
    Gets total received messages count.
    
    Specified by:
    
    getTotalReceivedMessages in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Total received messages count.
  - getReceivedMessages
```
public Map<String,Integer> getReceivedMessages()
```
    Gets received messages counts (grouped by type).
    
    Specified by:
    
    getReceivedMessages in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Map containing message types and respective counts.
  - getTotalProcessedMessages
```
public int getTotalProcessedMessages()
```
    Gets total processed messages count.
    
    Specified by:
    
    getTotalProcessedMessages in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Total processed messages count.
  - getProcessedMessages
```
public Map<String,Integer> getProcessedMessages()
```
    Gets processed messages counts (grouped by type).
    
    Specified by:
    
    getProcessedMessages in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Map containing message types and respective counts.
  - getCoordinatorSinceTimestamp
```
public long getCoordinatorSinceTimestamp()
```
    Gets time local node has been coordinator since.
    
    Specified by:
    
    getCoordinatorSinceTimestamp in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Time local node is coordinator since.
  - getCoordinator
```
@Nullable
public UUID getCoordinator()
```
    Gets current coordinator.
    
    Specified by:
    
    getCoordinator in interface GridTcpDiscoverySpiMBean
    
    Returns:
    Gets current coordinator.
  - setMetricsStore
```
@GridSpiConfiguration(optional=true)
public void setMetricsStore(GridTcpDiscoveryMetricsStore metricsStore)
```
    Sets metrics store.
    If provided, SPI does not send metrics across the ring and uses metrics store to exchange metrics. It is recommended to provide metrics store when working with large topologies.
    
    Parameters:
    metricsStore - Metrics store.
  - getLocalNode
```
public GridNode getLocalNode()
```
    Gets local node.
    
    Specified by:
    
    getLocalNode in interface GridDiscoverySpi
    
    Returns:
    Local node.
  - getNode
```
@Nullable
public GridNode getNode(UUID nodeId)
```
    Gets node by ID.
    
    Specified by:
    
    getNode in interface GridDiscoverySpi
    
    Parameters:
    nodeId - Node ID.
    
    Returns:
    Node with given ID or null if node is not found.
  - getRemoteNodes
```
public Collection<GridNode> getRemoteNodes()
```
    Gets collection of remote nodes in grid or empty collection if no remote nodes found.
    
    Specified by:
    
    getRemoteNodes in interface GridDiscoverySpi
    
    Returns:
    Collection of remote nodes.
  - setListener
```
public void setListener(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.
    
    Specified by:
    
    setListener in interface GridDiscoverySpi
    
    Parameters:
    lsnr - Listener to discovery events or null to unset the listener.
  - setDataExchange
```
public void setDataExchange(GridDiscoverySpiDataExchange exchange)
```
    Sets a handler for initial data exchange between GridGain nodes.
    
    Specified by:
    
    setDataExchange in interface GridDiscoverySpi
    
    Parameters:
    exchange - Discovery data exchange handler.
  - setMetricsProvider
```
public void setMetricsProvider(GridDiscoveryMetricsProvider metricsProvider)
```
    Sets discovery metrics provider. Use metrics provided by GridDiscoveryMetricsProvider.getMetrics() method to exchange dynamic metrics between nodes.
    
    Specified by:
    
    setMetricsProvider in interface GridDiscoverySpi
    
    Parameters:
    metricsProvider - Provider of metrics data.
  - setNodeAttributes
```
public 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.
    
    Specified by:
    
    setNodeAttributes in interface GridDiscoverySpi
    
    Parameters:
    attrs - Map of node attributes.
    ver - Product version.
  - injectables
```
public Collection<Object> injectables()
```
    This method returns SPI internal instances that need to be injected as well. Usually these will be instances provided to SPI externally by user, e.g. during SPI configuration.
    
    Overrides:
    
    injectables in class GridSpiAdapter
    
    Returns:
    Internal SPI objects that also need to be injected.
  - spiStart
```
public void spiStart(String gridName)
              throws GridSpiException
```
    This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.
    
    Specified by:
    
    spiStart in interface GridSpi
    
    Parameters:
    gridName - Name of grid instance this SPI is being started for (null for default grid).
    
    Throws:
    
    GridSpiException - Throws in case of any error during SPI start.
  - onContextInitialized0
```
public void onContextInitialized0(GridSpiContext spiCtx)
                           throws GridSpiException
```
    Method to be called in the end of onContextInitialized method.
    
    Overrides:
    
    onContextInitialized0 in class GridSpiAdapter
    
    Parameters:
    spiCtx - SPI context.
    
    Throws:
    
    GridSpiException - In case of errors.
  - getSpiContext
```
protected GridSpiContext getSpiContext()
```
    Gets SPI context.
    
    Overrides:
    
    getSpiContext in class GridSpiAdapter
    
    Returns:
    SPI context.
  - spiStop
```
public void spiStop()
             throws GridSpiException
```
    This method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.
    Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called.
    
    Specified by:
    
    spiStop in interface GridSpi
    
    Throws:
    
    GridSpiException - Thrown in case of any error during SPI stop.
  - onContextDestroyed0
```
protected void onContextDestroyed0()
```
    Method to be called in the beginning of onContextDestroyed() method.
    
    Overrides:
    
    onContextDestroyed0 in class GridSpiAdapter
  - pingNode
```
public boolean pingNode(UUID nodeId)
```
    Pings the remote node to see if it's alive.
    
    Specified by:
    
    pingNode in interface GridDiscoverySpi
    
    Parameters:
    nodeId - Node Id.
    
    Returns:
    true if node alive, false otherwise.
  - disconnect
```
public 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).
    
    Specified by:
    
    disconnect in interface GridDiscoverySpi
    
    Throws:
    
    GridSpiException - If any error occurs.
    See Also:
    GridDiscoverySpi.reconnect()
  - reconnect
```
public 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.
    
    Specified by:
    
    reconnect in interface GridDiscoverySpi
    
    Throws:
    
    GridSpiException - If any error occurs.
    See Also:
    GridDiscoverySpi.disconnect()
  - setAuthenticator
```
public void setAuthenticator(GridDiscoverySpiNodeAuthenticator nodeAuth)
```
    Sets discovery SPI node authenticator. This method is called before SPI start() method.
    
    Specified by:
    
    setAuthenticator in interface GridDiscoverySpi
    
    Parameters:
    nodeAuth - Discovery SPI authenticator.
  - getGridStartTime
```
public 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.
    
    Specified by:
    
    getGridStartTime in interface GridDiscoverySpi
    
    Returns:
    Start time of the first node in grid or 0 if SPI implementation does not support this method.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GridTcpDiscoverySpi

Configuration

Mandatory

Optional

Java Example

Spring Example

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter

Methods inherited from class java.lang.Object

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

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

Field Detail

DFLT_PORT

DFLT_PORT_RANGE

DFLT_NETWORK_TIMEOUT

DFLT_SOCK_TIMEOUT

DFLT_ACK_TIMEOUT

DFLT_JOIN_TIMEOUT

DFLT_RECONNECT_CNT

DFLT_HEARTBEAT_FREQ

DFLT_MAX_MISSED_HEARTBEATS

DFLT_THREAD_PRI

DFLT_STORES_CLEAN_FREQ

DFLT_STATS_PRINT_FREQ

DFLT_MAX_ACK_TIMEOUT

DFLT_TOP_HISTORY_SIZE

ATTR_EXT_ADDRS

Constructor Detail

GridTcpDiscoverySpi

Method Detail

setLocalAddress

getLocalAddress

setAddressResolver

getAddressResolver

getReconnectCount

setReconnectCount

getNetworkTimeout

setTopHistorySize

getTopHistorySize

setNetworkTimeout

getAckTimeout

setAckTimeout

getMaxAckTimeout

setMaxAckTimeout

getSocketTimeout

setSocketTimeout

getJoinTimeout

setJoinTimeout

getLocalPort

setLocalPort

getLocalPortRange

setLocalPortRange

getHeartbeatFrequency

setHeartbeatFrequency

getMaxMissedHeartbeats

setMaxMissedHeartbeats

getStatisticsPrintFrequency

setStatisticsPrintFrequency

getIpFinder

setIpFinder

getThreadPriority

setThreadPriority

getStoresCleanFrequency

setStoresCleanFrequency

getSpiState

getIpFinderFormatted

getMetricsStoreFormatted

getMessageWorkerQueueSize

getNodesJoined

getNodesLeft

getNodesFailed

getPendingMessagesRegistered

getPendingMessagesDiscarded

getAvgMessageProcessingTime

getMaxMessageProcessingTime

getTotalReceivedMessages

getReceivedMessages

getTotalProcessedMessages