Document incompatible API change which happened

in 2.4.7. The change affects third party modules
using the mod_proxy shared memory structure
proxy_worker_shared. Examples are third party
balancer lbmethod modules.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1738184 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/CHANGES b/CHANGES
index 9ae8a02231765d552e5862c6a7250562d1346aac..459c6b3e3b78f9859f249caf84267d53a3d399b5 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1350,8 +1350,10 @@ Changes with Apache 2.4.7
      (not overridable via SSLCipherSuite). [Kaspar Brand]
 
   *) mod_proxy: Added support for unix domain sockets as the
-     backend server endpoint [Jim Jagielski, Blaise Tarr
-     <blaise tarr gmail com>]
+     backend server endpoint. This also introduces an unintended
+     incompatibility for third party modules using the mod_proxy
+     proxy_worker_shared structure, especially for balancer lbmethod
+     modules. [Jim Jagielski, Blaise Tarr <blaise tarr gmail com>]
 
   *) Add experimental cmake-based build system for Windows.  [Jeff Trawick,
      Tom Donovan]

diff --git a/include/ap_mmn.h b/include/ap_mmn.h
index 8a28919a774378ab86ca09f6909feca14a101abf..999388c3849fb594e4ec95713201a392fb37a0e7 100644 (file)
--- a/include/ap_mmn.h
+++ b/include/ap_mmn.h
@@ -423,7 +423,10 @@
  * 20120211.26 (2.4.7-dev) Add util_fcgi.h, FastCGI protocol support
  * 20120211.27 (2.4.7-dev) Add ap_podx_restart_t and ap_mpm_podx_*
  * 20120211.28 (2.4.7-dev) Add ap_regname
- * 20120211.29 (2.4.7-dev) Add uds_path to proxy_conn_rec
+ * 20120211.29 (2.4.7-dev) Add uds_path to proxy_conn_rec and proxy_worker_shared.
+ *                         The change to proxy_worker_shared is an
+ *                         unintended API break, especially for balancer
+ *                         lbmethod modules.
  * 20120211.30 (2.4.7-dev) REWRITE_REDIRECT_HANDLER_NAME in mod_rewrite.h
  * 20120211.31 (2.4.7-dev) Add ap_proxy_port_of_scheme()
  * 20120211.32 (2.4.10-dev) Add SSL reusable SNI to mod_proxy.h's proxy_conn_rec

diff --git a/modules/proxy/mod_proxy.h b/modules/proxy/mod_proxy.h
index 72dab333a642f19917f44a7cd59743015fc44c0d..6b655075ea9b471da47e932c5f92d647a456680f 100644 (file)
--- a/modules/proxy/mod_proxy.h
+++ b/modules/proxy/mod_proxy.h
@@ -349,6 +349,7 @@ typedef struct {
 } proxy_hashes ;
 
 /* Runtime worker status informations. Shared in scoreboard */
+/* The addition of member uds_path in 2.4.7 was an incompatible API change. */
 typedef struct {
     char      name[PROXY_WORKER_MAX_NAME_SIZE];
     char      scheme[PROXY_WORKER_MAX_SCHEME_SIZE];   /* scheme to use ajp|http|https */