[jboss-cvs] JBossCache/docs/JBossCache-UserGuide/en/modules ...
Manik Surtani
msurtani at jboss.com
Wed Jan 24 13:05:25 EST 2007
User: msurtani
Date: 07/01/24 13:05:25
Modified: docs/JBossCache-UserGuide/en/modules replication.xml
configuration_reference.xml
Log:
Updated config reference
Revision Changes Path
1.5 +1 -1 JBossCache/docs/JBossCache-UserGuide/en/modules/replication.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: replication.xml
===================================================================
RCS file: /cvsroot/jboss/JBossCache/docs/JBossCache-UserGuide/en/modules/replication.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- replication.xml 24 Jan 2007 00:18:39 -0000 1.4
+++ replication.xml 24 Jan 2007 18:05:25 -0000 1.5
@@ -93,7 +93,7 @@
</para>
</section>
</section>
- <section>
+ <section id="br">
<title>Buddy Replication</title>
<para>
Buddy Replication allows you to suppress replicating your data to all instances in a cluster. Instead,
1.4 +154 -30 JBossCache/docs/JBossCache-UserGuide/en/modules/configuration_reference.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: configuration_reference.xml
===================================================================
RCS file: /cvsroot/jboss/JBossCache/docs/JBossCache-UserGuide/en/modules/configuration_reference.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- configuration_reference.xml 24 Jan 2007 01:53:00 -0000 1.3
+++ configuration_reference.xml 24 Jan 2007 18:05:25 -0000 1.4
@@ -7,6 +7,148 @@
configurations
shipped with the JBoss Cache distribution and tweak according to your needs rather than write one from scratch.
</para>
+ <programlisting>
+<![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- ===================================================================== -->
+<!-- -->
+<!-- Sample JBoss Cache Service Configuration -->
+<!-- -->
+<!-- ===================================================================== -->
+
+<server>
+ <classpath codebase="./lib" archives="jboss-cache.jar, jgroups.jar"/>
+
+ <!-- ==================================================================== -->
+ <!-- Defines JBoss Cache configuration -->
+ <!-- ==================================================================== -->
+
+ <mbean code="org.jboss.cache.CacheImpl" name="jboss.cache:service=Cache">
+ <depends>jboss:service=Naming</depends>
+ <depends>jboss:service=TransactionManager</depends>
+
+ <!-- Configure the TransactionManager -->
+ <attribute name="TransactionManagerLookupClass">org.jboss.cache.JBossTransactionManagerLookup</attribute>
+
+ <!--
+ Node locking level : SERIALIZABLE
+ REPEATABLE_READ (default)
+ READ_COMMITTED
+ READ_UNCOMMITTED
+ NONE
+ -->
+ <attribute name="IsolationLevel">REPEATABLE_READ</attribute>
+
+ <!--
+ Valid modes are LOCAL
+ REPL_ASYNC
+ REPL_SYNC
+ INVALIDATION_ASYNC
+ INVALIDATION_SYNC
+ -->
+ <attribute name="CacheMode">LOCAL</attribute>
+
+ <!-- Name of cluster. Needs to be the same for all TreeCache nodes in a
+ cluster in order to find each other. -->
+ <attribute name="ClusterName">JBossCache-Cluster</attribute>
+
+ <!--Uncomment next three statements to enable JGroups multiplexer.
+ This configuration is dependent on the JGroups multiplexer being
+ registered in an MBean server such as JBossAS. -->
+ <!--
+ <depends>jgroups.mux:name=Multiplexer</depends>
+ <attribute name="MultiplexerService">jgroups.mux:name=Multiplexer</attribute>
+ <attribute name="MultiplexerStack">fc-fast-minimalthreads</attribute>
+ -->
+
+ <!-- JGroups protocol stack properties.
+ ClusterConfig isn't used if the multiplexer is enabled and successfully initialized.
+ -->
+ <attribute name="ClusterConfig">
+ <config>
+ <!-- UDP: if you have a multihomed machine,
+ set the bind_addr attribute to the appropriate NIC IP address -->
+ <!-- UDP: On Windows machines, because of the media sense feature
+ being broken with multicast (even after disabling media sense)
+ set the loopback attribute to true -->
+ <UDP mcast_addr="228.1.2.3" mcast_port="48866"
+ ip_ttl="64" ip_mcast="true"
+ mcast_send_buf_size="150000" mcast_recv_buf_size="80000"
+ ucast_send_buf_size="150000" ucast_recv_buf_size="80000"
+ loopback="false"/>
+ <PING timeout="2000" num_initial_members="3"
+ up_thread="false" down_thread="false"/>
+ <MERGE2 min_interval="10000" max_interval="20000"/>
+ <FD shun="true" up_thread="true" down_thread="true"/>
+ <VERIFY_SUSPECT timeout="1500"
+ up_thread="false" down_thread="false"/>
+ <pbcast.NAKACK gc_lag="50" retransmit_timeout="600,1200,2400,4800"
+ max_xmit_size="8192" up_thread="false" down_thread="false"/>
+ <UNICAST timeout="600,1200,2400" down_thread="false"/>
+ <pbcast.STABLE desired_avg_gossip="20000"
+ up_thread="false" down_thread="false"/>
+ <FRAG frag_size="8192"
+ down_thread="false" up_thread="false"/>
+ <pbcast.GMS join_timeout="5000" join_retry_timeout="2000"
+ shun="true" print_local_addr="true"/>
+ <pbcast.STATE_TRANSFER up_thread="false" down_thread="false"/>
+ </config>
+ </attribute>
+
+
+ <!--
+ The max amount of time (in milliseconds) we wait until the
+ initial state (ie. the contents of the cache) are retrieved from
+ existing members in a clustered environment
+ -->
+ <attribute name="InitialStateRetrievalTimeout">20000</attribute>
+
+ <!--
+ Number of milliseconds to wait until all responses for a
+ synchronous call have been received.
+ -->
+ <attribute name="SyncReplTimeout">20000</attribute>
+
+ <!-- Max number of milliseconds to wait for a lock acquisition -->
+ <attribute name="LockAcquisitionTimeout">15000</attribute>
+
+ <!-- Specific eviction policy configurations. This is LRU -->
+ <attribute name="EvictionPolicyConfig">
+ <config>
+ <attribute name="wakeUpIntervalSeconds">5</attribute>
+ <!-- This defaults to 200000 if not specified -->
+ <attribute name="eventQueueSize">200000</attribute>
+ <attribute name="policyClass">org.jboss.cache.eviction.LRUPolicy</attribute>
+
+ <!-- Cache wide default -->
+ <region name="/_default_">
+ <attribute name="maxNodes">5000</attribute>
+ <attribute name="timeToLiveSeconds">1000</attribute>
+ </region>
+ <region name="/org/jboss/data">
+ <attribute name="maxNodes">5000</attribute>
+ <attribute name="timeToLiveSeconds">1000</attribute>
+ </region>
+ <region name="/org/jboss/test/data">
+ <attribute name="maxNodes">5</attribute>
+ <attribute name="timeToLiveSeconds">4</attribute>
+ </region>
+ <region name="/test">
+ <attribute name="maxNodes">10000</attribute>
+ <attribute name="timeToLiveSeconds">4</attribute>
+ </region>
+ <region name="/maxAgeTest">
+ <attribute name="maxNodes">10000</attribute>
+ <attribute name="timeToLiveSeconds">8</attribute>
+ <attribute name="maxAgeSeconds">10</attribute>
+ </region>
+ </config>
+ </attribute>
+ </mbean>
+</server>
+]]>
+ </programlisting>
</section>
@@ -34,8 +176,8 @@
</entry>
<entry>
- <para>An instance of org.jboss.cache.marshall.Marshaller used to serialize data to byte streams.
- Defaults to o.j.c.m.VersionAwareMarshaller if not specified.
+ <para>An instance of <literal>org.jboss.cache.marshall.Marshaller</literal> used to serialize data to byte streams.
+ Defaults to <literal>org.jboss.cache.marshall.VersionAwareMarshaller</literal> if not specified.
</para>
</entry>
</row>
@@ -46,7 +188,7 @@
<entry>
<para>An XML element that contains detailed buddy replication
- configuration. See section above on Buddy Replication.
+ configuration. See <link linkend="br">section on Buddy Replication</link> for details.
</para>
</entry>
</row>
@@ -58,7 +200,7 @@
<entry>
<para>An XML element that contains detailed cache loader
- configuration. See section above on Cache Loaders.
+ configuration. See <link linkend="cache_loaders">chapter on Cache Loaders</link> for details.
</para>
</entry>
</row>
@@ -70,7 +212,7 @@
<entry>
<para>LOCAL, REPL_SYNC, REPL_ASYNC, INVALIDATION_SYNC or
- INVALIDATION_ASYNC
+ INVALIDATION_ASYNC. Defaults to LOCAL.
</para>
</entry>
</row>
@@ -110,22 +252,6 @@
</para>
</entry>
</row>
-
- <row>
- <entry>
- <para>EvictionPolicyClass</para>
- </entry>
-
- <entry>
- <para>The name of a class implementing EvictionPolicy. Deprecated;
- it is preferable to configure the eviction policy class as
- part of the
- <literal>EvictionPolicyConfig</literal>
- .
- </para>
- </entry>
- </row>
-
<row>
<entry>
<para>EvictionPolicyConfig</para>
@@ -133,15 +259,14 @@
<entry>
<para>Configuration parameter for the specified eviction policy.
- Note that the content is provider specific.
+ See <link linkend="eviction_policies">chapter on eviction policies</link> for details.
</para>
</entry>
</row>
<row>
<entry>
- <para>FetchInMemoryState (renamed from
- FetchStateOnStartup)
+ <para>FetchInMemoryState
</para>
</entry>
@@ -226,7 +351,7 @@
<entry>
<para>The JMX object name of the service that defines the JGroups multiplexer.
- In JBoss AS 5 this service is normally defined in the jgroups-multiplexer.sar.
+ In JBoss AS 5.0 this service is normally defined in the jgroups-multiplexer.sar.
If this attribute is defined, the cache will look up the multiplexer service
in JMX and will use it to obtain a multiplexed JGroups channel. The configuration
of the channel will be that associated with
@@ -265,8 +390,7 @@
</entry>
<entry>
- <para>May be PESSIMISTIC (default) or OPTIMISTIC. See documentation on Transactions and Concurrency
- for more details.
+ <para>May be PESSIMISTIC (default) or OPTIMISTIC.
</para>
</entry>
</row>
@@ -282,8 +406,8 @@
wire formats; setting this attribute tells a cache from a later
release to serialize data using the format from an earlier
release. This allows caches from different releases to
- interoperate. For example, a 1.2.4.SP2 cache could have this
- value set to "1.2.3", allowing it to interoperate with a 1.2.3
+ interoperate. For example, a 2.1.0 cache could have this
+ value set to "2.0.0", allowing it to interoperate with a 2.0.0
cache. Valid values are a dot-separated release number, with
any SP qualifer also separated by a dot, e.g. "1.2.3" or "1.2.4.SP2".
</para>
@@ -412,7 +536,7 @@
<entry>
<para>For asynchronous replication: whether or not to use a
- replication queue (true/false).
+ replication queue. Defaults to <literal>false</literal>.
</para>
</entry>
</row>
More information about the jboss-cvs-commits
mailing list