You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by sb...@apache.org on 2015/07/21 15:10:56 UTC
incubator-ignite git commit: ignite-752: adjusting documentation
Repository: incubator-ignite
Updated Branches:
refs/heads/ignite-752 ed0422a4e -> a371f049b
ignite-752: adjusting 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/a371f049
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/a371f049
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/a371f049
Branch: refs/heads/ignite-752
Commit: a371f049beaf0a621be8c01dca05648ef330a94a
Parents: ed0422a
Author: Denis Magda <dm...@gridgain.com>
Authored: Tue Jul 21 16:10:44 2015 +0300
Committer: Denis Magda <dm...@gridgain.com>
Committed: Tue Jul 21 16:10:44 2015 +0300
----------------------------------------------------------------------
.../configuration/IgniteConfiguration.java | 24 ++++++++------------
.../communication/tcp/TcpCommunicationSpi.java | 6 ++---
.../spi/discovery/tcp/TcpDiscoverySpi.java | 12 ++++------
3 files changed, 16 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/a371f049/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
index 5b64696..6fc5893 100644
--- a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
+++ b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java
@@ -1674,26 +1674,20 @@ public class IgniteConfiguration {
}
/**
- * Sets failure detection threshold to use in {@link TcpDiscoverySpi} and {@link TcpCommunicationSpi} for their
- * network related operations.
+ * Sets failure detection threshold to use in {@link TcpDiscoverySpi} and {@link TcpCommunicationSpi}.
* <p>
- * This threshold is used as a maximum timeout for the whole network related operation that usually consists of
- * request and response parts. As an example of such network operation, {@link TcpDiscoverySpi} uses this
- * threshold when a message is send from one {@link ClusterNode} to another. Initially, the full value of the
- * failure detection threshold is set as a socket write timeout when a node starts sending content of a message and
- * then the rest of the threshold is set a socket read timeout when the sending node is waiting for response. If
- * the threshold is reached during the time the message is being sent or response is being received then
- * {@link TcpDiscoverySpi} will process this failure according to its implementation.
- * </p>
+ * The threshold allows to detect node's communication failures with the rest of a cluster faster. Every time when
+ * the threshold is reached during communication between the node and the cluster appropriate actions are
+ * performed depending on a kind of the node (server or client node) and a message with the error is printed out.
* <p>
* The failure detection threshold is an easy and straightforward way to setup {@link TcpDiscoverySpi} and
* {@link TcpCommunicationSpi} depending on network conditions of a cluster. On the other hand if advanced setting
- * of socket write, acknowledgement, network timeouts or other parameters is needed it can be done using specific
- * {@link TcpDiscoverySpi} and {@link TcpCommunicationSpi} APIs. However, sometimes by setting such a timeout or
- * a parameter you will disable the failure detection threshold. The full list of such timeouts and parameters,
- * that disable this threshold, is available as a part of {@link TcpDiscoverySpi} and {@link TcpCommunicationSpi}
+ * of socket write, acknowledgement timeouts or other parameters is needed it can be done using specific
+ * {@link TcpDiscoverySpi} and {@link TcpCommunicationSpi} APIs. However, sometimes the failure detection threshold
+ * will be ignored when such a timeout or parameter is set explicitly. The full list of such timeouts and
+ * parameters is available as a part of {@link TcpDiscoverySpi} and {@link TcpCommunicationSpi}
* documentations.
- * </p>
+ *
* @param failureDetectionThreshold Failure detection threshold in milliseconds.
*/
public void setFailureDetectionThreshold(long failureDetectionThreshold) {
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/a371f049/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 f6daefa..1f09f05 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
@@ -917,7 +917,7 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter
* <p>
* Default to {@link #DFLT_SOCK_WRITE_TIMEOUT}.
* <p>
- * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}.
+ * When this property is explicitly set {@link IgniteConfiguration#getFailureDetectionThreshold()} is ignored.
*
* @param sockWriteTimeout Socket write timeout for TCP connection.
*/
@@ -1028,7 +1028,7 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter
* <p>
* If not provided, default value is {@link #DFLT_MAX_CONN_TIMEOUT}.
* <p>
- * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}.
+ * When this property is explicitly set {@link IgniteConfiguration#getFailureDetectionThreshold()} is ignored.
*
* @param maxConnTimeout Maximum connect timeout.
*/
@@ -1050,7 +1050,7 @@ public class TcpCommunicationSpi extends IgniteSpiAdapter
* <p>
* If not provided, default value is {@link #DFLT_RECONNECT_CNT}.
* <p>
- * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}.
+ * When this property is explicitly set {@link IgniteConfiguration#getFailureDetectionThreshold()} is ignored.
*
* @param reconCnt Maximum number of reconnection attempts.
*/
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/a371f049/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 9e8b2cb..035ac1a 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
@@ -537,7 +537,7 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T
* <p>
* If not specified, default is {@link #DFLT_RECONNECT_CNT}.
* <p>
- * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}.
+ * When this property is explicitly set {@link IgniteConfiguration#getFailureDetectionThreshold()} is ignored.
*
* @param reconCnt Number of retries during message sending.
* @see #setAckTimeout(long)
@@ -568,7 +568,7 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T
* <p>
* Affected server nodes only.
* <p>
- * By setting this value explicitly you disable {@link IgniteConfiguration#getFailureDetectionThreshold()}.
+ * When this property is explicitly set {@link IgniteConfiguration#getFailureDetectionThreshold()} is ignored.
*
* @param maxAckTimeout Maximum acknowledgement timeout.
*/
@@ -745,7 +745,7 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T
* <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()}.
+ * When this property is explicitly set {@link IgniteConfiguration#getFailureDetectionThreshold()} is ignored.
*
* @param sockTimeout Socket connection timeout.
*/
@@ -766,7 +766,7 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T
* <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()}.
+ * When this property is explicitly set {@link IgniteConfiguration#getFailureDetectionThreshold()} is ignored.
*
* @param ackTimeout Acknowledgement timeout.
*/
@@ -783,8 +783,6 @@ 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.
*/
@@ -792,8 +790,6 @@ public class TcpDiscoverySpi extends IgniteSpiAdapter implements DiscoverySpi, T
public TcpDiscoverySpi setNetworkTimeout(long netTimeout) {
this.netTimeout = netTimeout;
- failureDetectionThresholdEnabled(false);
-
return this;
}