[jbosscache-commits] JBoss Cache SVN: r4621 - core/trunk/src/main/docbook/userguide/en/modules.

[jbosscache-commits at lists.jboss.org]

Author: mircea.markus
Date: 2007-10-16 08:50:52 -0400 (Tue, 16 Oct 2007)
New Revision: 4621

Modified:
   core/trunk/src/main/docbook/userguide/en/modules/eviction_policies.xml
Log:
updated docs for JBCACHE-1154

Modified: core/trunk/src/main/docbook/userguide/en/modules/eviction_policies.xml
===================================================================
--- core/trunk/src/main/docbook/userguide/en/modules/eviction_policies.xml	2007-10-15 14:00:00 UTC (rev 4620)
+++ core/trunk/src/main/docbook/userguide/en/modules/eviction_policies.xml	2007-10-16 12:50:52 UTC (rev 4621)
@@ -6,6 +6,7 @@
       memory and their life spans. Memory constraints on servers mean cache cannot grow indefinitely, so policies
       need to be in place to restrict the size of the cache. Eviction policies are most often used alongside
       <link linkend="cache_loaders">cache loaders</link>
+      <link linkend="cache_loaders">cache loaders</link>
       .
    </para>
 
@@ -136,6 +137,19 @@
 
       </section>
       <section>
+         <title>Resident Nodes</title>
+         <para>
+             Nodes marked resident will be ignored by the eviction policies both when checking whether to trigger
+             the eviction and when proceeding with the actual eviction of nodes. E.g. if the eviction policy for a
+             region is "keep LRU 10 nodes" - the resident nodes won't be counted within those 10 nodes,
+             and also won't be evicted when the threshold is reached. In order to mark a node as resident the
+             <literal>Node.setResident</literal> should be used. By default, the newly added nodes are not resident.
+             The <literal>resident</literal> attribute of a node is neither replicated nor transactionable.
+         </para>
+
+      </section>
+
+      <section>
          <title>Programmatic Configuration</title>
          <para>
             Configuring eviction using the