qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tab...@apache.org
Subject qpid-jms git commit: Add some more details to the configuration doc
Date Wed, 04 Feb 2015 18:51:17 GMT
Repository: qpid-jms
Updated Branches:
  refs/heads/master 13172a68b -> 31b8b6095


Add some more details to the configuration doc

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

Branch: refs/heads/master
Commit: 31b8b6095d4b0ff32346b5c7cc39d1a504ee1ed2
Parents: 13172a6
Author: Timothy Bish <tabish121@gmail.com>
Authored: Wed Feb 4 13:51:10 2015 -0500
Committer: Timothy Bish <tabish121@gmail.com>
Committed: Wed Feb 4 13:51:10 2015 -0500

----------------------------------------------------------------------
 Configuration.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/31b8b609/Configuration.md
----------------------------------------------------------------------
diff --git a/Configuration.md b/Configuration.md
index bdb2f3e..3f96b5f 100644
--- a/Configuration.md
+++ b/Configuration.md
@@ -4,7 +4,7 @@ The client can be configured using the following options applied on the connecti
 
 ## JMS Configuration options
 
-The options apply to the behavior of the JMS objects.
+The options apply to the behavior of the JMS objects such as Connection, Session, MessageConsumer
and MessageProducer.
 
 * __jms.username__ User name value used to authenticate the connection
 * __jms.password__ The password value used to authenticate the connection
@@ -19,6 +19,8 @@ The options apply to the behavior of the JMS objects.
 * __jms.connectTimeout__ Timeout value that controls how long the client waits on Connection
establishment before returning with an error. (By default the client wait 15 seconds for a
connection to be established before failing).
 * __jms.clientIDPrefix__ Optional prefix value that is used for generated Client ID values
when a new Connection is created for the JMS ConnectionFactory.  The default prefix is 'ID:'.
 
+These values control how many message the remote can send to the client and held in a prefetch
buffer for each consumer instance.
+
 * __jms.prefetchPolicy.queuePrefetch__ defaults to 1000
 * __jms.prefetchPolicy.topicPrefetch__ defaults to 1000
 * __jms.prefetchPolicy.queueBrowserPrefetch__ defaults to 1000
@@ -27,6 +29,12 @@ The options apply to the behavior of the JMS objects.
 
 ## TCP Transport Configuration options
 
+When connected to a remote using plain TCP these options configure the behavior of the underlying
socket.  These options are appended to the connection URI along with the other configuration
options, for example:
+
+      amqp://localhost:5672?jms.topicPrefix=foo&transport.connectTimeout=30000
+
+The complete set of TCP Transport options is listed below:
+
 * __transport.sendBufferSize__ default is 64k
 * __transport.receiveBufferSize__ default is 64k
 * __transport.trafficClass__ default is 0
@@ -38,6 +46,14 @@ The options apply to the behavior of the JMS objects.
 
 ## SSL Transport Configuration options
 
+The SSL Transport extends the TCP Transport and is enabled using the *amqps* URI scheme.
 Because the SSL Transport extends the functionality of the TCP based Transport all the TCP
Transport options are valid on an SSL Transport URI.
+
+A simple SSL based client URI is shown below:
+
+    amqps://localhost:5673
+
+The complete set of SSL Transport options is listed below:
+
 * __transport.keyStoreLocation__  default is to read from the system property "javax.net.ssl.keyStore"
 * __transport.keyStorePassword__  default is to read from the system property "javax.net.ssl.keyStorePassword"
 * __transport.trustStoreLocation__  default is to read from the system property "javax.net.ssl.trustStore"
@@ -56,7 +72,7 @@ The URI for failover looks something like the following:
 
     failover:(amqp://broker1:5672,amqp://broker2:5672)?failover.maxReconnectAttempts=20
 
-The complete set of configuration options for failover is documented below:
+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.


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


Mime
View raw message