You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by kw...@apache.org on 2011/10/16 19:46:18 UTC

svn commit: r1184883 - in /qpid/trunk/qpid/doc/book/src: Programming-In-Apache-Qpid.xml Qpid-Java-FAQ.xml System-Properties.xml

Author: kwall
Date: Sun Oct 16 17:46:18 2011
New Revision: 1184883

URL: http://svn.apache.org/viewvc?rev=1184883&view=rev
Log:
QPID-3516: Docbook recent changes to Java client system properties

Modified:
    qpid/trunk/qpid/doc/book/src/Programming-In-Apache-Qpid.xml
    qpid/trunk/qpid/doc/book/src/Qpid-Java-FAQ.xml
    qpid/trunk/qpid/doc/book/src/System-Properties.xml

Modified: qpid/trunk/qpid/doc/book/src/Programming-In-Apache-Qpid.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Programming-In-Apache-Qpid.xml?rev=1184883&r1=1184882&r2=1184883&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Programming-In-Apache-Qpid.xml (original)
+++ qpid/trunk/qpid/doc/book/src/Programming-In-Apache-Qpid.xml Sun Oct 16 17:46:18 2011
@@ -3443,9 +3443,8 @@ log4j.appender.console.layout.Conversion
 	              <entry>qpid.amqp.version</entry>
 	              <entry>string</entry>
 	              <entry>0-10</entry>
-                  <entry>Sets the AMQP version to be used - currently supports one of {0-8,0-9,0-91,0-10}</entry>
-                </row>
-
+                      <entry><para>Sets the AMQP version to be used - currently supports one of {0-8,0-9,0-91,0-10}.</para><para>The client will begin negotiation at the specified version and only negotiate downwards if the Broker does not support the specified version.</para></entry>
+                    </row>
 	            <row>
 	              <entry>qpid.heartbeat</entry>
 	              <entry>int</entry>
@@ -3610,15 +3609,20 @@ log4j.appender.console.layout.Conversion
 	              <entry>qpid.transport</entry>
 	              <entry>string</entry>
 	              <entry>org.apache.qpid.transport.network.io.IoNetworkTransport</entry>
-                  <entry><para>The transport implementation to be used.</para><para>A user could specify an alternative transport mechanism that implements the <varname>org.apache.qpid.transport.network.NetworkTransport</varname> interface.</para></entry>
-                </row>
-
+                      <entry><para>The transport implementation to be used.</para><para>A user could specify an alternative transport mechanism that implements the <varname>org.apache.qpid.transport.network.NetworkTransport</varname> interface.</para></entry>
+                    </row>
+	            <row>
+	              <entry>qpid.sync_op_timeout</entry>
+	              <entry>long</entry>
+	              <entry>60000</entry>
+                      <entry><para>The length of time (in milliseconds) to wait for a synchronous operation to complete.</para><para>For compatibility with older clients, the synonym <varname>amqj.default_syncwrite_timeout</varname> is supported.</para></entry>
+                    </row>
 	            <row>
 	              <entry>amqj.tcp_nodelay</entry>
 	              <entry>boolean</entry>
 	              <entry>false</entry>
-                  <entry><para>Sets the TCP_NODELAY property of the underlying socket.</para><para>This could also be set per connection as well (see connection paramters).</para></entry>
-                </row>
+                      <entry><para>Sets the TCP_NODELAY property of the underlying socket.</para><para>This could also be set per connection as well (see connection paramters).</para></entry>
+                    </row>
               </tbody>
             </tgroup>
           </table>

Modified: qpid/trunk/qpid/doc/book/src/Qpid-Java-FAQ.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Qpid-Java-FAQ.xml?rev=1184883&r1=1184882&r2=1184883&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Qpid-Java-FAQ.xml (original)
+++ qpid/trunk/qpid/doc/book/src/Qpid-Java-FAQ.xml Sun Oct 16 17:46:18 2011
@@ -736,35 +736,6 @@ amqj.logging.level
           </para>
 <!--h3--></section>
 
-	  <section role="h3" id="QpidJavaFAQ-HowdoIuseanInVMBrokerformyowntests-3F"><title>
-            How do I
-            use an InVM Broker for my own tests?
-          </title>
-
-	  <para>
-            I would take a look at the testPassiveTTL in
-	    <ulink url="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/systests/src/main/java/org/apache/qpid/server/queue/TimeToLiveTest.java">TimeToLiveTest.java</ulink>
-          </para><para>
-            The setUp and tearDown methods show how to correctly start up a
-            broker for InVM testing. If you write your tests using a file for
-            the JNDI you can then very easily swap between running your tests
-            InVM and against a real broker.
-          </para><para>
-            See our <xref linkend="How-to-Use-JNDI"/> on how to confgure it
-          </para><para>
-            Basically though you just need to set two System Properites:
-          </para><para>
-            java.naming.factory.initial =
-            org.apache.qpid.jndi.PropertiesFileInitialContextFactory
-            java.naming.provider.url = &lt;your JNDI file&gt;
-          </para><para>
-            and call getInitialContext() in your code.
-          </para><para>
-            You will of course need to have the broker libraries on your
-            class path for this to run.
-          </para>
-<!--h3--></section>
-
 	  <section role="h3" id="QpidJavaFAQ-HowcanIinspectthecontentsofmyMessageStore-3F"><title>
             How
             can I inspect the contents of my MessageStore?
