mod_buffer: Optional support for buffering of the input and output

filter stacks. Can collapse many small buckets into fewer larger
buckets, and prevents excessively small chunks being sent over
the wire.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@717867 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 83 insertions, 0 deletions

diff --git a/docs/manual/mod/mod_buffer.xml b/docs/manual/mod/mod_buffer.xml
new file mode 100644
index 0000000000..4c85668950
--- /dev/null
+++ b/docs/manual/mod/mod_buffer.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 658931 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_buffer.xml.meta">
+
+<name>mod_buffer</name>
+<description>Support for request buffering</description>
+<status>Extension</status>
+<sourcefile>mod_buffer.c</sourcefile>
+<identifier>buffer_module</identifier>
+<compatibility>Available in Apache 2.3 and later</compatibility>
+
+<summary>
+    <p>This module provides the ability to buffer the input and output
+    filter stacks.</p>
+
+    <p>Under certain circumstances, content generators might create
+    content in small chunks. In order to promote memory reuse, in
+    memory chunks are always 8k in size, regardless of the size of the
+    chunk itself. When many small chunks are generated by a request,
+    this can create a large memory footprint while the request is
+    being processed, and an unnecessarily large amount of data on the
+    wire. The addition of a buffer collapses the response into the
+    fewest chunks possible.</p>
+
+    <p>When httpd is used in front of an expensive content generator,
+    buffering the response may allow the backend to complete
+    processing and release resources sooner, depending on how the
+    backend is designed.</p>
+
+    <p>The buffer filter may be added to either the input or the
+    output filter stacks, as appropriate, using the
+    <directive module="core">SetInputFilter</directive>,
+    <directive module="core">SetOutputFilter</directive>,
+    <directive module="mod_mime">AddOutputFilter</directive> or
+    <directive module="core">AddOutputFilterByType</directive> directives.</p>
+
+      <example><title>Using buffer with mod_include</title>
+        AddOutputFilterByType INCLUDES;BUFFER text/html<br />
+      </example>
+
+</summary>
+<seealso><a href="../filter.html">Filters</a></seealso>
+
+<directivesynopsis>
+<name>BufferSize</name>
+<description>Maximum size in bytes to buffer by the buffer filter</description>
+<syntax>BufferSize integer</syntax>
+<default>BufferSize 131072</default>
+<contextlist><context>server config</context>
+<context>virtual host</context>
+<context>directory</context>
+<context>.htaccess</context>
+</contextlist>
+
+<usage>
+    <p>The <directive module="mod_buffer">BufferSize</directive>
+    directive specifies the amount of data in bytes that will be
+    buffered before being read from or written to each request.
+    The default is 128 kilobytes.</p>
+</usage>
+</directivesynopsis>
+
+</modulesynopsis>