org.gridgain.grid.spi.discovery.tcp.ipfinder

Interface GridTcpDiscoveryIpFinder

All Known Implementing Classes:

GridTcpDiscoveryIpFinderAdapter, GridTcpDiscoveryJdbcIpFinder, GridTcpDiscoveryMulticastIpFinder, GridTcpDiscoverySharedFsIpFinder, GridTcpDiscoveryVmIpFinder

public interface GridTcpDiscoveryIpFinder

IP finder interface for GridTcpDiscoverySpi.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this IP finder and releases any system resources associated with it.
Collection<InetSocketAddress>	getRegisteredAddresses() Gets all addresses registered in this finder.
void	initializeLocalAddresses(Collection<InetSocketAddress> addrs) Initializes addresses discovery SPI binds to.
boolean	isShared() Checks whether IP finder is shared or not.
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	registerAddresses(Collection<InetSocketAddress> addrs) Registers new addresses.
void	unregisterAddresses(Collection<InetSocketAddress> addrs) Unregisters provided addresses.

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.

initializeLocalAddresses

void initializeLocalAddresses(Collection<InetSocketAddress> addrs)
                              throws GridSpiException

Initializes addresses discovery SPI binds to.

Parameters:

addrs - Addresses discovery SPI binds to.

Throws:

GridSpiException - In case of error.

getRegisteredAddresses

Collection<InetSocketAddress> getRegisteredAddresses()
                                                     throws GridSpiException

Gets all addresses registered in this finder.

Returns:

All known addresses, potentially empty, but never null.

Throws:

GridSpiException - In case of error.

isShared

boolean isShared()

Checks whether IP finder is shared or not.

If it is shared then only coordinator can unregister addresses.

All nodes should register their address themselves, as early as possible on node start.

Returns:

true if IP finder is shared.

registerAddresses

void registerAddresses(Collection<InetSocketAddress> addrs)
                       throws GridSpiException

Registers new addresses.

Implementation should accept duplicates quietly, but should not register address if it is already registered.

Parameters:

addrs - Addresses to register. Not null and not empty.

Throws:

GridSpiException - In case of error.

unregisterAddresses

void unregisterAddresses(Collection<InetSocketAddress> addrs)
                         throws GridSpiException

Unregisters provided addresses.

Implementation should accept addresses that are currently not registered quietly (just no-op).

Parameters:

addrs - Addresses to unregister. Not null and not empty.

Throws:

GridSpiException - In case of error.

close

void close()

Closes this IP finder and releases any system resources associated with it.