granicus.if.org Git - apache/blob - docs/manual/mod/event.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>event - 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.gif" /></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 MPM event</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/event.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/event.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>A variant of the <code class="module"><a href="../mod/worker.html">worker</a></code> MPM with the goal
  33 of consuming threads only for connections with active processing</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>mpm_event_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>event.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>The <code class="module"><a href="../mod/event.html">event</a></code> Multi-Processing Module (MPM) is
  40     designed to allow more requests to be served simultaneously by
  41     passing off some processing work to supporting threads, freeing up
  42     the main threads to work on new requests.  It is based on the
  43     <code class="module"><a href="../mod/worker.html">worker</a></code> MPM, which implements a hybrid
  44     multi-process multi-threaded server.  Run-time configuration
  45     directives are identical to those provided by
  46     <code class="module"><a href="../mod/worker.html">worker</a></code>.</p>
  47
  48     <p>To use the <code class="module"><a href="../mod/event.html">event</a></code> MPM, add
  49       <code>--with-mpm=event</code> to the <code class="program"><a href="../programs/configure.html">configure</a></code>
  50       script's arguments when building the <code class="program"><a href="../programs/httpd.html">httpd</a></code>.</p>
  51
  52 </div>
  53 <div id="quickview"><h3>Topics</h3>
  54 <ul id="topics">
  55 <li><img alt="" src="../images/down.gif" /> <a href="#how-it-works">How it Works</a></li>
  56 <li><img alt="" src="../images/down.gif" /> <a href="#requirements">Requirements</a></li>
  57 </ul><h3 class="directives">Directives</h3>
  58 <ul id="toc">
  59 <li><img alt="" src="../images/down.gif" /> <a href="#asyncrequestworkerfactor">AsyncRequestWorkerFactor</a></li>
  60 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#coredumpdirectory">CoreDumpDirectory</a></li>
  61 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#enableexceptionhook">EnableExceptionHook</a></li>
  62 <li><img alt="" src="../images/right.gif" /> <a href="mod_unixd.html#group">Group</a></li>
  63 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#listen">Listen</a></li>
  64 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#listenbacklog">ListenBacklog</a></li>
  65 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#maxconnectionsperchild">MaxConnectionsPerChild</a></li>
  66 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#maxmemfree">MaxMemFree</a></li>
  67 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#maxrequestworkers">MaxRequestWorkers</a></li>
  68 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#maxsparethreads">MaxSpareThreads</a></li>
  69 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#minsparethreads">MinSpareThreads</a></li>
  70 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#pidfile">PidFile</a></li>
  71 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#scoreboardfile">ScoreBoardFile</a></li>
  72 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#sendbuffersize">SendBufferSize</a></li>
  73 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#serverlimit">ServerLimit</a></li>
  74 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#startservers">StartServers</a></li>
  75 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadlimit">ThreadLimit</a></li>
  76 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadsperchild">ThreadsPerChild</a></li>
  77 <li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadstacksize">ThreadStackSize</a></li>
  78 <li><img alt="" src="../images/right.gif" /> <a href="mod_unixd.html#user">User</a></li>
  79 </ul>
  80 <h3>See also</h3>
  81 <ul class="seealso">
  82 <li><a href="worker.html">The worker MPM</a></li>
  83 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  84 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  85 <div class="section">
  86 <h2><a name="how-it-works" id="how-it-works">How it Works</a></h2>
  87     <p>This MPM tries to fix the 'keep alive problem' in HTTP. After a client
  88     completes the first request, the client can keep the connection
  89     open, and send further requests using the same socket. This can
  90     save significant overhead in creating TCP connections. However,
  91     Apache HTTP Server traditionally keeps an entire child process/thread waiting
  92     for data from the client, which brings its own disadvantages. To
  93     solve this problem, this MPM uses a dedicated thread to handle both
  94     the Listening sockets, all sockets that are in a Keep Alive state,
  95     and sockets where the handler and protocol filters have done their work
  96     and the only remaining thing to do is send the data to the client. The
  97     status page of <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> shows how many connections are
  98     in the mentioned states.</p>
  99
 100     <p>The improved connection handling may not work for certain connection
 101     filters that have declared themselves as incompatible with event. In these
 102     cases, this MPM will fall back to the behaviour of the
 103     <code class="module"><a href="../mod/worker.html">worker</a></code> MPM and reserve one worker thread per connection.
 104     All modules shipped with the server are compatible with the event MPM.</p>
 105
 106     <p>A similar restriction is currently present for requests involving an
 107     output filter that needs to read and/or modify the whole response body,
 108     like for example mod_ssl, mod_deflate, or mod_include. If the
 109     connection to the client blocks while the filter is processing the
 110     data, and the amount of data produced by the filter is too big to be
 111     buffered in memory, the thread used for the request is not freed while
 112     httpd waits until the pending data is sent to the client.</p>
 113
 114     <p>The MPM assumes that the underlying <code>apr_pollset</code>
 115     implementation is reasonably threadsafe. This enables the MPM to
 116     avoid excessive high level locking, or having to wake up the listener
 117     thread in order to send it a keep-alive socket. This is currently
 118     only compatible with KQueue and EPoll.</p>
 119
 120 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 121 <div class="section">
 122 <h2><a name="requirements" id="requirements">Requirements</a></h2>
 123     <p>This MPM depends on <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>'s atomic
 124     compare-and-swap operations for thread synchronization. If you are
 125     compiling for an x86 target and you don't need to support 386s, or
 126     you are compiling for a SPARC and you don't need to run on
 127     pre-UltraSPARC chips, add
 128     <code>--enable-nonportable-atomics=yes</code> to the
 129     <code class="program"><a href="../programs/configure.html">configure</a></code> script's arguments. This will cause
 130     APR to implement atomic operations using efficient opcodes not
 131     available in older CPUs.</p>
 132
 133     <p>This MPM does not perform well on older platforms which lack good
 134     threading, but the requirement for EPoll or KQueue makes this
 135     moot.</p>
 136
 137     <ul>
 138
 139       <li>To use this MPM on FreeBSD, FreeBSD 5.3 or higher is recommended.
 140       However, it is possible to run this MPM on FreeBSD 5.2.1, if you
 141       use <code>libkse</code> (see <code>man libmap.conf</code>).</li>
 142
 143       <li>For NetBSD, at least version 2.0 is recommended.</li>
 144
 145       <li>For Linux, a 2.6 kernel is recommended. It is also necessary to
 146       ensure that your version of <code>glibc</code> has been compiled
 147       with support for EPoll.</li>
 148
 149     </ul>
 150 </div>
 151 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 152 <div class="directive-section"><h2><a name="AsyncRequestWorkerFactor" id="AsyncRequestWorkerFactor">AsyncRequestWorkerFactor</a> <a name="asyncrequestworkerfactor" id="asyncrequestworkerfactor">Directive</a></h2>
 153 <table class="directive">
 154 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit concurrent connections per process</td></tr>
 155 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AsyncRequestWorkerFactor <var>factor</var></code></td></tr>
 156 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>2</code></td></tr>
 157 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 158 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
 159 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>event</td></tr>
 160 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3.13 and later</td></tr>
 161 </table>
 162     <p>The event MPM handles some connections in an asynchronous way, where
 163     request worker threads are only allocated for short periods of time as
 164     needed, and other connections with one request worker thread reserved per
 165     connection. This can lead to situations where all workers are tied up and
 166     no worker thread is available to handle new work on established async
 167     connections.</p>
 168
 169     <p>To mitigate this problem, the event MPM does two things: Firstly, it
 170     limits the number of connections accepted per process, depending on the
 171     number of idle request workers. Secondly, if all workers are busy, it will
 172     close connections in keep-alive state even if the keep-alive timeout has
 173     not expired. This allows the respective clients to reconnect to a
 174     different process which may still have worker threads available.</p>
 175
 176     <p>This directive can be used to fine-tune the per-process connection
 177     limit. A process will only accept new connections if the current number of
 178     connections (not counting connections in the "closing" state) is lower
 179     than:</p>
 180
 181     <p class="indent"><strong>
 182         <code class="directive"><a href="../mod/mpm_common.html#threadsperchild">ThreadsPerChild</a></code> +
 183         (<code class="directive">AsyncRequestWorkerFactor</code> *
 184         <var>number of idle workers</var>)
 185     </strong></p>
 186
 187     <p>This means the absolute maximum numbers of concurrent connections is:</p>
 188
 189     <p class="indent"><strong>
 190         (<code class="directive">AsyncRequestWorkerFactor</code> + 1) *
 191         <code class="directive"><a href="../mod/mpm_common.html#maxrequestworkers">MaxRequestWorkers</a></code>
 192     </strong></p>
 193
 194     <p><code class="directive"><a href="../mod/mpm_common.html#maxrequestworkers">MaxRequestWorkers</a></code> was called
 195     <code class="directive">MaxClients</code> prior to version 2.3.13. The above value
 196     shows that the old name did not accurately describe its meaning for the event MPM.</p>
 197
 198     <p><code class="directive">AsyncRequestWorkerFactor</code> can take non-integer
 199     arguments, e.g "1.5".</p>
 200
 201
 202 </div>
 203 </div>
 204 <div class="bottomlang">
 205 <p><span>Available Languages: </span><a href="../en/mod/event.html" title="English">&nbsp;en&nbsp;</a> |
 206 <a href="../fr/mod/event.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 207 </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>
 208 <script type="text/javascript"><!--//--><![CDATA[//><!--
 209 var comments_shortname = 'httpd';
 210 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/event.html';
 211 (function(w, d) {
 212     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 213         d.write('<div id="comments_thread"><\/div>');
 214         var s = d.createElement('script');
 215         s.type = 'text/javascript';
 216         s.async = true;
 217         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 218         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 219     }
 220     else {
 221         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 222     }
 223 })(window, document);
 224 //--><!]]></script></div><div id="footer">
 225 <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>
 226 <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[//><!--
 227 if (typeof(prettyPrint) !== 'undefined') {
 228     prettyPrint();
 229 }
 230 //--><!]]></script>
 231 </body></html>