diff options
| -rw-r--r-- | docs/manual/mod/mod_cache.xml | 43 | ||||
| -rw-r--r-- | docs/manual/mod/mod_mem_cache.xml | 42 |
2 files changed, 43 insertions, 42 deletions
diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml index 9ba8a4ee4e..00bdfd6e08 100644 --- a/docs/manual/mod/mod_cache.xml +++ b/docs/manual/mod/mod_cache.xml @@ -63,6 +63,7 @@ <directive module="mod_mem_cache">MCacheMinObjectSize</directive> <directive module="mod_mem_cache">MCacheMaxObjectSize</directive> <directive module="mod_mem_cache">MCacheRemovalAlgorithm</directive> + <directive module="mod_mem_cache">MCacheMaxStreamingBuffer</directive> </directivelist> </related> </section> @@ -313,46 +314,4 @@ will complete caching the file even if the request is cancelled.</description> </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 <var>size_in_bytes</var></syntax> -<default>CacheMaxStreamingBuffer 0</default> -<contextlist><context>server config</context><context>virtual host</context> -</contextlist> - -<usage> - <p>The <directive>CacheMaxStreamingBuffer</directive> directive - specifies the maximum number of bytes of a streamed response to - buffer before deciding that the response is too big to cache. - A streamed response is one in which the entire content is not - immediately available and in which the <code>Content-Length</code> - may not be known. Sources of streaming responses include proxied - responses and the output of CGI scripts. By default, a streamed - response will <em>not</em> be cached unless it has a - <code>Content-Length</code> 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. - The <directive>CacheMaxStreamingBuffer</directive> directive allows - buffering of streamed responses that don't contain a - <code>Content-Length</code> up to the specified maximum amount of - space. If the maximum buffer space is reached, the buffered - content is discarded and the attempt to cache is abandoned.</p> - - <note><title>Note:</title> - <p>Using a nonzero value for <directive - >CacheMaxStreamingBuffer</directive> will not delay the transmission - of the response to the client. As soon as <module>mod_cache</module> - 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> - </note> - - <example> - # Enable caching of streamed responses up to 64KB:<br /> - CacheMaxStreamingBuffer 65536 - </example> -</usage> -</directivesynopsis> - </modulesynopsis> diff --git a/docs/manual/mod/mod_mem_cache.xml b/docs/manual/mod/mod_mem_cache.xml index 03ddf71f2f..0405274289 100644 --- a/docs/manual/mod/mod_mem_cache.xml +++ b/docs/manual/mod/mod_mem_cache.xml @@ -158,4 +158,46 @@ cache</description> </usage> </directivesynopsis> +<directivesynopsis> +<name>MCacheMaxStreamingBuffer</name> +<description>Maximum amount of a streamed response to buffer in memory +before declaring the response uncacheable</description> +<syntax>MCacheMaxStreamingBuffer <var>size_in_bytes</var></syntax> +<default>MCacheMaxStreamingBuffer the smaller of 100000 or MCacheMaxObjectSize</default> +<contextlist><context>server config</context> +</contextlist> + +<usage> + <p>The <directive>MCacheMaxStreamingBuffer</directive> directive + specifies the maximum number of bytes of a streamed response to + buffer before deciding that the response is too big to cache. + A streamed response is one in which the entire content is not + immediately available and in which the <code>Content-Length</code> + may not be known. Sources of streaming responses include proxied + responses and the output of CGI scripts. By default, a streamed + response will <em>not</em> be cached unless it has a + <code>Content-Length</code> 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. + The <directive>MCacheMaxStreamingBuffer</directive> directive allows + buffering of streamed responses that don't contain a + <code>Content-Length</code> up to the specified maximum amount of + space. If the maximum buffer space is reached, the buffered + content is discarded and the attempt to cache is abandoned.</p> + + <note><title>Note:</title> + <p>Using a nonzero value for <directive>MCacheMaxStreamingBuffer</directive> + will not delay the transmission of the response to the client. + As soon as <module>mod_mem_cache</module> 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> + </note> + + <example> + # Enable caching of streamed responses up to 64KB:<br /> + MCacheMaxStreamingBuffer 65536 + </example> +</usage> +</directivesynopsis> + </modulesynopsis> |