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

Class GridTcpDiscoveryMulticastIpFinder

java.lang.Object

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

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

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

All Implemented Interfaces:

GridTcpDiscoveryIpFinder

public class GridTcpDiscoveryMulticastIpFinder
extends GridTcpDiscoveryVmIpFinder

Multicast-based IP finder.

When TCP discovery starts this finder sends multicast request and waits for some time when others nodes reply to this request with messages containing their addresses (time IP finder waits for response and number of attempts to re-send multicast request in case if no replies are received can be configured, see setResponseWaitTime(int) and setAddressRequestAttempts(int)).

In addition to address received via multicast this finder can work with pre-configured list of addresses specified via GridTcpDiscoveryVmIpFinder.setAddresses(Collection) method.

Configuration

Mandatory

There are no mandatory configuration parameters.

Optional

• Multicast IP address (see setMulticastGroup(String)).
• Multicast port number (see setMulticastPort(int)).
• Address response wait time (see setResponseWaitTime(int)).
• Address request attempts (see setAddressRequestAttempts(int)).
• Pre-configured addresses (see GridTcpDiscoveryVmIpFinder.setAddresses(Collection))
• Local address (see setLocalAddress(String))

Field Summary

Fields

Modifier and Type	Field and Description
static int	DFLT_ADDR_REQ_ATTEMPTS Default number of attempts to send multicast address request (value is 2).
static String	DFLT_MCAST_GROUP Default multicast IP address (value is 228.1.2.4).
static int	DFLT_MCAST_PORT Default multicast port number (value is 47400).
static int	DFLT_RES_WAIT_TIME Default time IP finder waits for reply to multicast address request (value is 500).

Constructor Summary

Constructors

Constructor and Description
GridTcpDiscoveryMulticastIpFinder() Constructs new IP finder.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this IP finder and releases any system resources associated with it.
int	getAddressRequestAttempts() Gets number of attempts to send multicast address request.
String	getLocalAddress() Gets local address that multicast IP finder uses.
String	getMulticastGroup() Gets IP address of multicast group.
int	getMulticastPort() Gets port number which multicast messages are sent to.
int	getResponseWaitTime() Gets time in milliseconds IP finder waits for reply to multicast address request.
void	initializeLocalAddresses(Collection<InetSocketAddress> addrs) Initializes addresses discovery SPI binds to.
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	setAddressRequestAttempts(int addrReqAttempts) Sets number of attempts to send multicast address request.
void	setLocalAddress(String locAddr) Sets local host address used by this IP finder.
void	setMulticastGroup(String mcastGrp) Sets IP address of multicast group.
void	setMulticastPort(int mcastPort) Sets port number which multicast messages are sent to.
void	setResponseWaitTime(int resWaitTime) Sets time in milliseconds IP finder waits for reply to multicast address request.
String	toString()

Methods inherited from class org.gridgain.grid.spi.discovery.tcp.ipfinder.vm.GridTcpDiscoveryVmIpFinder

getRegisteredAddresses, registerAddresses, setAddresses, unregisterAddresses

Methods inherited from class org.gridgain.grid.spi.discovery.tcp.ipfinder.GridTcpDiscoveryIpFinderAdapter

isShared, onSpiContextDestroyed, setShared, spiContext

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_MCAST_GROUP

public static final String DFLT_MCAST_GROUP

Default multicast IP address (value is 228.1.2.4).

See Also:

Constant Field Values

DFLT_MCAST_PORT

public static final int DFLT_MCAST_PORT

Default multicast port number (value is 47400).

See Also:

Constant Field Values

DFLT_RES_WAIT_TIME

public static final int DFLT_RES_WAIT_TIME

Default time IP finder waits for reply to multicast address request (value is 500).

See Also:

Constant Field Values

DFLT_ADDR_REQ_ATTEMPTS

public static final int DFLT_ADDR_REQ_ATTEMPTS

Default number of attempts to send multicast address request (value is 2).

See Also:

Constant Field Values

Constructor Detail

GridTcpDiscoveryMulticastIpFinder

public GridTcpDiscoveryMulticastIpFinder()

Constructs new IP finder.

Method Detail

setMulticastGroup

@GridSpiConfiguration(optional=true)
public void setMulticastGroup(String mcastGrp)

Sets IP address of multicast group.

If not provided, default value is DFLT_MCAST_GROUP.

Parameters:

mcastGrp - Multicast IP address.

getMulticastGroup

public String getMulticastGroup()

Gets IP address of multicast group.

Returns:

Multicast IP address.

setMulticastPort

@GridSpiConfiguration(optional=true)
public void setMulticastPort(int mcastPort)

Sets port number which multicast messages are sent to.

If not provided, default value is DFLT_MCAST_PORT.

Parameters:

mcastPort - Multicast port number.

getMulticastPort

public int getMulticastPort()

Gets port number which multicast messages are sent to.

Returns:

Port number.

setResponseWaitTime

@GridSpiConfiguration(optional=true)
public void setResponseWaitTime(int resWaitTime)

Sets time in milliseconds IP finder waits for reply to multicast address request.

If not provided, default value is DFLT_RES_WAIT_TIME.

Parameters:

resWaitTime - Time IP finder waits for reply to multicast address request.

getResponseWaitTime

public int getResponseWaitTime()

Gets time in milliseconds IP finder waits for reply to multicast address request.

Returns:

Time IP finder waits for reply to multicast address request.

setAddressRequestAttempts

@GridSpiConfiguration(optional=true)
public void setAddressRequestAttempts(int addrReqAttempts)

Sets number of attempts to send multicast address request. IP finder re-sends request only in case if no reply for previous request is received.

If not provided, default value is DFLT_ADDR_REQ_ATTEMPTS.

Parameters:

addrReqAttempts - Number of attempts to send multicast address request.

getAddressRequestAttempts

public int getAddressRequestAttempts()

Gets number of attempts to send multicast address request. IP finder re-sends request only in case if no reply for previous request is received.

Returns:

Number of attempts to send multicast address request.

setLocalAddress

@GridSpiConfiguration(optional=true)
public void setLocalAddress(String locAddr)

Sets local host address used by this IP finder. If provided address is non-loopback then multicast socket is bound to this interface. If local address is not set or is any local address then IP finder creates multicast sockets for all found non-loopback addresses.

If not provided then this property is initialized by the local address set in GridTcpDiscoverySpi configuration.

Parameters:

locAddr - Local host address.

See Also:

GridTcpDiscoverySpi.setLocalAddress(String)

getLocalAddress

public String getLocalAddress()

Gets local address that multicast IP finder uses.

Returns:

Local address.

initializeLocalAddresses

public void initializeLocalAddresses(Collection<InetSocketAddress> addrs)
                              throws GridSpiException

Initializes addresses discovery SPI binds to.

Specified by:

initializeLocalAddresses in interface GridTcpDiscoveryIpFinder

Overrides:

initializeLocalAddresses in class GridTcpDiscoveryIpFinderAdapter

Parameters:

addrs - Addresses discovery SPI binds to.

Throws:

GridSpiException - In case of error.

onSpiContextInitialized

public 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.

Specified by:

onSpiContextInitialized in interface GridTcpDiscoveryIpFinder

Overrides:

onSpiContextInitialized in class GridTcpDiscoveryIpFinderAdapter

Parameters:

spiCtx - Spi context.

Throws:

GridSpiException - In case of error.

close

public void close()

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

Specified by:

close in interface GridTcpDiscoveryIpFinder

Overrides:

close in class GridTcpDiscoveryIpFinderAdapter

toString

public String toString()

Overrides:

toString in class GridTcpDiscoveryVmIpFinder