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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_buffer - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_buffer</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_buffer.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_buffer.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Support for request buffering</td></tr>
  33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>buffer_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_buffer.c</td></tr>
  36 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>This module provides the ability to buffer the input and output
  40     filter stacks.</p>
  41
  42     <p>Under certain circumstances, content generators might create
  43     content in small chunks. In order to promote memory reuse, in
  44     memory chunks are always 8k in size, regardless of the size of the
  45     chunk itself. When many small chunks are generated by a request,
  46     this can create a large memory footprint while the request is
  47     being processed, and an unnecessarily large amount of data on the
  48     wire. The addition of a buffer collapses the response into the
  49     fewest chunks possible.</p>
  50
  51     <p>When httpd is used in front of an expensive content generator,
  52     buffering the response may allow the backend to complete
  53     processing and release resources sooner, depending on how the
  54     backend is designed.</p>
  55
  56     <p>The buffer filter may be added to either the input or the
  57     output filter stacks, as appropriate, using the
  58     <code class="directive"><a href="../mod/core.html#setinputfilter">SetInputFilter</a></code>,
  59     <code class="directive"><a href="../mod/core.html#setoutputfilter">SetOutputFilter</a></code>,
  60     <code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code> or
  61     <code class="directive"><a href="../mod/mod_filter.html#addoutputfilterbytype">AddOutputFilterByType</a></code> directives.</p>
  62
  63       <div class="example"><h3>Using buffer with mod_include</h3><pre class="prettyprint lang-config">AddOutputFilterByType INCLUDES;BUFFER text/html</pre>
  64 </div>
  65
  66     <div class="warning">The buffer filters read the request/response into
  67         RAM and then repack the request/response into the fewest memory
  68         buckets possible, at the cost of CPU time. When the request/response
  69         is already efficiently packed, buffering the request/response could
  70         cause the request/response to be slower than not using a buffer at
  71         all. These filters should be used with care, and only where
  72         necessary.</div>
  73
  74 </div>
  75 <div id="quickview"><h3 class="directives">Directives</h3>
  76 <ul id="toc">
  77 <li><img alt="" src="../images/down.gif" /> <a href="#buffersize">BufferSize</a></li>
  78 </ul>
  79 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_buffer">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_buffer">Report a bug</a></li></ul><h3>See also</h3>
  80 <ul class="seealso">
  81 <li><a href="../filter.html">Filters</a></li>
  82 <li><a href="#comments_section">Comments</a></li></ul></div>
  83
  84 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  85 <div class="directive-section"><h2><a name="BufferSize" id="BufferSize">BufferSize</a> <a name="buffersize" id="buffersize">Directive</a></h2>
  86 <table class="directive">
  87 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum size in bytes to buffer by the buffer filter</td></tr>
  88 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BufferSize integer</code></td></tr>
  89 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>BufferSize 131072</code></td></tr>
  90 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  91 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  92 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_buffer</td></tr>
  93 </table>
  94     <p>The <code class="directive"><a href="#buffersize">BufferSize</a></code>
  95     directive specifies the amount of data in bytes that will be
  96     buffered before being read from or written to each request.
  97     The default is 128 kilobytes.</p>
  98
  99 </div>
 100 </div>
 101 <div class="bottomlang">
 102 <p><span>Available Languages: </span><a href="../en/mod/mod_buffer.html" title="English">&nbsp;en&nbsp;</a> |
 103 <a href="../fr/mod/mod_buffer.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 104 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 105 <script type="text/javascript"><!--//--><![CDATA[//><!--
 106 var comments_shortname = 'httpd';
 107 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_buffer.html';
 108 (function(w, d) {
 109     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 110         d.write('<div id="comments_thread"><\/div>');
 111         var s = d.createElement('script');
 112         s.type = 'text/javascript';
 113         s.async = true;
 114         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 115         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 116     }
 117     else {
 118         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 119     }
 120 })(window, document);
 121 //--><!]]></script></div><div id="footer">
 122 <p class="apache">Copyright 2016 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>
 123 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 124 if (typeof(prettyPrint) !== 'undefined') {
 125     prettyPrint();
 126 }
 127 //--><!]]></script>
 128 </body></html>