hchar 2005/02/03 04:43:04
Modified: sandbox/yajcache README.txt
Log:
add supports of soft reference memory-file cache
Revision Changes Path
1.2 +25 -7 jakarta-turbine-jcs/sandbox/yajcache/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-turbine-jcs/sandbox/yajcache/README.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README.txt 22 Jan 2005 21:33:00 -0000 1.1
+++ README.txt 3 Feb 2005 12:43:04 -0000 1.2
@@ -3,29 +3,47 @@
----------------------
http://yajcache.sourceforge.net
-Currently a jdk1.5 soft reference memory-only cache with:
+Currently supports both in jdk1.5
-* zero configuration
+a) soft reference memory-only cache; and
+b) soft reference memory-file cache with unlimited overflow.
+
+Features
+--------
+* zero configuration
* zero thread instantiation
* minimal memory impact (controlled by GC via SoftReference)
* no synchronized block
* no synchronized method
-* the cache instance itself (ICache) can be used anywhere a map
-instance can be used
-* optional ICacheSafe to provide thread-safe cache get/put via either
-Serializable or Java Bean patterns
+* minimal synchronization done via distributed (ie keyed) ReadWrite locks
+with zero synchronization
+* the cache instance itself (ICache or ICacheSafe) can be used
+anywhere a map instance can be used
+* optional ICacheSafe to provide thread-safe objects
+for cache get/put via either Serializable or Java Bean patterns
* Intelligent guess to avoid deep clone whenever possible when
ICacheSafe is used
* String-only key constraint to avoid mutability issues
* Fully parameterized cache value type
-* Full set of junit test cases, including emulation of hard-to-test
+* junit test cases, including emulation of hard-to-test
data race conditions
+Usage
+-----
+All caches should be retrieved or removed via
+
+ org.apache.jcs.yajcache.core.CacheManager
+
Pre-requisite
-------------
1) jdk 1.5.0_01+ installed
1) Ant 1.6.2+ installed
2) copy lib/junit-3.8.1.jar to your <ANT_HOME>/lib/
+3) For memory-file cache, the library needs to create a root directory
+
+ /tmp/yajcache/
+
+and have complete access privilege of everything under it.
Build
-----
|
