[hornetq-commits] JBoss hornetq SVN: r8157 - trunk/docs/user-manual/en.

Author: jmesnil Date: 2009-10-28 12:13:10 -0400 (Wed, 28 Oct 2009) New Revision: 8157 Modified: trunk/docs/user-manual/en/clusters.xml trunk/docs/user-manual/en/configuration-index.xml trunk/docs/user-manual/en/ha.xml Log: documentation typo + missing config props Modified: trunk/docs/user-manual/en/clusters.xml =================================================================== --- trunk/docs/user-manual/en/clusters.xml 2009-10-28 13:59:28 UTC (rev 8156) +++ trunk/docs/user-manual/en/clusters.xml 2009-10-28 16:13:10 UTC (rev 8157) @@ -145,7 +145,7 @@ </section> <section id="clusters.discovery-groups"> <title>Discovery Groups</title> - <para>While the broadcast group defines who connector information is broadcast from a + <para>While the broadcast group defines how connector information is broadcasted from a server, a discovery group defines how connector information is received from a multicast address.</para> <para>A discovery group maintains a list of connector pairs - one for each broadcast by @@ -161,7 +161,7 @@ </listitem> <listitem> <para>By messaging clients so they can discovery what servers in the cluster - that they can connect to.</para> + they can connect to.</para> </listitem> </itemizedlist> </section> @@ -582,7 +582,7 @@ balancing policy applied to that list of servers.</para> </section> </section> - <section> + <section id="clusters.static.servers"> <title>Specifying List of Servers to form a Cluster</title> <para>Let's take a look at an example where each cluster connection is defined for a symmetric cluster, but we're not using discovery for each node to discover its Modified: trunk/docs/user-manual/en/configuration-index.xml =================================================================== --- trunk/docs/user-manual/en/configuration-index.xml 2009-10-28 13:59:28 UTC (rev 8156) +++ trunk/docs/user-manual/en/configuration-index.xml 2009-10-28 16:13:10 UTC (rev 8157) @@ -838,6 +838,35 @@ <entry>false</entry> </row> <row> + <entry><link linkend="clusters.static.servers" + >connection-factory.connector-ref.connector-name (attribute)</link></entry> + <entry>String</entry> + <entry>Name of the connector to connect to the live server</entry> + <entry /> + </row> + <row> + <entry><link linkend="clusters.static.servers" + >connection-factory.connector-ref.backup-connector-name (attribute)</link></entry> + <entry>String</entry> + <entry>Name of the connector to connect to the backup server</entry> + <entry /> + </row> + <row> + <entry><link linkend="clusters-discovery.groups.clientside" + >connection-factory.discovery-group-ref.discovery-group-name (attribute)</link></entry> + <entry>String</entry> + <entry>Name of discovery group used by this connection factory</entry> + <entry /> + </row> + <row> + <entry><link linkend="clusters-discovery.groups.clientside" + >connection-factory.discovery-initial-wait-timeout</link></entry> + <entry>Long</entry> + <entry>the initial time to wait (in ms) for discovery groups to wait for + broadcasts</entry> + <entry>2000</entry> + </row> + <row> <entry><link linkend="send-guarantees.nontrans.acks" <entry>Boolean</entry> @@ -911,14 +940,6 @@ <entry>1024 * 1024</entry> </row> <row> - <entry><link linkend="clusters-discovery.groups.clientside" - >connection-factory.discovery-initial-wait-timeout</link></entry> - <entry>Long</entry> - <entry>the initial time to wait (in ms) for discovery groups to wait for - broadcasts</entry> - <entry>2000</entry> - </row> - <row> <entry><link linkend="using-jms.dupsokbatchsize" <entry>Integer</entry> @@ -927,7 +948,7 @@ <entry>1024 * 1024</entry> </row> <row> - <entry><link linkend="ha.client.automatic" + <entry><link linkend="ha.automatic.failover" <entry>Boolean</entry> <entry>whether or not to failover on server shutdown</entry> Modified: trunk/docs/user-manual/en/ha.xml =================================================================== --- trunk/docs/user-manual/en/ha.xml 2009-10-28 13:59:28 UTC (rev 8156) +++ trunk/docs/user-manual/en/ha.xml 2009-10-28 16:13:10 UTC (rev 8157) @@ -119,6 +119,9 @@ <para>In order for live - backup pairs to operate properly with a shared store, both servers must have configured the location of journal directory to point to the <emphasis>same shared location</emphasis> (as explained in <xref linkend="configuring.message.journal" />)</para> + <para>If clients will use automatic failover with JMS, the live server will need to configure a connector + to the backup server and reference it from its <literal>hornetq-jms.xml</literal> configuration as explained + in <xref linkend="ha.automatic.failover" />.</para> </section> <section> <title>Synchronization of live-backup pairs</title> @@ -139,7 +142,7 @@ <listitem><para>application-level failover</para></listitem> </itemizedlist> - <section id="ha.client.automatic"> + <section id="ha.automatic.failover"> <title>Automatic Client Failover</title> <para>HornetQ clients can be configured with knowledge of live and backup servers, so that in event of connection failure of the client - live server connection, the client will @@ -152,8 +155,9 @@ <para>HornetQ clients can be configured with the list of live-backup server pairs in a number of different ways. They can be configured explicitly or probably the most common way of doing this is to use <emphasis>server discovery</emphasis> for the client to - automatically discover the list. For full details on how to configure clients please see - <xref linkend="clusters.server-discovery"/>.</para> + automatically discover the list. For full details on how to configure server discovery, please see + <xref linkend="clusters.server-discovery"/>. Alternatively, the clients can explicitely specifies pairs of + live-backup server as explained in <xref linkend="clusters.static.servers" />.</para> <para>To enable automatic client failover, the client must be configured to allow non-zero reconnection attempts (as explained in <xref linkend="client-reconnection" />).</para> <para>Sometimes you want a client to failover onto a backup server even if the live server