org.gridgain.grid.spi.discovery.tcp.metricsstore

Interface GridTcpDiscoveryMetricsStore

All Known Implementing Classes:

GridTcpDiscoveryJdbcMetricsStore, GridTcpDiscoveryMetricsStoreAdapter, GridTcpDiscoverySharedFsMetricsStore, GridTcpDiscoveryVmMetricsStore

public interface GridTcpDiscoveryMetricsStore

Metrics store interface for GridTcpDiscoverySpi.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<UUID>	allNodeIds() Gets all node IDs currently contained in the store.
int	getMetricsExpireTime() Gets metrics expire time in milliseconds.
Map<UUID,GridNodeMetrics>	metrics(Collection<UUID> nodeIds) Gets metrics map for provided nodes.
void	onSpiContextDestroyed() Callback invoked prior to stopping grid before SPI context is destroyed.
void	onSpiContextInitialized(GridSpiContext spiCtx) Callback invoked when SPI context is initialized after GridTcpDiscoverySpi.spiStart(String) method is completed, SPI context can be stored for future access.
void	removeMetrics(Collection<UUID> nodeIds) Removes metrics of provided nodes from the store.
void	updateLocalMetrics(UUID locNodeId, GridNodeMetrics metrics) Updates local node metrics in the store.

Method Detail

onSpiContextInitialized

void onSpiContextInitialized(GridSpiContext spiCtx)
                             throws GridSpiException

Callback invoked when SPI context is initialized after GridTcpDiscoverySpi.spiStart(String) method is completed, SPI context can be stored for future access.

Parameters:

spiCtx - Spi context.

Throws:

GridSpiException - In case of error.

onSpiContextDestroyed

void onSpiContextDestroyed()

Callback invoked prior to stopping grid before SPI context is destroyed. Note that invoking SPI context after this callback is complete is considered illegal and may produce unknown results.

updateLocalMetrics

void updateLocalMetrics(UUID locNodeId,
                      GridNodeMetrics metrics)
                        throws GridSpiException

Updates local node metrics in the store.

Parameters:

locNodeId - Id of the local node (caller node).

metrics - Local node metrics.

Throws:

GridSpiException - If an error occurs.

metrics

Map<UUID,GridNodeMetrics> metrics(Collection<UUID> nodeIds)
                                  throws GridSpiException

Gets metrics map for provided nodes.

Parameters:

nodeIds - Nodes to get metrics for.

Returns:

Map, containing metrics for provided nodes. Potentially empty, but never null.

Throws:

GridSpiException - If an error occurs.

removeMetrics

void removeMetrics(Collection<UUID> nodeIds)
                   throws GridSpiException

Removes metrics of provided nodes from the store.

Parameters:

nodeIds - Nodes to remove metrics of.

Throws:

GridSpiException - If an error occurs.

allNodeIds

Collection<UUID> allNodeIds()
                            throws GridSpiException

Gets all node IDs currently contained in the store.

Returns:

Node IDs currently contained in the store.

Throws:

GridSpiException - if an error occurs.

getMetricsExpireTime

int getMetricsExpireTime()

Gets metrics expire time in milliseconds.

Returns:

Metrics expire time.