ignite-752: adding documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/d9ddfb40 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/d9ddfb40 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/d9ddfb40 Branch: refs/heads/ignite-752 Commit: d9ddfb40242d7c8d6412bfce639773d95787ec34 Parents: 5496d10 Author: Denis Magda <dma...@gridgain.com> Authored: Mon Jul 20 12:16:39 2015 +0300 Committer: Denis Magda <dma...@gridgain.com> Committed: Mon Jul 20 12:16:39 2015 +0300 ---------------------------------------------------------------------- .../communication/tcp/TcpCommunicationSpi.java | 10 +++- .../spi/discovery/tcp/TcpDiscoverySpi.java | 15 +++++- ...entDiscoverySpiFailureThresholdSelfTest.java | 20 +------ .../tcp/TcpClientDiscoverySpiSelfTest.java | 57 ++++++++------------ 4 files changed, 46 insertions(+), 56 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/d9ddfb40/modules/core/src/main/java/org/apache/ignite/spi/communication/tcp/TcpCommunicationSpi.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/spi/communication/tcp/TcpCommunicationSpi.java b/modules/core/src/main/java/org/apache/ignite/spi/communication/tcp/TcpCommunicationSpi.java index 96c8770..e4902df 100644 --- a/modules/core/src/main/java/org/apache/ignite/spi/communication/tcp/TcpCommunicationSpi.java +++ b/modules/core/src/main/java/org/apache/ignite/spi/communication/tcp/TcpCommunicationSpi.java @@ -916,6 +916,8 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter * socket within this time then connection is closed and reconnect is attempted. * <p> * Default to {@link #DFLT_SOCK_WRITE_TIMEOUT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param sockWriteTimeout Socket write timeout for TCP connection. */ @@ -999,6 +1001,8 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter * {@code 0} is interpreted as infinite timeout. * <p> * If not provided, default value is {@link #DFLT_CONN_TIMEOUT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param connTimeout Connect timeout. */ @@ -1023,6 +1027,8 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter * {@code 0} is interpreted as infinite timeout. * <p> * If not provided, default value is {@link #DFLT_MAX_CONN_TIMEOUT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param maxConnTimeout Maximum connect timeout. */ @@ -1043,6 +1049,8 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter * with remote nodes. * <p> * If not provided, default value is {@link #DFLT_RECONNECT_CNT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param reconCnt Maximum number of reconnection attempts. */ @@ -2192,7 +2200,7 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter if (log.isDebugEnabled()) log.debug( - "Handshake timedout (will retry with increased timeout) [timeout=" + connTimeout0 + + "Handshake timed out (will retry with increased timeout) [timeout=" + connTimeout0 + ", addr=" + addr + ", err=" + e + ']'); if (attempt == reconCnt || connTimeout0 > maxConnTimeout) { http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/d9ddfb40/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/TcpDiscoverySpi.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/TcpDiscoverySpi.java b/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/TcpDiscoverySpi.java index 7ffa339..711c08c 100644 --- a/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/TcpDiscoverySpi.java +++ b/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/TcpDiscoverySpi.java @@ -536,6 +536,8 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T * on every retry. * <p> * If not specified, default is {@link #DFLT_RECONNECT_CNT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param reconCnt Number of retries during message sending. * @see #setAckTimeout(long) @@ -565,6 +567,8 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T * If not specified, default is {@link #DFLT_MAX_ACK_TIMEOUT}. * <p> * Affected server nodes only. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param maxAckTimeout Maximum acknowledgement timeout. */ @@ -740,6 +744,8 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T * significantly greater than the default (e.g. to {@code 30000}). * <p> * If not specified, default is {@link #DFLT_SOCK_TIMEOUT} or {@link #DFLT_SOCK_TIMEOUT_CLIENT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param sockTimeout Socket connection timeout. */ @@ -759,6 +765,8 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T * and SPI tries to repeat message sending. * <p> * If not specified, default is {@link #DFLT_ACK_TIMEOUT} or {@link #DFLT_ACK_TIMEOUT_CLIENT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param ackTimeout Acknowledgement timeout. */ @@ -775,6 +783,8 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T * Sets maximum network timeout to use for network operations. * <p> * If not specified, default is {@link #DFLT_NETWORK_TIMEOUT}. + * <p> + * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}. * * @param netTimeout Network timeout. */ @@ -847,12 +857,13 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T * <p> * A node sends connection check messages to its next node in the topology with this frequency to check its * connection status and quickly process a network related error if any. - * </p> * <p> * The way to check connection aliveness with connection check messages is much cheaper than to use heartbeat * messages. The reason is that a connection check message is only processed by the next node in a topology, * while a heartbeat message is translated twice across the ring. - * </p> + * <p> + * Affects server nodes only. + * * @param connCheckFreq Frequency in milliseconds. * @return Tcp discovery spi. * @see IgniteConfiguration#setFailureDetectionThreshold(long) http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/d9ddfb40/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiFailureThresholdSelfTest.java ---------------------------------------------------------------------- diff --git a/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiFailureThresholdSelfTest.java b/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiFailureThresholdSelfTest.java index 8145fd1..bfaeb7c 100644 --- a/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiFailureThresholdSelfTest.java +++ b/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiFailureThresholdSelfTest.java @@ -41,9 +41,8 @@ public class TcpClientDiscoverySpiFailureThresholdSelfTest extends TcpClientDisc } /** {@inheritDoc} */ - @Override protected void await(CountDownLatch latch) throws InterruptedException { - assertTrue("Latch count: " + latch.getCount(), latch.await(failureDetectionThreshold() + - FAILURE_AWAIT_TIME, MILLISECONDS)); + @Override protected long awaitTime() { + return failureDetectionThreshold() + FAILURE_AWAIT_TIME; } /** @@ -65,19 +64,4 @@ public class TcpClientDiscoverySpiFailureThresholdSelfTest extends TcpClientDisc assertEquals(failureDetectionThreshold(), ((TcpDiscoverySpi)(G.ignite("client-0").configuration().getDiscoverySpi())).failureDetectionThreshold()); } - - /** {@inheritDoc} */ - @Override public void testReconnectSegmentedAfterJoinTimeoutServerFailed() throws Exception { - reconnectSegmentedAfterJoinTimeout(true, failureDetectionThreshold() + FAILURE_AWAIT_TIME); - } - - /** {@inheritDoc} */ - @Override public void testReconnectSegmentedAfterJoinTimeoutNetworkError() throws Exception { - reconnectSegmentedAfterJoinTimeout(false, failureDetectionThreshold() + FAILURE_AWAIT_TIME); - } - - /** {@inheritDoc} */ - @Override public void testDisconnectAfterNetworkTimeout() throws Exception { - testDisconnectAfterNetworkTimeout(failureDetectionThreshold() + FAILURE_AWAIT_TIME); - } } http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/d9ddfb40/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiSelfTest.java ---------------------------------------------------------------------- diff --git a/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiSelfTest.java b/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiSelfTest.java index 458e545..994b7b5 100644 --- a/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiSelfTest.java +++ b/modules/core/src/test/java/org/apache/ignite/spi/discovery/tcp/TcpClientDiscoverySpiSelfTest.java @@ -1430,8 +1430,8 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { latch.countDown(); - assertTrue(disconnectLatch.await(10_000, MILLISECONDS)); - assertTrue(reconnectLatch.await(10_000, MILLISECONDS)); + assertTrue(disconnectLatch.await(awaitTime(), MILLISECONDS)); + assertTrue(reconnectLatch.await(awaitTime(), MILLISECONDS)); clientNodeIds.add(client.cluster().localNode().id()); @@ -1482,24 +1482,10 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { } /** - * @throws Exception If failed. - */ - public void testReconnectSegmentedAfterJoinTimeoutServerFailed() throws Exception { - reconnectSegmentedAfterJoinTimeout(true, 10_000); - } - - /** - * @throws Exception If failed. - */ - public void testReconnectSegmentedAfterJoinTimeoutNetworkError() throws Exception { - reconnectSegmentedAfterJoinTimeout(false, 10_000); - } - - /** * @param failSrv If {@code true} fails server, otherwise server does not send join message. * @throws Exception If failed. */ - protected void reconnectSegmentedAfterJoinTimeout(boolean failSrv, long awaitTimeout) throws Exception { + protected void reconnectSegmentedAfterJoinTimeout(boolean failSrv) throws Exception { netTimeout = 4000; joinTimeout = 5000; @@ -1567,9 +1553,9 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { clientSpi.brakeConnection(); } - assertTrue(disconnectLatch.await(awaitTimeout, MILLISECONDS)); + assertTrue(disconnectLatch.await(awaitTime(), MILLISECONDS)); - assertTrue(segmentedLatch.await(awaitTimeout, MILLISECONDS)); + assertTrue(segmentedLatch.await(awaitTime(), MILLISECONDS)); waitSegmented(client); @@ -1582,7 +1568,7 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { @Override public boolean apply() { return srv.cluster().nodes().size() == 1; } - }, awaitTimeout); + }, awaitTime()); checkNodes(1, 0); } @@ -1637,7 +1623,7 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { srv.close(); - assertTrue(disconnectLatch.await(10_000, MILLISECONDS)); + assertTrue(disconnectLatch.await(awaitTime(), MILLISECONDS)); srvNodeIds.clear(); srvIdx.set(0); @@ -1648,7 +1634,7 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { startServerNodes(1); - assertTrue(reconnectLatch.await(10_000, MILLISECONDS)); + assertTrue(reconnectLatch.await(awaitTime(), MILLISECONDS)); clientNodeIds.clear(); clientNodeIds.add(client.cluster().localNode().id()); @@ -1659,17 +1645,9 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { } /** - * @throws Exception If failed. - */ - public void testDisconnectAfterNetworkTimeout() throws Exception { - testDisconnectAfterNetworkTimeout(10_000); - } - - /** - * @param timeout Timeout to wait. * @throws Exception if failed. */ - public void testDisconnectAfterNetworkTimeout(long timeout) throws Exception { + public void testDisconnectAfterNetworkTimeout() throws Exception { netTimeout = 5000; joinTimeout = 60_000; maxMissedClientHbs = 2; @@ -1726,7 +1704,7 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { clientSpi.brakeConnection(); - assertTrue(disconnectLatch.await(timeout, MILLISECONDS)); + assertTrue(disconnectLatch.await(awaitTime(), MILLISECONDS)); log.info("Fail client connection2."); @@ -1735,7 +1713,7 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { clientSpi.brakeConnection(); - assertTrue(reconnectLatch.await(timeout, MILLISECONDS)); + assertTrue(reconnectLatch.await(awaitTime(), MILLISECONDS)); clientNodeIds.clear(); @@ -1746,7 +1724,7 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { public boolean apply() { return srv.cluster().nodes().size() == 2; } - }, timeout); + }, awaitTime()); checkNodes(1, 1); @@ -1982,7 +1960,16 @@ public class TcpClientDiscoverySpiSelfTest extends GridCommonAbstractTest { * @throws InterruptedException If interrupted. */ protected void await(CountDownLatch latch) throws InterruptedException { - assertTrue("Latch count: " + latch.getCount(), latch.await(10_000, MILLISECONDS)); + assertTrue("Latch count: " + latch.getCount(), latch.await(awaitTime(), MILLISECONDS)); + } + + /** + * Time to wait for operation completion. + * + * @return Time in milliseconds. + */ + protected long awaitTime() { + return 10_000; } /**
