granicus.if.org Git - apache/blob - docs/manual/developer/new_api_2_4.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>API Changes in Apache HTTP Server 2.4 since 2.2 - 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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body id="manual-page"><div id="page-header">
  17 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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>
  18 <p class="apache">Apache HTTP Server Version 2.5</p>
  19 <img alt="" src="../images/feather.gif" /></div>
  20 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  21 <div id="path">
  22 <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></div><div id="page-content"><div id="preamble"><h1>API Changes in Apache HTTP Server 2.4 since 2.2</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/developer/new_api_2_4.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26
  27   <p>This document describes changes to the Apache HTTPD API from
  28      version 2.2 to 2.4, that may be of interest to module/application
  29      developers and core hacks.  As of the first GA release of the
  30      2.4 branch API compatibility is preserved for the life of the
  31      2.4 branch.  (The
  32      <a href="http://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/VERSIONING">VERSIONING</a>
  33      description for the 2.4 release provides more information about API
  34      compatibility.)</p>
  35
  36   <p>API changes fall into two categories: APIs that are altogether new,
  37      and existing APIs that are expanded or changed.  The latter are
  38      further divided into those where all changes are backwards-compatible
  39      (so existing modules can ignore them), and those that might
  40      require attention by maintainers.  As with the transition from
  41      HTTPD 2.0 to 2.2, existing modules and applications will require
  42      recompiling and may call for some attention, but most should not
  43      require any substantial updating (although some may be able to
  44      take advantage of API changes to offer significant improvements).</p>
  45   <p>For the purpose of this document, the API is split according
  46      to the public header files.  These headers are themselves the
  47      reference documentation, and can be used to generate a browsable
  48      HTML reference with <code>make docs</code>.</p>
  49 </div>
  50 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#api_changes">Changed APIs</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#upgrading">Specific information on upgrading modules from 2.2</a></li>
  52 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  53 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  54 <div class="section">
  55 <h2><a name="api_changes" id="api_changes">Changed APIs</a></h2>
  56
  57
  58   <h3><a name="ap_expr" id="ap_expr">ap_expr (NEW!)</a></h3>
  59
  60     <p>Introduces a new API to parse and evaluate boolean and algebraic
  61        expressions, including provision for a standard syntax and
  62        customised variants.</p>
  63
  64
  65   <h3><a name="ap_listen" id="ap_listen">ap_listen (changed; backwards-compatible)</a></h3>
  66
  67     <p>Introduces a new API to enable httpd child processes to serve
  68        different purposes.</p>
  69
  70
  71   <h3><a name="ap_mpm" id="ap_mpm">ap_mpm (changed)</a></h3>
  72
  73   <p><code>ap_mpm_run</code> is replaced by a new <code>mpm</code> hook.
  74   Also <code>ap_graceful_stop_signalled</code> is lost, and
  75   <code>ap_mpm_register_timed_callback</code> is new.</p>
  76
  77
  78   <h3><a name="ap_regex" id="ap_regex">ap_regex (changed)</a></h3>
  79
  80   <p>In addition to the existing regexp wrapper, a new higher-level API
  81   <code>ap_rxplus</code> is now provided.  This provides the capability to
  82   compile Perl-style expressions like <code>s/regexp/replacement/flags</code>
  83   and to execute them against arbitrary strings. Support for regexp
  84   backreferences is also added.</p>
  85
  86
  87   <h3><a name="ap_slotmem" id="ap_slotmem">ap_slotmem (NEW!)</a></h3>
  88
  89     <p>Introduces an API for modules to allocate and manage memory slots,
  90     most commonly for shared memory.</p>
  91
  92
  93   <h3><a name="ap_socache" id="ap_socache">ap_socache (NEW!)</a></h3>
  94
  95     <p>API to manage a shared object cache.</p>
  96
  97
  98   <h3><a name="heartbeat" id="heartbeat">heartbeat (NEW!)</a></h3>
  99
 100     <p>common structures for heartbeat modules</p>
 101
 102
 103   <h3><a name="ap_parse_htaccess" id="ap_parse_htaccess">ap_parse_htaccess (changed)</a></h3>
 104
 105     <p>The function signature for <code>ap_parse_htaccess</code> has been
 106     changed. A <code>apr_table_t</code> of individual directives allowed
 107     for override must now be passed (override remains).</p>
 108
 109
 110   <h3><a name="http_config" id="http_config">http_config (changed)</a></h3>
 111
 112     <ul>
 113       <li>Introduces per-module, per-directory loglevels, including macro wrappers.</li>
 114       <li>New <code>AP_DECLARE_MODULE</code> macro to declare all modules.</li>
 115       <li>New <code>APLOG_USE_MODULE</code> macro necessary for per-module loglevels in
 116           multi-file modules.</li>
 117       <li>New API to retain data across module unload/load</li>
 118       <li>New <code>check_config</code> hook</li>
 119       <li>New <code>ap_process_fnmatch_configs()</code> function to process wildcards</li>
 120       <li>Change <code>ap_configfile_t</code>, <code>ap_cfg_getline()</code>,
 121           <code>ap_cfg_getc()</code> to return error codes, and add
 122           <code>ap_pcfg_strerror()</code> for retrieving an error description.</li>
 123       <li>Any config directive permitted in ACCESS_CONF context must now
 124           correctly handle being called from an .htaccess file via the new
 125           <code class="directive"><a href="../mod/core.html#allowoverridelist">AllowOverrideList</a></code> directive.
 126           ap_check_cmd_context() accepts a new flag NOT_IN_HTACCESS to detect
 127           this case.</li>
 128     </ul>
 129
 130
 131   <h3><a name="http_core" id="http_core">http_core (changed)</a></h3>
 132
 133     <ul>
 134       <li>REMOVED <code>ap_default_type</code>, <code>ap_requires</code>, all
 135           2.2 authnz API</li>
 136       <li>Introduces Optional Functions for logio and authnz</li>
 137       <li>New function <code>ap_get_server_name_for_url</code> to support IPv6
 138           literals.</li>
 139       <li>New function <code>ap_register_errorlog_handler</code> to register error log
 140           format string handlers.</li>
 141       <li>Arguments of <code>error_log</code> hook have changed. Declaration has moved to
 142           <code>http_core.h</code>.</li>
 143       <li>New function <code>ap_state_query</code> to determine if the server is in the
 144           initial configuration preflight phase or not. This is both easier to
 145           use and more correct than the old method of creating a pool userdata
 146           entry in the process pool.</li>
 147       <li>New function <code>ap_get_conn_socket</code> to get the socket descriptor for a
 148           connection. This should be used instead of accessing the core
 149           connection config directly.</li>
 150     </ul>
 151
 152
 153   <h3><a name="httpd" id="httpd">httpd (changed)</a></h3>
 154
 155     <ul>
 156       <li>Introduce per-directory, per-module loglevel</li>
 157       <li>New loglevels <code>APLOG_TRACEn</code></li>
 158       <li>Introduce errorlog ids for requests and connections</li>
 159       <li>Support for mod_request kept_body</li>
 160       <li>Support buffering filter data for async requests</li>
 161       <li>New <code>CONN_STATE</code> values</li>
 162       <li>Function changes: <code>ap_escape_html</code> updated;
 163           <code>ap_unescape_all</code>, <code>ap_escape_path_segment_buffer</code></li>
 164       <li>Modules that load other modules later than the <code>EXEC_ON_READ</code> config
 165           reading stage need to call <code>ap_reserve_module_slots()</code> or
 166           <code>ap_reserve_module_slots_directive()</code> in their
 167           <code>pre_config hook</code>.</li>
 168       <li>The useragent IP address per request can now be tracked
 169           independently of the client IP address of the connection, for
 170           support of deployments with load balancers.</li>
 171     </ul>
 172
 173
 174   <h3><a name="http_log" id="http_log">http_log (changed)</a></h3>
 175
 176     <ul>
 177       <li>Introduce per-directory, per-module loglevel</li>
 178       <li>New loglevels <code>APLOG_TRACEn</code></li>
 179       <li><code>ap_log_*error</code> become macro wrappers (backwards-compatible if
 180           <code>APLOG_MARK</code> macro is used, except that is no longer possible to
 181           use <code>#ifdef</code> inside the argument list)</li>
 182       <li>piped logging revamped</li>
 183       <li><code>module_index</code> added to error_log hook</li>
 184       <li>new function: <code>ap_log_command_line</code></li>
 185     </ul>
 186
 187
 188   <h3><a name="http_request" id="http_request">http_request (changed)</a></h3>
 189
 190     <ul>
 191       <li>New auth_internal API and auth_provider API</li>
 192       <li>New <code>EOR</code> bucket type</li>
 193       <li>New function <code>ap_process_async_request</code></li>
 194       <li>New flags <code>AP_AUTH_INTERNAL_PER_CONF</code> and
 195           <code>AP_AUTH_INTERNAL_PER_URI</code></li>
 196       <li>New <code>access_checker_ex</code> hook to apply additional access control
 197           and/or bypass authentication.</li>
 198       <li>New functions <code>ap_hook_check_access_ex</code>,
 199           <code>ap_hook_check_access</code>, <code>ap_hook_check_authn</code>,
 200           <code>ap_hook_check_authz</code> which accept
 201           <code>AP_AUTH_INTERNAL_PER_*</code> flags</li>
 202       <li>DEPRECATED direct use of <code>ap_hook_access_checker</code>,
 203           <code>access_checker_ex</code>, <code>ap_hook_check_user_id</code>,
 204           <code>ap_hook_auth_checker</code></li>
 205     </ul>
 206     <p>When possible, registering all access control hooks (including
 207        authentication and authorization hooks) using <code>AP_AUTH_INTERNAL_PER_CONF</code>
 208        is recommended.  If all modules' access control hooks are registered
 209        with this flag, then whenever the server handles an internal
 210        sub-request that matches the same set of access control configuration
 211        directives as the initial request (which is the common case), it can
 212        avoid invoking the access control hooks another time.</p>
 213     <p>If your module requires the old behavior and must perform access
 214        control checks on every sub-request with a different URI from the
 215        initial request, even if that URI matches the same set of access
 216        control configuration directives, then use
 217        <code>AP_AUTH_INTERNAL_PER_URI</code>.</p>
 218
 219
 220   <h3><a name="mod_auth" id="mod_auth">mod_auth (NEW!)</a></h3>
 221
 222     <p>Introduces the new provider framework for authn and authz</p>
 223
 224
 225   <h3><a name="mod_cache" id="mod_cache">mod_cache (changed)</a></h3>
 226
 227     <p>Introduces a <code>commit_entity()</code> function to the cache provider
 228     interface, allowing atomic writes to cache. Add a <code>cache_status()</code>
 229     hook to report the cache decision. All private structures and functions were
 230     removed.</p>
 231
 232
 233   <h3><a name="mod_core" id="mod_core">mod_core (NEW!)</a></h3>
 234
 235     <p>This introduces low-level APIs to send arbitrary headers,
 236     and exposes functions to handle HTTP OPTIONS and TRACE.</p>
 237
 238
 239   <h3><a name="mod_cache_disk" id="mod_cache_disk">mod_cache_disk (changed)</a></h3>
 240
 241     <p>Changes the disk format of the disk cache to support atomic cache
 242     updates without locking. The device/inode pair of the body file is
 243     embedded in the header file, allowing confirmation that the header
 244     and body belong to one another.</p>
 245
 246
 247   <h3><a name="mod_disk_cache" id="mod_disk_cache">mod_disk_cache (renamed)</a></h3>
 248
 249     <p>The mod_disk_cache module has been renamed to mod_cache_disk in
 250     order to be consistent with the naming of other modules within the
 251     server.</p>
 252
 253
 254   <h3><a name="mod_request" id="mod_request">mod_request (NEW!)</a></h3>
 255
 256     <p>The API for <code class="module"><a href="../mod/mod_request.html">mod_request</a></code>, to make input data
 257     available to multiple application/handler modules where required,
 258     and to parse HTML form data.</p>
 259
 260
 261   <h3><a name="mpm_common" id="mpm_common">mpm_common (changed)</a></h3>
 262
 263     <ul>
 264       <li>REMOVES: <code>accept</code>, <code>lockfile</code>, <code>lock_mech</code>,
 265           <code>set_scoreboard</code> (locking uses the new ap_mutex API)</li>
 266       <li>NEW API to drop privileges (delegates this platform-dependent
 267           function to modules)</li>
 268       <li>NEW Hooks: <code>mpm_query</code>, <code>timed_callback</code>, and
 269           <code>get_name</code></li>
 270       <li>CHANGED interfaces: <code>monitor</code> hook,
 271           <code>ap_reclaim_child_processes</code>,
 272           <code>ap_relieve_child_processes</code></li>
 273     </ul>
 274
 275
 276   <h3><a name="scoreboard" id="scoreboard">scoreboard (changed)</a></h3>
 277
 278     <p><code>ap_get_scoreboard_worker</code> is made non-backwards-compatible
 279     as an alternative version is introduced.  Additional proxy_balancer
 280     support.  Child status stuff revamped.</p>
 281
 282
 283   <h3><a name="util_cookies" id="util_cookies">util_cookies (NEW!)</a></h3>
 284
 285     <p>Introduces a new API for managing HTTP Cookies.</p>
 286
 287
 288   <h3><a name="util_ldap" id="util_ldap">util_ldap (changed)</a></h3>
 289
 290     <p><em>no description available</em></p>
 291
 292
 293   <h3><a name="util_mutex" id="util_mutex">util_mutex (NEW!)</a></h3>
 294
 295     <p>A wrapper for APR proc and global mutexes in httpd, providing
 296        common configuration for the underlying mechanism and location
 297        of lock files.</p>
 298
 299
 300   <h3><a name="util_script" id="util_script">util_script (changed)</a></h3>
 301
 302     <p>NEW: <code>ap_args_to_table</code></p>
 303
 304
 305   <h3><a name="util_time" id="util_time">util_time (changed)</a></h3>
 306
 307     <p>NEW: <code>ap_recent_ctime_ex</code></p>
 308
 309
 310 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 311 <div class="section">
 312 <h2><a name="upgrading" id="upgrading">Specific information on upgrading modules from 2.2</a></h2>
 313
 314
 315   <h3><a name="upgrading_logging" id="upgrading_logging">Logging</a></h3>
 316
 317     <p>In order to take advantage of per-module loglevel configuration, any
 318        source file that calls the <code>ap_log_*</code> functions should declare
 319        which module it belongs to. If the module's module_struct is called
 320        <code>foo_module</code>, the following code can be used to remain
 321        backward compatible with HTTPD 2.0 and 2.2:</p>
 322     <div class="example"><p><code>
 323         #include &lt;http_log.h&gt;<br />
 324         <br />
 325         #ifdef APLOG_USE_MODULE<br />
 326         APLOG_USE_MODULE(foo);<br />
 327         #endif
 328     </code></p></div>
 329     <p>Note: This is absolutely required for C++-language modules.  It
 330     can be skipped for C-language modules, though that breaks
 331     module-specific log level support for files without it.</p>
 332     <p>The number of parameters of the <code>ap_log_*</code> functions and the
 333        definition of <code>APLOG_MARK</code> has changed. Normally, the change
 334        is completely transparent. However, changes are required if a
 335        module uses <code>APLOG_MARK</code> as a parameter to its own functions
 336        or if a module calls <code>ap_log_*</code> without passing
 337        <code>APLOG_MARK</code>.  A module which uses wrappers
 338        around <code>ap_log_*</code> typically uses both of these constructs.</p>
 339
 340     <p>The easiest way to change code which passes <code>APLOG_MARK</code> to
 341        its own functions is to define and use a different macro that expands to
 342        the parameters required by those functions, as <code>APLOG_MARK</code>
 343        should only be used when calling <code>ap_log_*</code>
 344        directly.  In this way, the code will remain compatible with HTTPD 2.0
 345        and 2.2.</p>
 346
 347     <p>Code which calls <code>ap_log_*</code> without passing
 348        <code>APLOG_MARK</code> will necessarily differ between 2.4 and earlier
 349        releases, as 2.4 requires a new third argument,
 350        <code>APLOG_MODULE_INDEX</code>.</p>
 351
 352     <div class="example"><p><code>
 353        /* code for httpd 2.0/2.2 */<br />
 354        ap_log_perror(file, line, APLOG_ERR, 0, p, "Failed to allocate dynamic lock structure");<br />
 355        <br />
 356        /* code for httpd 2.4 */<br />
 357        ap_log_perror(file, line, APLOG_MODULE_INDEX, APLOG_ERR, 0, p, "Failed to allocate dynamic lock structure");<br />
 358        <br />
 359     </code></p></div>
 360
 361     <p><code>ap_log_*error</code> are now implemented as macros. This means
 362        that it is no longer possible to use <code>#ifdef</code> inside the
 363        argument list of <code>ap_log_*error</code>, as this would cause
 364        undefined behavor according to C99.</p>
 365
 366     <p>A <code>server_rec</code> pointer must be passed to
 367        <code>ap_log_error()</code> when called after startup.  This
 368        was always appropriate, but there are even more limitations with
 369        a <code>NULL</code> <code>server_rec</code> in 2.4 than in
 370        previous releases.  Beginning with 2.3.12, the global variable
 371        <code>ap_server_conf</code> can always be used as
 372        the <code>server_rec</code> parameter, as it will be
 373        <code>NULL</code> only when it is valid to pass <code>NULL</code>
 374        to <code>ap_log_error()</code>.  <code>ap_server_conf</code>
 375        should be used only when a more appropriate <code>server_rec</code>
 376        is not available.</p>
 377
 378     <p>Consider the following changes to take advantage of the new
 379        <code>APLOG_TRACE1..8</code> log levels:</p>
 380        <ul>
 381          <li>Check current use of <code>APLOG_DEBUG</code> and
 382          consider if one of the <code>APLOG_TRACEn</code> levels is
 383          more appropriate.</li>
 384          <li>If your module currently has a mechanism for configuring
 385          the amount of debug logging which is performed, consider
 386          eliminating that mechanism and relying on the use of
 387          different <code>APLOG_TRACEn</code> levels.  If expensive
 388          trace processing needs to be bypassed depending on the
 389          configured log level, use the <code>APLOGtrace<em>n</em></code>
 390          and <code>APLOGrtrace<em>n</em></code> macros to first check
 391          if tracing is enabled.</li>
 392        </ul>
 393
 394     <p>Modules sometimes add process id and/or thread id to their log
 395        messages.  These ids are now logged by default, so it may not
 396        be necessary for the module to log them explicitly.  (Users may
 397        remove them from the error log format, but they can be
 398        instructed to add it back if necessary for problem diagnosis.)</p>
 399
 400
 401   <h3><a name="upgrading_byfunction" id="upgrading_byfunction">If your module uses these existing APIs...</a></h3>
 402
 403
 404     <dl>
 405       <dt><code>ap_default_type()</code></dt>
 406       <dd>This is no longer available; Content-Type must be configured
 407           explicitly or added by the application.</dd>
 408
 409       <dt><code>ap_get_server_name()</code></dt>
 410       <dd>If the returned server name is used in a URL,
 411       use <code>ap_get_server_name_for_url()</code> instead.  This new
 412       function handles the odd case where the server name is an IPv6
 413       literal address.</dd>
 414
 415       <dt><code>ap_get_server_version()</code></dt>
 416       <dd>For logging purposes, where detailed information is
 417           appropriate, use <code>ap_get_server_description()</code>.
 418           When generating output, where the amount of information
 419           should be configurable by ServerTokens, use
 420           <code>ap_get_server_banner()</code>.</dd>
 421
 422       <dt><code>ap_graceful_stop_signalled()</code></dt>
 423       <dd>Replace with a call
 424       to <code>ap_mpm_query(AP_MPMQ_MPM_STATE)</code> and checking for
 425       state <code>AP_MPMQ_STOPPING</code>.</dd>
 426
 427       <dt><code>ap_max_daemons_limit</code>, <code>ap_my_generation</code>,
 428           and <code>ap_threads_per_child</code></dt>
 429       <dd>Use <code>ap_mpm_query()</code> query codes
 430           <code>AP_MPMQ_MAX_DAEMON_USED</code>, <code>AP_MPMQ_GENERATION</code>,
 431           and <code>AP_MPMQ_MAX_THREADS</code>, respectively.</dd>
 432
 433       <dt><code>ap_mpm_query()</code></dt>
 434       <dd>Ensure that it is not used until after the register-hooks
 435           hook has completed.  Otherwise, an MPM built as a DSO
 436           would not have had a chance to enable support for this
 437           function.</dd>
 438
 439       <dt><code>ap_requires()</code></dt>
 440       <dd>The core server now provides better infrastructure for handling
 441           <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> configuration.
 442           Register an auth provider function for each supported entity using
 443           <code>ap_register_auth_provider()</code>.  The function will be
 444           called as necessary during <code class="directive">Require</code>
 445           processing.  (Consult bundled modules for detailed examples.)</dd>
 446
 447       <dt><code>ap_server_conf-&gt;process-&gt;pool</code>
 448       userdata</dt>
 449       <dd>
 450         Optional:
 451         <ul>
 452           <li>If your module uses this to determine which pass of the
 453           startup hooks is being run,
 454           use <code>ap_state_query(AP_SQ_MAIN_STATE)</code>.</li>
 455           <li>If your module uses this to maintain data across the
 456           unloading and reloading of your module, use
 457           <code>ap_retained_data_create()</code> and
 458           <code>ap_retained_data_get()</code>.</li>
 459         </ul>
 460       </dd>
 461
 462       <dt><code>apr_global_mutex_create()</code>,
 463           <code>apr_proc_mutex_create()</code></dt>
 464       <dd>Optional: See <code>ap_mutex_register()</code>,
 465           <code>ap_global_mutex_create()</code>, and
 466           <code>ap_proc_mutex_create()</code>; these allow your
 467           mutexes to be configurable with
 468           the <code class="directive"><a href="../mod/core.html#mutex">Mutex</a></code> directive;
 469           you can also remove any configuration mechanisms in your
 470           module for such mutexes
 471       </dd>
 472
 473       <dt><code>CORE_PRIVATE</code></dt>
 474       <dd>This is now unnecessary and ignored.</dd>
 475
 476       <dt><code>dav_new_error()</code>
 477       and <code>dav_new_error_tag()</code></dt>
 478       <dd>Previously, these assumed that <code>errno</code> contained
 479       information describing the failure.  Now,
 480       an <code>apr_status_t</code> parameter must be provided.  Pass
 481       0/APR_SUCCESS if there is no such error information, or a valid
 482       <code>apr_status_t</code> value otherwise.</dd>
 483
 484       <dt><code>mpm_default.h</code>, <code>DEFAULT_LOCKFILE</code>,
 485       <code>DEFAULT_THREAD_LIMIT</code>, <code>DEFAULT_PIDLOG</code>,
 486       etc.</dt>
 487       <dd>The header file and most of the default configuration
 488       values set in it are no longer visible to modules.  (Most can
 489       still be overridden at build time.)  <code>DEFAULT_PIDLOG</code>
 490       and <code>DEFAULT_REL_RUNTIMEDIR</code> are now universally
 491       available via <code>ap_config.h</code>.</dd>
 492
 493       <dt><code>unixd_config</code></dt>
 494       <dd>This has been renamed to ap_unixd_config.</dd>
 495
 496       <dt><code>conn_rec-&gt;remote_ip</code> and
 497           <code>conn_rec-&gt;remote_addr</code></dt>
 498       <dd>These fields have been renamed in order to distinguish between
 499       the client IP address of the connection and the useragent IP address
 500       of the request (potentially overridden by a load balancer or proxy).
 501       References to either of these fields must be updated with one of the
 502       following options, as appropriate for the module:
 503       <ul>
 504         <li>When you require the IP address of the user agent, which
 505         might be connected directly to the server, or might optionally be
 506         separated from the server by a transparent load balancer or
 507         proxy, use <code>request_rec-&gt;useragent_ip</code> and
 508         <code>request_rec-&gt;useragent_addr</code>.</li>
 509         <li>When you require the IP address of the client that is
 510         connected directly to the server, which might be the useragent or
 511         might be the load balancer or proxy itself, use
 512         <code>conn_rec-&gt;client_ip</code> and
 513         <code>conn_rec-&gt;client_addr</code>.</li>
 514       </ul>
 515       </dd>
 516     </dl>
 517
 518
 519   <h3><a name="upgrading_byfeature" id="upgrading_byfeature">If your module interfaces with this feature...</a></h3>
 520
 521     <dl>
 522       <dt>suEXEC</dt>
 523       <dd>Optional: If your module logs an error
 524           when <code>ap_unixd_config.suexec_enabled</code> is 0,
 525           also log the value of the new
 526           field <code>suexec_disabled_reason</code>, which contains an
 527           explanation of why it is not available.</dd>
 528
 529       <dt>Extended status data in the scoreboard</dt>
 530       <dd>In previous releases, <code>ExtendedStatus</code> had to be
 531           set to <code>On</code>, which in turn required that
 532           mod_status was loaded.  In 2.4, just
 533           set <code>ap_extended_status</code> to <code>1</code> in a
 534           pre-config hook and the extended status data will be
 535           available.</dd>
 536     </dl>
 537
 538
 539   <h3><a name="upgrading_newfeatures" id="upgrading_newfeatures">Does your module...</a></h3>
 540
 541     <dl>
 542     <dt>Parse query args</dt>
 543     <dd>Consider if <code>ap_args_to_table()</code> would be
 544     helpful.</dd>
 545
 546     <dt>Parse form data...</dt>
 547     <dd>Use <code>ap_parse_form_data()</code>.</dd>
 548
 549     <dt>Check for request header fields <code>Content-Length</code>
 550     and <code>Transfer-Encoding</code> to see if a body was
 551     specified</dt>
 552     <dd>Use <code>ap_request_has_body()</code>.</dd>
 553
 554     <dt>Implement cleanups which clear pointer variables</dt>
 555     <dd>Use <code>ap_pool_cleanup_set_null()</code>.</dd>
 556
 557     <dt>Create run-time files such as shared memory files, pid files,
 558     etc.</dt>
 559     <dd>Use <code>ap_runtime_dir_relative()</code> so that the global
 560     configuration for the location of such files, either by the
 561     <code>DEFAULT_REL_RUNTIMEDIR</code> compile setting or the
 562     <code class="directive"><a href="../mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code> directive,
 563     will be respected.  <em>Apache httpd 2.4.2 and above.</em></dd>
 564
 565     </dl>
 566
 567
 568 </div></div>
 569 <div class="bottomlang">
 570 <p><span>Available Languages: </span><a href="../en/developer/new_api_2_4.html" title="English">&nbsp;en&nbsp;</a></p>
 571 </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>
 572 <script type="text/javascript"><!--//--><![CDATA[//><!--
 573 var comments_shortname = 'httpd';
 574 var comments_identifier = 'http://httpd.apache.org/docs/trunk/developer/new_api_2_4.html';
 575 (function(w, d) {
 576     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 577         d.write('<div id="comments_thread"><\/div>');
 578         var s = d.createElement('script');
 579         s.type = 'text/javascript';
 580         s.async = true;
 581         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 582         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 583     }
 584     else {
 585         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 586     }
 587 })(window, document);
 588 //--><!]]></script></div><div id="footer">
 589 <p class="apache">Copyright 2012 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>
 590 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!--
 591 if (typeof(prettyPrint) !== 'undefined') {
 592     prettyPrint();
 593 }
 594 //--><!]]></script>
 595 </body></html>