[jbosscache-commits] JBoss Cache SVN: r7934 - in core/trunk/src/main: resources/config-samples and 1 other directory.

[jbosscache-commits at lists.jboss.org]

Author: manik.surtani at jboss.com
Date: 2009-03-20 12:00:05 -0400 (Fri, 20 Mar 2009)
New Revision: 7934

Modified:
   core/trunk/src/main/docbook/userguide/en/modules/configuration_reference.xml
   core/trunk/src/main/docbook/userguide/en/modules/replication.xml
   core/trunk/src/main/resources/config-samples/all.xml
Log:
NBST docs and sample cfgs

Modified: core/trunk/src/main/docbook/userguide/en/modules/configuration_reference.xml
===================================================================
--- core/trunk/src/main/docbook/userguide/en/modules/configuration_reference.xml	2009-03-20 15:15:43 UTC (rev 7933)
+++ core/trunk/src/main/docbook/userguide/en/modules/configuration_reference.xml	2009-03-20 16:00:05 UTC (rev 7934)
@@ -2938,6 +2938,17 @@
                      before throwing an exception and aborting startup.
                   </entry>
                </row>
+                <row>
+                  <entry><emphasis role="bold">nonBlocking</emphasis></entry>
+                  <entry>useNonBlockingStateTransfer</entry>
+                  <entry>true, false</entry>
+                  <entry>false</entry>
+                  <entry>
+                     This configuration switch enables the Non-Blocking State Transfer mechanism, new in 3.1.0.  Note that
+                      this requires MVCC as a node locking scheme, and that STREAMING_STATE_TRANSFER is present in the
+                      JGroups stack used.
+                  </entry>
+               </row>
             </tbody>
          </tgroup>
       </table>

Modified: core/trunk/src/main/docbook/userguide/en/modules/replication.xml
===================================================================
--- core/trunk/src/main/docbook/userguide/en/modules/replication.xml	2009-03-20 15:15:43 UTC (rev 7933)
+++ core/trunk/src/main/docbook/userguide/en/modules/replication.xml	2009-03-20 16:00:05 UTC (rev 7934)
@@ -665,7 +665,23 @@
             </listitem>
          </orderedlist>
       </section>
+
       <section>
+          <title>Non-Blocking State Transfer</title>
+          <para>
+              New in JBoss Cache 3.1.0, Non-Blocking State Transfer (NBST) allows senders to generate and stream state while
+              not stopping handling their "work as usual" transactions.  This is particularly important if there is a large
+              volume of state, where generation and streaming of the state can take some time and can cause ongoing
+              transactions on the sender to time out and fail.
+          </para>
+          <para>
+              To achieve this, NBST should be enabled (see
+              configuration reference), and you need to be using MVCC as a node locking scheme.  In addition, you need to
+              use JGroups' STREAMING_STATE_TRANSFER protocol in your cluster properties.
+          </para>
+      </section>
+
+      <section>
          <title>Configuring State Transfer</title>
          <para>
             To ensure state transfer behaves as expected, it is important that all nodes in the cluster are configured

Modified: core/trunk/src/main/resources/config-samples/all.xml
===================================================================
--- core/trunk/src/main/resources/config-samples/all.xml	2009-03-20 15:15:43 UTC (rev 7933)
+++ core/trunk/src/main/resources/config-samples/all.xml	2009-03-20 16:00:05 UTC (rev 7934)
@@ -75,7 +75,7 @@
         <!--
            Defines whether to retrieve state on startup
         -->
-        <stateRetrieval timeout="20000" fetchInMemoryState="false"/>
+        <stateRetrieval timeout="20000" fetchInMemoryState="false" nonBlocking="false"/>
 
         <!--
            Network calls are synchronous.