granicus.if.org Git - apache/blob - docs/manual/mod/mod_buffer.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_buffer - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_buffer</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_buffer.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../fr/mod/mod_buffer.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Support for request buffering</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>buffer_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_buffer.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module provides the ability to buffer the input and output
  35     filter stacks.</p>
  36
  37     <p>Under certain circumstances, content generators might create
  38     content in small chunks. In order to promote memory reuse, in
  39     memory chunks are always 8k in size, regardless of the size of the
  40     chunk itself. When many small chunks are generated by a request,
  41     this can create a large memory footprint while the request is
  42     being processed, and an unnecessarily large amount of data on the
  43     wire. The addition of a buffer collapses the response into the
  44     fewest chunks possible.</p>
  45
  46     <p>When httpd is used in front of an expensive content generator,
  47     buffering the response may allow the backend to complete
  48     processing and release resources sooner, depending on how the
  49     backend is designed.</p>
  50
  51     <p>The buffer filter may be added to either the input or the
  52     output filter stacks, as appropriate, using the
  53     <code class="directive"><a href="../mod/core.html#setinputfilter">SetInputFilter</a></code>,
  54     <code class="directive"><a href="../mod/core.html#setoutputfilter">SetOutputFilter</a></code>,
  55     <code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code> or
  56     <code class="directive"><a href="../mod/mod_filter.html#addoutputfilterbytype">AddOutputFilterByType</a></code> directives.</p>
  57
  58       <div class="example"><h3>Using buffer with mod_include</h3><p><code>
  59         AddOutputFilterByType INCLUDES;BUFFER text/html<br />
  60       </code></p></div>
  61
  62     <div class="warning">The buffer filters read the request/response into
  63         RAM and then repack the request/response into the fewest memory
  64         buckets possible, at the cost of CPU time. When the request/response
  65         is already efficiently packed, buffering the request/response could
  66         cause the request/response to be slower than not using a buffer at
  67         all. These filters should be used with care, and only where
  68         necessary.</div>
  69
  70 </div>
  71 <div id="quickview"><h3 class="directives">Directives</h3>
  72 <ul id="toc">
  73 <li><img alt="" src="../images/down.gif" /> <a href="#buffersize">BufferSize</a></li>
  74 </ul>
  75 <h3>See also</h3>
  76 <ul class="seealso">
  77 <li><a href="../filter.html">Filters</a></li>
  78 </ul></div>
  79
  80 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  81 <div class="directive-section"><h2><a name="BufferSize" id="BufferSize">BufferSize</a> <a name="buffersize" id="buffersize">Directive</a></h2>
  82 <table class="directive">
  83 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum size in bytes to buffer by the buffer filter</td></tr>
  84 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BufferSize integer</code></td></tr>
  85 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>BufferSize 131072</code></td></tr>
  86 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  87 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  88 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_buffer</td></tr>
  89 </table>
  90     <p>The <code class="directive"><a href="#buffersize">BufferSize</a></code>
  91     directive specifies the amount of data in bytes that will be
  92     buffered before being read from or written to each request.
  93     The default is 128 kilobytes.</p>
  94
  95 </div>
  96 </div>
  97 <div class="bottomlang">
  98 <p><span>Available Languages: </span><a href="../en/mod/mod_buffer.html" title="English">&nbsp;en&nbsp;</a> |
  99 <a href="../fr/mod/mod_buffer.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 100 </div><div id="footer">
 101 <p class="apache">Copyright 2010 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 102 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 103 </body></html>