[2/3] qpid-jms git commit: NO-JIRA: update docs for failover URI options, include details around using 'nested' options to avoid repeating the same options in each broker URI

[ro...@apache.org]

NO-JIRA: update docs for failover URI options, include details around using 'nested' options to avoid repeating the same options in each broker URI


Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/fb3ffd91
Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/fb3ffd91
Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/fb3ffd91

Branch: refs/heads/master
Commit: fb3ffd9173742f41f3faaecd8e59a6008167a5d0
Parents: 0ba767f
Author: Robert Gemmell <ro...@apache.org>
Authored: Thu Jun 11 13:00:31 2015 +0100
Committer: Robert Gemmell <ro...@apache.org>
Committed: Thu Jun 11 17:45:24 2015 +0100

----------------------------------------------------------------------
 qpid-jms-docs/Configuration.md | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/fb3ffd91/qpid-jms-docs/Configuration.md
----------------------------------------------------------------------
diff --git a/qpid-jms-docs/Configuration.md b/qpid-jms-docs/Configuration.md
index a9e26fc..55f5ae5 100644
--- a/qpid-jms-docs/Configuration.md
+++ b/qpid-jms-docs/Configuration.md
@@ -153,13 +153,18 @@ The complete set of configuration options for failover is listed below:
 
 + **failover.initialReconnectDelay** The amount of time the client will wait before the first attempt to reconnect to a remote peer.  The default value is zero, meaning the first attempt happens immediately.
 + **failover.reconnectDelay** Controls the delay between successive reconnection attempts, defaults to 10 milliseconds.  If the backoff option is not enabled this value remains constant.
-+ **failover.maxReconnectDelay** The maximum time that the client will wait before attempting a reconnect.  This value is only used when the backoff feature is enabled to ensure that the delay doesn't not grow to large.  Defaults to 30 seconds as the max time between connect attempts.
++ **failover.maxReconnectDelay** The maximum time that the client will wait before attempting a reconnect.  This value is only used when the backoff feature is enabled to ensure that the delay doesn't not grow too large.  Defaults to 30 seconds as the max time between connect attempts.
 + **failover.useReconnectBackOff** Controls whether the time between reconnection attempts should grow based on a configured multiplier.  This option defaults to true.
-+ **failover.reconnectBackOffMultiplier** The multiplier used to grow the reconnection delay value, defaults to 2.0d
++ **failover.reconnectBackOffMultiplier** The multiplier used to grow the reconnection delay value, defaults to 2.0d.
 + **failover.maxReconnectAttempts** The number of reconnection attempts allowed before reporting the connection as failed to the client.  The default is no limit or (-1).
-+ **failover.startupMaxReconnectAttempts** For a client that has never connected to a remote peer before this option control how many attempts are made to connect before reporting the connection as failed.  The default is to default to the value of maxReconnectAttempts.
++ **failover.startupMaxReconnectAttempts** For a client that has never connected to a remote peer before this option control how many attempts are made to connect before reporting the connection as failed.  The default is to use the value of maxReconnectAttempts.
 + **failover.warnAfterReconnectAttempts** Controls how often the client will log a message indicating that failover reconnection is being attempted.  The default is to log every 10 connection attempts.
 
+The failover URI options also supports defining 'nested' options applicable to each individual broker URI, which can be used to avoid repetition and define options common to them all. This is accomplished using the same URI options outlined earlier for the indivual broker URI but now prefixed with *failover.nested.*:
+
+    failover:(amqp://broker1:5672,amqp://broker2:5672)?failover.nested.jms.clientID=foo
+
+
 ### AMQP Configuration options
 
 These options apply to the behaviour of certain AMQP functionality.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org