diff options
author | Eric Covener <covener@apache.org> | 2010-01-07 14:52:27 +0000 |
---|---|---|
committer | Eric Covener <covener@apache.org> | 2010-01-07 14:52:27 +0000 |
commit | aa80ddb9ef384b1b6f4259b3b0e02c72a9833473 (patch) | |
tree | a593c40a95d0c4336855c6263e8ec5b8dc4461fd /docs/manual | |
parent | 0b90b0225d7811271101987a1c87646d504e2e9b (diff) | |
download | httpd-aa80ddb9ef384b1b6f4259b3b0e02c72a9833473.tar.gz |
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
Diffstat (limited to 'docs/manual')
-rw-r--r-- | docs/manual/mod/mod_ldap.html.en | 23 | ||||
-rw-r--r-- | docs/manual/mod/mod_ldap.xml | 23 |
2 files changed, 36 insertions, 10 deletions
diff --git a/docs/manual/mod/mod_ldap.html.en b/docs/manual/mod/mod_ldap.html.en index 2c6d3e2fd4..e5acfa60ef 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 f41f77d138..0bef2b366b 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> |