From: Jeff Trawick Date: Mon, 14 Mar 2011 18:30:03 +0000 (+0000) Subject: add some new sections to the API migration docs, where more X-Git-Tag: 2.3.12~237 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=685ff3fc0ac1c2886707d93f32b9dfe490d7144d;p=apache add some new sections to the API migration docs, where more detailed explanations can be provided for some of the API changes and additions git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1081507 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/developer/new_api_2_4.xml b/docs/manual/developer/new_api_2_4.xml index 6389d06359..15d1fd6c24 100644 --- a/docs/manual/developer/new_api_2_4.xml +++ b/docs/manual/developer/new_api_2_4.xml @@ -285,6 +285,108 @@ APLOG_MARK should only be used when calling ap_log_* without additional wrappers. In this way, the code will remain compatible with HTTPD 2.0 and 2.2.

+ +

Consider the following changes to take advantage of the new + APLOG_TRACE1..8 log levels: +

+ + + +
+ If your module uses these APIs... + +
+
ap_get_server_version()
+
For logging purposes, where detailed information is + appropriate, use ap_get_server_description(). + When generating output, where the amount of information + should be configurable by ServerTokens, use + ap_get_server_banner().
+ +
ap_graceful_stop_signalled()
+
Replace with a call + to ap_mpm_query(AP_MPMQ_MPM_STATE) and checking for + state AP_MPMQ_STOPPING.
+ +
ap_max_daemons_limit, ap_my_generation, + and ap_threads_per_child
+
Use ap_mpm_query() query codes + AP_MPMQ_MAX_DAEMON_USED, AP_MPMQ_GENERATION, + and AP_MPMQ_MAX_THREADS, respectively.
+ +
ap_mpm_query()
+
Ensure that it is not used until after the register-hooks + hook has completed. Otherwise, an MPM built as a DSO + would not have had a chance to enable support for this + function.
+ +
ap_server_conf->process->pool + userdata
+
+ Optional: +
    +
  • If your module uses this to determine which pass of the + startup hooks is being run, + use ap_state_query(AP_SQ_MAIN_STATE).
    • +
  • If your module uses this to maintain data across the + unloading and reloading of your module, use + ap_retained_data_create() and + ap_retained_data_get().
    • +
+
+ +
apr_global_mutex_create(), + apr_proc_mutex_create()
+
Optional: See ap_mutex_register(), + ap_global_mutex_create(), and + ap_proc_mutex_create(); these allow your + mutexes to be configurable with + the Mutex directive; + you can also remove any configuration mechanisms in your + module for such mutexes +
+ +
CORE_PRIVATE
+
This is now unnecessary and ignored.
+ +
dav_new_error() + and dav_new_error_tag()
+
Previously, these assumed that errno contained + information describing the failure. Now, + an apr_status_t parameter must be provided. Pass + 0/APR_SUCCESS if there is no such error information, or a valid + apr_status_t value otherwise.
+ +
+
+ +
+ If your module interfaces with this feature... +
+
suEXEC
+
Optional: ap_unixd_config.suexec_enabled is + still provided, but new + field suexec_disabled_reason provides an + explanation if the feature is not available.
+ +
Extended status data in the scoreboard
+
Instead of requiring mod_status and ExtendedStatus + On, just set ap_extended_status + to 1 in a pre-config hook.
+ +