From: Eric Covener <covener@apache.org>
Date: Thu, 7 Jan 2010 14:52:27 +0000 (+0000)
Subject: clarify LDAPConnectionTimeout behavior/availability which is really just
X-Git-Tag: 2.3.5~17
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=aa80ddb9ef384b1b6f4259b3b0e02c72a9833473;p=thirdparty%2Fapache%2Fhttpd.git

clarify LDAPConnectionTimeout behavior/availability which is really just
passed along to the SDK when applicable.



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

diff --git a/docs/manual/mod/mod_ldap.html.en b/docs/manual/mod/mod_ldap.html.en
index 2c6d3e2fd4d..e5acfa60ef4 100644
--- a/docs/manual/mod/mod_ldap.html.en
+++ b/docs/manual/mod/mod_ldap.html.en
@@ -472,11 +472,24 @@ by other LDAP modules</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 </table>
-    <p>Specifies the timeout value (in seconds) in which the module will
-    attempt to connect to the LDAP server.  If a connection is not
-    successful with the timeout period, either an error will be 
-    returned or the module will attempt to connect to a secondary LDAP 
-    server if one is specified. The default is 10 seconds.</p>
+    <p>This directive configures the LDAP_OPT_NETWORK_TIMEOUT option in the
+    underlying LDAP client library, when available.  This value typically 
+    controls how long the LDAP client library will wait for various network 
+    calls to complete, including establishing a connection to the target LDAP 
+    server.</p>
+
+    <p> If a connection is not successful with the timeout period, either an error will be 
+    returned or the LDAP client library will attempt to connect to a secondary LDAP 
+    server if one is specified (via a space-separated list of hostnames in the 
+    <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code>).</p>
+
+    <p>The default is 10 seconds, if the LDAP client library linked with the 
+    server supports the LDAP_OPT_NETWORK_TIMEOUT option.</p>
+
+    <div class="note">LDAPConnectionTimeout is only available when the LDAP client library linked
+    with the server supports the LDAP_OPT_NETWORK_TIMEOUT option, and the
+    ultimate behavior is dictated entirely by the LDAP client library.
+    </div>
 
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
diff --git a/docs/manual/mod/mod_ldap.xml b/docs/manual/mod/mod_ldap.xml
index f41f77d1384..0bef2b366be 100644
--- a/docs/manual/mod/mod_ldap.xml
+++ b/docs/manual/mod/mod_ldap.xml
@@ -631,11 +631,24 @@ connection client certificates.</description>
 <contextlist><context>server config</context></contextlist>
 
 <usage>
-    <p>Specifies the timeout value (in seconds) in which the module will
-    attempt to connect to the LDAP server.  If a connection is not
-    successful with the timeout period, either an error will be 
-    returned or the module will attempt to connect to a secondary LDAP 
-    server if one is specified. The default is 10 seconds.</p>
+    <p>This directive configures the LDAP_OPT_NETWORK_TIMEOUT option in the
+    underlying LDAP client library, when available.  This value typically 
+    controls how long the LDAP client library will wait for various network 
+    calls to complete, including establishing a connection to the target LDAP 
+    server.</p>
+
+    <p> If a connection is not successful with the timeout period, either an error will be 
+    returned or the LDAP client library will attempt to connect to a secondary LDAP 
+    server if one is specified (via a space-separated list of hostnames in the 
+    <directive module="mod_ldap">AuthLDAPURL</directive>).</p>
+
+    <p>The default is 10 seconds, if the LDAP client library linked with the 
+    server supports the LDAP_OPT_NETWORK_TIMEOUT option.</p>
+
+    <note>LDAPConnectionTimeout is only available when the LDAP client library linked
+    with the server supports the LDAP_OPT_NETWORK_TIMEOUT option, and the
+    ultimate behavior is dictated entirely by the LDAP client library.
+    </note>
 </usage>
 </directivesynopsis>