You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by br...@apache.org on 2002/09/05 09:22:24 UTC
cvs commit: httpd-2.0/docs/manual/mod mod_cache.xml
brianp 2002/09/05 00:22:23
Modified: docs/manual/mod mod_cache.xml
Log:
Added an entry for mod_cache's new CacheMaxStreamingBuffer directive
Revision Changes Path
1.8 +22 -2 httpd-2.0/docs/manual/mod/mod_cache.xml
Index: mod_cache.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_cache.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- mod_cache.xml 27 Aug 2002 21:45:08 -0000 1.7
+++ mod_cache.xml 5 Sep 2002 07:22:23 -0000 1.8
@@ -228,13 +228,13 @@
<directivesynopsis>
<name>CacheForceCompletion</name>
-<description>Percentage of download to arrive for the cache to force complete transfert</description>
+<description>Percentage of download to arrive for the cache to force complete transfer</description>
<syntax>CacheLastModifiedFactor <em>Percentage</em></syntax>
<default>CacheLastModifiedFactor 60</default>
<contextlist><context>server config</context></contextlist>
<usage>
- <p>Percentage of download to arrive for the cache to force complete transfert.</p>
+ <p>Percentage of download to arrive for the cache to force complete transfer.</p>
<example>
CacheForceCompletion
@@ -242,6 +242,26 @@
<note type="warning">
This feature is currently <em>not</em> implemented.
</note>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>CacheMaxStreamingBuffer</name>
+<description>Maximum amount of a streamed response to buffer in memory before declaring the response uncacheable</description>
+<syntax>CacheMaxStreamingBuffer <em>size_in_bytes</em></syntax>
+<default>CacheMaxStreamingBuffer 0</default>
+<contextlist><context>server config</context></contextlist>
+
+<usage>
+ <p>Maximum number of bytes of a streamed response (i.e., a response where the entire content is not available all at once, such as a proxy or CGI response) to buffer before deciding if the response is cacheable. By default, a streamed response will <em>not</em> be cached unless it has a Content-Length header. The reason for this is to avoid using a large amount of memory to buffer a partial response that might end up being too large to fit in the cache anyway. To enable caching of streamed responses, use CacheMaxStreamingBuffer to specify the maximum amount of buffer space to use per request.</p>
+<p>Note: Using a nonzero value for CacheMaxStreamingBuffer will not delay the transmission of the response to the client. As soon as mod_cache copies a
+block of streamed content into a buffer, it sends the block on to the next
+output filter for delivery to the client.</p>
+
+ <example>
+ # Enable caching of streamed responses up to 64KB:
+ CacheMaxStreamingBuffer 65536
+ </example>
</usage>
</directivesynopsis>