* mod_proxy_balancer: Document BALANCER_ROUTE_CHANGED environment variable.

Submitted by: Brian Rectanus <brectanu gmail.com>
Reviewed by: rpluem

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@453630 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/mod/mod_proxy_balancer.xml b/docs/manual/mod/mod_proxy_balancer.xml
index e923499396547046b570e5b9ea97013aa5441075..532fc92fcb23029e4299ad147ef2ab0c12686424 100644 (file)
--- a/docs/manual/mod/mod_proxy_balancer.xml
+++ b/docs/manual/mod/mod_proxy_balancer.xml
@@ -273,10 +273,10 @@ candidate lbstatus -= total factor</code></pre>
 
 <section id="environment">
     <title>Exported Environment Variables</title>
-    <p>At present there are 5 environment variables exported:</p>
-    
-    <!-- ============= BALANCER_SESSION_STICKY =============== -->
+    <p>At present there are 6 environment variables exported:</p>
+
     <dl>
+    <!-- ============= BALANCER_SESSION_STICKY =============== -->
     <dt><var><a name="balancer_session_sticky" id="balancer_session_sticky">BALANCER_SESSION_STICKY</a></var></dt>
     <dd>
     <p>This is assigned the <var>stickysession</var> value used in the current
@@ -310,6 +310,16 @@ candidate lbstatus -= total factor</code></pre>
     <p>This is assigned the <var>route</var> of the worker that will be 
     used for the current request.</p>
     </dd>
+
+    <!-- ============= BALANCER_ROUTE_CHANGED ================= -->
+    <dt><var><a name="balancer_route_changed" id="balancer_route_changed">BALANCER_ROUTE_CHANGED</a></var></dt>
+    <dd>
+    <p>This is set to 1 if the session route does not match the
+    worker route (BALANCER_SESSION_ROUTE != BALANCER_WORKER_ROUTE) or the
+    session does not yet have an established route.  This can be used to
+    determine when/if the client needs to be sent an updated route
+    when sticky sessions are used.</p>
+    </dd>
     </dl>
 
 </section>