ap_mmn.h revision ff4ec92f5bb8d43b3ba1979ccda94f07961bf323
2d2eda71267231c2526be701fe655db125852c1ffielding/* Licensed to the Apache Software Foundation (ASF) under one or more
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * contributor license agreements. See the NOTICE file distributed with
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * this work for additional information regarding copyright ownership.
bc8fd1b0b1afdf89b8d28eefa8cd74e26ba97986fielding * The ASF licenses this file to You under the Apache License, Version 2.0
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * (the "License"); you may not use this file except in compliance with
2d2eda71267231c2526be701fe655db125852c1ffielding * the License. You may obtain a copy of the License at
2d2eda71267231c2526be701fe655db125852c1ffielding * Unless required by applicable law or agreed to in writing, software
2d2eda71267231c2526be701fe655db125852c1ffielding * distributed under the License is distributed on an "AS IS" BASIS,
2d2eda71267231c2526be701fe655db125852c1ffielding * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2d2eda71267231c2526be701fe655db125852c1ffielding * See the License for the specific language governing permissions and
2d2eda71267231c2526be701fe655db125852c1ffielding * limitations under the License.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * @brief Module Magic Number
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * @defgroup APACHE_CORE_MMN Module Magic Number
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * @ingroup APACHE_CORE
2d2eda71267231c2526be701fe655db125852c1ffielding * MODULE_MAGIC_NUMBER_MAJOR
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * Major API changes that could cause compatibility problems for older modules
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * such as structure size changes. No binary compatibility is possible across
64185f9824e42f21ca7b9ae6c004484215c031a7rbb * a change in the major version.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * MODULE_MAGIC_NUMBER_MINOR
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * Minor API changes that do not cause binary compatibility problems.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
2d2eda71267231c2526be701fe655db125852c1ffielding * See the MODULE_MAGIC_AT_LEAST macro below for an example.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 20010523 (2.0.19-dev) bump for scoreboard structure reordering
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 20010627 (2.0.19-dev) more API changes than I can count
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 20010726 (2.0.22-dev) more big API changes
2d2eda71267231c2526be701fe655db125852c1ffielding * 20010808 (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
2d2eda71267231c2526be701fe655db125852c1ffielding * 20010825 (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
2d2eda71267231c2526be701fe655db125852c1ffielding * 20011002 (2.0.26-dev) removed 1.3-deprecated request_rec.content_language
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 20011127 (2.0.29-dev) bump for postconfig hook change, and removal of
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * socket from connection record
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 20011212 (2.0.30-dev) bump for new used_path_info member of request_rec
2d2eda71267231c2526be701fe655db125852c1ffielding * 20011218 (2.0.30-dev) bump for new sbh member of conn_rec, different
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * declarations for scoreboard, new parameter to
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * create_connection hook
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 20020102 (2.0.30-dev) bump for changed type of limit_req_body in
2d2eda71267231c2526be701fe655db125852c1ffielding * core_dir_config
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020109 (2.0.31-dev) bump for changed shm and scoreboard declarations
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020111 (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020114 (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
2d2eda71267231c2526be701fe655db125852c1ffielding * a GET request
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * 20020118 (2.0.31-dev) Input filtering split of blocking and mode
b980ad7fdc218b4855cde9f75a747527f50c554dwrowe * 20020127 (2.0.31-dev) bump for pre_mpm hook change
ab5581cc78e9d865b0a6ab1404c53347b3276968rbb * 20020128 (2.0.31-dev) bump for pre_config hook change
92f3af936ce61f25358a3ee4f28df2f6d62040dfdreid * 20020218 (2.0.33-dev) bump for AddOutputFilterByType directive
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * 20020220 (2.0.33-dev) bump for scoreboard.h structure change
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20020302 (2.0.33-dev) bump for protocol_filter additions.
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding * 20020306 (2.0.34-dev) bump for filter type renames.
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020318 (2.0.34-dev) mod_dav's API for REPORT generation changed
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020319 (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020327 (2.0.35-dev) Add parameter to quick_handler hook
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020329 (2.0.35-dev) bump for addition of freelists to bucket API
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20020329.1 (2.0.36) minor bump for new arg to opt fn ap_cgi_build_command
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20020506 (2.0.37-dev) Removed r->boundary in request_rec.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20020529 (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20020602 (2.0.37-dev) Bucket API change (metadata buckets)
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb * 20020612 (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb * 20020625 (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb * 20020628 (2.0.40-dev) Added filter_init to filter registration functions
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb * 20020903 (2.0.41-dev) APR's error constants changed
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb * 20020903.1 (2.1.0-dev) allow_encoded_slashes added to core_dir_config
2d2eda71267231c2526be701fe655db125852c1ffielding * 20020903.2 (2.0.46-dev) add ap_escape_logitem
2d2eda71267231c2526be701fe655db125852c1ffielding * 20030213.1 (2.1.0-dev) changed log_writer optional fn's to return previous
2d2eda71267231c2526be701fe655db125852c1ffielding * 20030821 (2.1.0-dev) bumped mod_include's entire API
2d2eda71267231c2526be701fe655db125852c1ffielding * 20030821.1 (2.1.0-dev) added XHTML doctypes
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20030821.2 (2.1.0-dev) added ap_escape_errorlog_item
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20030821.3 (2.1.0-dev) added ap_get_server_revision / ap_version_t
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20040425 (2.1.0-dev) removed ap_add_named_module API
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * changed ap_add_module, ap_add_loaded_module,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * ap_setup_prelinked_modules,
2d2eda71267231c2526be701fe655db125852c1ffielding * ap_process_resource_config
2d2eda71267231c2526be701fe655db125852c1ffielding * 20040425.1 (2.1.0-dev) Added ap_module_symbol_t and
bfb62a96023822c56c9120e4ee627d4091cc59c2rbb * ap_prelinked_module_symbols
bfb62a96023822c56c9120e4ee627d4091cc59c2rbb * 20050101.0 (2.1.2-dev) Axed misnamed http_method for http_scheme
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * (which it was!)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050127.0 (2.1.3-dev) renamed regex_t->ap_regex_t,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * regmatch_t->ap_regmatch_t, REG_*->AP_REG_*,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * removed reg* in place of ap_reg*; added ap_regex.h
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050217.0 (2.1.3-dev) Axed find_child_by_pid, mpm_*_completion_context
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * (winnt mpm) symbols from the public sector, and
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * decorated real_exit_code with ap_ in the win32/os.h.
2d2eda71267231c2526be701fe655db125852c1ffielding * 20050305.0 (2.1.4-dev) added pid and generation fields to worker_score
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050305.1 (2.1.5-dev) added ap_vhost_iterate_given_conn.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050305.2 (2.1.5-dev) added AP_INIT_TAKE_ARGV.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050305.3 (2.1.5-dev) added Protocol Framework.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050701.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP21"!
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050701.1 (2.1.7-dev) trace_enable member added to core server_config
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050708.0 (2.1.7-dev) Bump MODULE_MAGIC_COOKIE to "AP22"!
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050708.1 (2.1.7-dev) add proxy request_status hook (minor)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20050919.0 (2.1.8-dev) mod_ssl ssl_ext_list optional function added
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20051005.0 (2.1.8-dev) NET_TIME filter eliminated
2d2eda71267231c2526be701fe655db125852c1ffielding * 20051005.0 (2.3.0-dev) Bump MODULE_MAGIC_COOKIE to "AP24"!
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * 20051115.0 (2.3.0-dev) Added use_canonical_phys_port to core_dir_config
2d2eda71267231c2526be701fe655db125852c1ffielding * 20060110.0 (2.3.0-dev) Conversion of Authz to be provider based
2d2eda71267231c2526be701fe655db125852c1ffielding * addition of <SatisfyAll><SatisfyOne>
2d2eda71267231c2526be701fe655db125852c1ffielding * removal of Satisfy, Allow, Deny, Order
2d2eda71267231c2526be701fe655db125852c1ffielding * 20060110.1 (2.3.0-dev) minex and minex_set members added to
000b67449410515eac43e76ef6667915bfd4d2abgstein * cache_server_conf (minor)
2d2eda71267231c2526be701fe655db125852c1ffielding * 20060110.2 (2.3.0-dev) flush_packets and flush_wait members added to
2d2eda71267231c2526be701fe655db125852c1ffielding * proxy_server (minor)
2d2eda71267231c2526be701fe655db125852c1ffielding * 20060110.3 (2.3.0-dev) added inreslist member to proxy_conn_rec (minor)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20060110.4 (2.3.0-dev) Added server_scheme member to server_rec (minor)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20060905.0 (2.3.0-dev) Replaced ap_get_server_version() with
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * ap_get_server_banner() and ap_get_server_description()
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20060905.1 (2.3.0-dev) Enable retry=0 for the worker (minor)
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein * 20060905.2 (2.3.0-dev) Added ap_all_available_mutexes_string,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * ap_available_mutexes_string and
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein * ap_parse_mutex()
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein * 20060905.3 (2.3.0-dev) Added conn_rec::clogging_input_filters.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20060905.4 (2.3.0-dev) Added proxy_balancer::sticky_path.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20060905.5 (2.3.0-dev) Added ap_mpm_safe_kill()
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20070823.0 (2.3.0-dev) Removed ap_all_available_mutexes_string,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * ap_available_mutexes_string for macros
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20070823.1 (2.3.0-dev) add ap_send_interim_response()
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20071023.0 (2.3.0-dev) add ap_get_scoreboard(sbh) split from the less
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * conventional ap_get_scoreboard(proc, thread)
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein * 20071023.1 (2.3.0-dev) Add flags field to struct proxy_alias
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20071023.2 (2.3.0-dev) Add ap_mod_status_reqtail
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20071023.3 (2.3.0-dev) Declare ap_time_process_request() as part of the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * public scoreboard API.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20071108.1 (2.3.0-dev) Add the optional kept_body brigade to request_rec
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20071108.2 (2.3.0-dev) Add st and keep fields to struct util_ldap_connection_t
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20071108.3 (2.3.0-dev) Add API guarantee for adding connection filters
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * with non-NULL request_rec pointer (ap_add_*_filter*)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20071108.4 (2.3.0-dev) Add ap_proxy_ssl_connection_cleanup
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * 20071108.5 (2.3.0-dev) Add *scpool to proxy_conn_rec structure
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein * 20071108.6 (2.3.0-dev) Add *r and need_flush to proxy_conn_rec structure
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20071108.7 (2.3.0-dev) Add *ftp_directory_charset to proxy_dir_conf
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20071108.8 (2.3.0-dev) Add optional function ap_logio_add_bytes_in() to mog_logio
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20071108.9 (2.3.0-dev) Add chroot support to unixd_config
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20071108.10(2.3.0-dev) Introduce new ap_expr API
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20071108.11(2.3.0-dev) Revise/Expand new ap_expr API
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20071108.12(2.3.0-dev) Remove ap_expr_clone from the API (same day it was added)
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20080403.0 (2.3.0-dev) Add condition field to core dir config
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20080403.1 (2.3.0-dev) Add authn/z hook and provider registration wrappers.
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20080403.2 (2.3.0-dev) Add ap_escape_path_segment_buffer() and ap_unescape_all().
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20080407.0 (2.3.0-dev) Remove ap_graceful_stop_signalled.
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20080407.1 Deprecate ap_cache_cacheable_hdrs_out and add two
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * generalized ap_cache_cacheable_headers_(in|out).
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * 20080528.0 (2.3.0-dev) Switch order of ftp_directory_charset and
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * interpolate_env in proxy_dir_conf.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Rationale: see r661069.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20080528.1 (2.3.0-dev) add has_realm_hash() to authn_provider struct
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20080722.0 (2.3.0-dev) remove has_realm_hash() from authn_provider struct
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20080722.1 (2.3.0-dev) Add conn_timeout and conn_timeout_set to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * proxy_worker struct.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 20080722.2 (2.3.0-dev) Add scolonsep to proxy_balancer
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * specified value.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Useful for testing for features.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * For example, suppose you wish to use the apr_table_overlap
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * function. You can do this:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * ... use apr_table_overlap()
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * ... alternative code which doesn't use apr_table_overlap()
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param major The major module magic number
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param minor The minor module magic number
3d96ee83babeec32482c9082c9426340cee8c44dwrowe * @fn AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
2d2eda71267231c2526be701fe655db125852c1ffielding/** @deprecated present for backwards compatibility */
2d2eda71267231c2526be701fe655db125852c1ffielding#define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
2d2eda71267231c2526be701fe655db125852c1ffielding#define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
2d2eda71267231c2526be701fe655db125852c1ffielding#endif /* !APACHE_AP_MMN_H */