@@ -907,31 +878,6 @@ java.lang.NullPointerException 
           </para>
 <!--h3--></section>
 
-	  <section role="h3" id="QpidJavaFAQ-Clientkeepsthrowing-27Serverdidnotrespondinatimelyfashion-27-5Cerrorcode408-3ARequestTimeout-5C."><title>
-            Client keeps throwing 'Server did not respond in a timely
-            fashion' [error code 408: Request Timeout].
-          </title>
-
-	  <para>
-            Certain operations wait for a response from the Server. One such
-            operations is commit. If the server does not respond to the
-            commit request within a set time a Request Timeout [error code:
-            408] exception is thrown (Server did not respond in a timely
-            fashion). This is to ensure that a server that has hung does not
-            cause the client process to be come unresponsive.
-          </para><para>
-            However, it is possible that the server just needs a long time to
-            process a give request. For example, sending a large persistent
-            message when using a persistent store will take some time to a)
-            Transfer accross the network and b) to be fully written to disk.
-          </para><para>
-            These situations require that the default timeout value be
-            increased. A cilent <xref linkend="qpid_System-Properties"/> 'amqj.default_syncwrite_timeout' can be set
-            on the client to increase the wait time. The default in 0.5 is
-            30000 (30s).
-          </para>
-<!--h3--></section>
-
 	  <section role="h3" id="QpidJavaFAQ-CanauseTCPKEEPALIVEorAMQPheartbeatingtokeepmyconnectionopen-3F"><title>
             Can a use TCP_KEEPALIVE or AMQP heartbeating to keep my
             connection open?

Modified: qpid/trunk/qpid/doc/book/src/System-Properties.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/System-Properties.xml?rev=1184883&r1=1184882&r2=1184883&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/System-Properties.xml (original)
+++ qpid/trunk/qpid/doc/book/src/System-Properties.xml Sun Oct 16 17:46:18 2011
@@ -135,7 +135,7 @@
 
 
 	<varlistentry>
-	  <term>amqj.default_syncwrite_timeout</term>
+	  <term>qpid.sync_op_timeout</term>
 	  <listitem>
 	    <variablelist>
 	      <varlistentry>
@@ -144,12 +144,11 @@
 	      </varlistentry>
 	      <varlistentry>
 		<term>Default</term>
-		<listitem><para>30000</para></listitem>
+		<listitem><para>60000</para></listitem>
 	      </varlistentry>
 	    </variablelist>
-	    <para> The number length of time in millisecond to wait
-	    for a synchronous write to complete.
-            </para>
+	    <para>The length of time (in milliseconds) to wait for a synchronous operation to complete.
+                  For compatibility with older	clients, the synonym amqj.default_syncwrite_timeout is supported.</para>
 	  </listitem>
 	</varlistentry>       
 
@@ -193,7 +192,7 @@
 
 
 	<varlistentry>
-	  <term>amqj.tcpNoDelay</term>
+	  <term>amqj.tcp_nodelay</term>
 	  <listitem>
 	    <variablelist>
 	      <varlistentry>
@@ -211,65 +210,6 @@
 	</varlistentry>       
 
 	<varlistentry>
-	  <term>amqj.sendBufferSize</term>
-	  <listitem>
-	    <variablelist>
-	      <varlistentry>
-		<term>integer</term>
-		<listitem><para>Boolean</para></listitem>
-	      </varlistentry>
-	      <varlistentry>
-		<term>Default</term>
-		<listitem><para>32768</para></listitem>
-	      </varlistentry>
-	    </variablelist>
-	    <para>This is the default buffer sized created by Mina.
-            </para>
-	  </listitem>
-	</varlistentry>   
-
-	<varlistentry>
-	  <term>amqj.receiveBufferSize</term>
-	  <listitem>
-	    <variablelist>
-	      <varlistentry>
-		<term>Type</term>
-		<listitem><para>integer</para></listitem>
-	      </varlistentry>
-	      <varlistentry>
-		<term>Default</term>
-		<listitem><para>32768</para></listitem>
-	      </varlistentry>
-	    </variablelist>
-	    <para>This is the default buffer sized created by Mina.
-            </para>
-	  </listitem>
-	</varlistentry>      
-
-
-	<varlistentry>
-	  <term>amqj.protocolprovider.class</term>
-	  <listitem>
-	    <variablelist>
-	      <varlistentry>
-		<term>Type</term>
-		<listitem><para>String</para></listitem>
-	      </varlistentry>
-	      <varlistentry>
-		<term>Default</term>
-		<listitem><para>org.apache.qpid.server.protocol.AMQPFastProtocolHandler</para></listitem>
-	      </varlistentry>
-	    </variablelist>
-	    <para> This specifies the default IoHandlerAdapter that
-	    represents the InVM broker. The IoHandlerAdapter must have
-	    a constructor that takes a single Integer that represents
-	    the InVM port number.
-            </para>
-	  </listitem>
-	</varlistentry>          
-              
-                 
-	<varlistentry>
 	  <term>amqj.protocol.logging.level</term>
 	  <listitem>
 	    <variablelist>



---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project:      http://qpid.apache.org
Use/Interact: mailto:commits-subscribe@qpid.apache.org