activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From clebertsuco...@apache.org
Subject [1/2] activemq-artemis git commit: ARTEMIS-610 update clientFailureCheckPeriod doc
Date Tue, 05 Jul 2016 16:43:29 GMT
Repository: activemq-artemis
Updated Branches:
  refs/heads/master 9ad8e4c25 -> 9214f504a


ARTEMIS-610 update clientFailureCheckPeriod doc


Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/fd49dc99
Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/fd49dc99
Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/fd49dc99

Branch: refs/heads/master
Commit: fd49dc99d193ecab25c54a6dbd96adaecd6f3d7a
Parents: 9ad8e4c
Author: jbertram <jbertram@apache.org>
Authored: Tue Jul 5 11:33:16 2016 -0500
Committer: jbertram <jbertram@apache.org>
Committed: Tue Jul 5 11:33:16 2016 -0500

----------------------------------------------------------------------
 docs/user-manual/en/connection-ttl.md | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/fd49dc99/docs/user-manual/en/connection-ttl.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/connection-ttl.md b/docs/user-manual/en/connection-ttl.md
index 545e816..c24b5ac 100644
--- a/docs/user-manual/en/connection-ttl.md
+++ b/docs/user-manual/en/connection-ttl.md
@@ -149,17 +149,26 @@ be able to detect that the server or network has failed.
 As long as the client is receiving data from the server it will consider
 the connection to be still alive.
 
-If the client does not receive any packets for
-`client-failure-check-period` milliseconds then it will consider the
-connection failed and will either initiate failover, or call any
-`FailureListener` instances (or `ExceptionListener` instances if you are
-using JMS) depending on how it has been configured.
+If the client does not receive any packets for a configurable number
+of milliseconds then it will consider the connection failed and will
+either initiate failover, or call any `FailureListener` instances (or
+`ExceptionListener` instances if you are using JMS) depending on how 
+it has been configured.
 
-If you're using JMS it's defined by the `ClientFailureCheckPeriod`
-attribute on a `ActiveMQConnectionFactory` instance..
+This is controlled by the `clientFailureCheckPeriod` attribute which can
+be set a number of ways:
+
+- If you're using the core API then you can invoke `org.apache.activemq.artemis.api.core.client.ServerLocator.setClientFailureCheckPeriod(long)`
+
+- If you're using JMS then you can invoke `org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory.setClientFailureCheckPeriod(long)`
+on your `javax.jms.ConnectionFactory`.
+
+- However, the simplest way is to just set the `clientFailureCheckPeriod`
+on the URL your client is using to connect, e.g. 
+`tcp://localhost:61616?clientFailureCheckPeriod=30000`.
 
 The default value for client failure check period on an "unreliable"
-connection (e.g. a Netty connection) is `30000`ms, i.e. 30 seconds. The
+connection (e.g. a Netty connection) is `30000` ms, i.e. 30 seconds. The
 default value for client failure check period on a "reliable" connection
 (e.g. an in-vm connection) is `-1`. A value of `-1` means the client
 will never fail the connection on the client side if no data is received


Mime
View raw message