--- /dev/null
+<HTML>\r
+<HEAD>\r
+ <!-- Created by GNNpress/1.2 -->\r
+ <!-- Changed by: Anselm Baird-Smith, 4-Feb-1997 -->\r
+ <TITLE>CacheFilter Reference Manual</TITLE>\r
+</HEAD>\r
+<BODY BGCOLOR="white">\r
+<P>\r
+<A HREF="http://www.w3.org/pub/WWW/" TARGET="_top_"><IMG SRC="/icons/WWW/w3c_home.gif"\r
+ ALT="W3C" BORDER="0" WIDTH="72" HEIGHT="48"></A>\r
+<A HREF="http://www.w3.org/pub/WWW/Jigsaw/" TARGET="_top_">\r
+<IMG SRC="/icons/jigsaw" ALT="Jigsaw" BORDER="0"> </A> \r
+ <HR>\r
+<H1>\r
+ Cache Filter\r
+</H1>\r
+<P>\r
+The Cache Filter provides client side caching support for the HTTP protocol.\r
+The cache is as much as possible HTTP/1.1 compliant and can be used either\r
+by standalone browsers,or by a proxy (the typical case when you use\r
+<B>Jigsaw</B>).\r
+<P>\r
+When this filter is used throughout <B>Jigsaw</B> proxy, it is best (ie read\r
+<I>recommended</I>) to use the appropriate resources to configure it (instead\r
+of setting manually the properties). In that case, the\r
+<A HREF="w3c.jigsaw.proxy.CacheProp.html">CacheProp</A> resource.\r
+<P>\r
+ <HR>\r
+<H2>\r
+ Properties\r
+</H2>\r
+<P>\r
+The\r
+<A HREF="../api/w3c.www.protocol.http.cache.CacheFilter.html">CacheFilter</A>\r
+defines the following properties:\r
+<UL>\r
+ <LI>\r
+ <A HREF="#w3c.www.protocol.http.cache.size">w3c.www.protocol.http.cache.size</A>\r
+ <LI>\r
+ <A HREF="#w3c.www.protocol.http.cache.debug">w3c.www.protocol.http.cache.debug</A>\r
+ <LI>\r
+ <A HREF="#w3c.www.protocol.http.cache.shared">w3c.www.protocol.http.cache.shared</A>\r
+ <LI>\r
+ <A HREF="#w3c.www.protocol.http.cache.directory">w3c.www.protocol.http.cache.directory</A>\r
+ <LI>\r
+ <A HREF="#w3c.www.protocol.http.cache.connected">w3c.www.protocol.http.cache.connected</A>\r
+ <LI>\r
+ <A HREF="#w3c.www.protocol.http.cache.garbageCollectionEnabled">w3c.www.protocol.http.cache.garbageCollectionEnabled</A>\r
+ <LI>\r
+ <A HREF="#w3c.www.protocol.http.cache.fileSizeRatio">w3c.www.protocol.http.cache.fileSizeRatio</A>\r
+</UL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<CODE><A NAME="w3c.www.protocol.http.cache.size">w3c.www.protocol.http.cache.size</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ The size of the cache, expressed in bytes.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ An integer property\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This property defaults to <B>5000000</B> bytes, ie 5Mb\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<CODE><A NAME="w3c.www.protocol.http.cache.debug">w3c.www.protocol.http.cache.debug</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ Will make the CacheFIlter emit some (hopefully) usefull traces.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ A boolean property\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This property defaults to <B>false</B>.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<CODE><A NAME="w3c.www.protocol.http.cache.shared">w3c.www.protocol.http.cache.shared</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ Is this cached shared among several users ? Some of HTTP/1.1 caching semantics\r
+ depends on wether the cache is shared or not, this flag will change the caching\r
+ policy accordingly.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ A boolean property.\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This property defaults to <B>false</B>.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<CODE><A NAME="w3c.www.protocol.http.cache.directory">w3c.www.protocol.http.cache.directory</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ The directory that the cache should use to store cached content. If not provided\r
+ the directory defaults to the <CODE>.web_cache</CODE> under the current user's\r
+ home directory. Note that when used through <B>Jigsaw</B> the cache directory\r
+ will automatically be set to <CODE>config/cache</CODE> where\r
+ <CODE>config</CODE> is the main <B>Jigsaw</B> configuration repository.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ A File property (should provide the path of a directory in the file system)\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ See above.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<CODE><A NAME="w3c.www.protocol.http.cache.connected">w3c.www.protocol.http.cache.connected</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ Should the cache consider itself connected to the Internet ? The cache filter\r
+ can be used in <I>disconnected</I> mode, in which case it will only look\r
+ for document in the cache, and if not found, will emit the appropriate HTTP/1.1\r
+ error reply. <BR>\r
+ You may experience funny results when disconnecting the cache from the Internet,\r
+ most of them are the results of content providers not providing the appropriate\r
+ informations (and some time, even intentionnaly).\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ A boolean property\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This property defaults to <B>true</B>.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<CODE><A NAME="w3c.www.protocol.http.cache.garbageCollectionEnabled">w3c.www.protocol.http.cache.garbageCollectionEnabled</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ Should the cache try to run its garbage collector ? This flag is intended\r
+ to be used when the user's is planning to disconnect the cache. By setting\r
+ the flag to <B>false</B>, he/she can safely browse the web and everything\r
+ he/she visits will enter the cache (for latter consumption) and stay\r
+ there.<BR>\r
+ An interesting project, of course, would be to write a robot to fill the\r
+ cache automatically (stay tuned, or write it !)\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ A boolean property\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This property defaults to <B>true</B>.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<CODE><A NAME="w3c.www.protocol.http.cache.fileSizeRatio">w3c.www.protocol.http.cache.fileSizeRatio</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ The ratio to the total cache size that a single entry in the cache is allowed\r
+ to occupy.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ A double property (a ratio between <B>0</B> and <B>1</B> indicating how much\r
+ of the total cache space a single cached entry is able to occupy).\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This property defaults to <B>0.1</B> (which means that if you are using the\r
+ default <A HREF="#w3c.www.protocol.http.cache.size">cache size</A> of 5Mb,\r
+ only file smaller than 500Kb are candidate to enter the cache)\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<I><A HREF="mailto:jigsaw@w3.org">Jigsaw Team</A><BR>\r
+</I>$Id: w3c.www.protocol.http.cache.CacheFilter.html,v 1.1 2010/06/15 12:22:31 smhuang Exp $\r
+<P>\r
+<P>\r
+<P>\r
+</BODY></HTML>\r
projects / Benchmarks_CSolver.git / blobdiff