]> git.sur5r.net Git - openldap/commitdiff
More notes now that LDAP_OPT_TIMEOUT is implemented.
authorHoward Chu <hyc@openldap.org>
Fri, 16 Feb 2007 11:52:46 +0000 (11:52 +0000)
committerHoward Chu <hyc@openldap.org>
Fri, 16 Feb 2007 11:52:46 +0000 (11:52 +0000)
doc/man/man3/ldap_result.3
doc/man/man5/ldap.conf.5

index 9a64117b6c29aa3e2baf785c13cfff7f9d495b18..e86aecffd1b5a80d3240c5758d2e23ca043bec94 100644 (file)
@@ -43,7 +43,10 @@ routine will block or not, depending upon the setting
 of the \fItimeout\fP parameter.
 If timeout is not a NULL pointer,  it  specifies  a  maximum
 interval  to wait for the selection to complete.  If timeout
-is a NULL  pointer,  the  select  blocks  indefinitely.   To
+is a NULL  pointer, the LDAP_OPT_TIMEOUT value set by
+.BR ldap_set_option (3)
+is used. With the default setting,
+the  select  blocks  indefinitely.   To
 effect  a  poll,  the  timeout argument should be a non-NULL
 pointer, pointing to a zero-valued timeval structure.  See
 .BR select (2)
index 78de1480ad3b8f92f39aa8e7b04a21a1ebc87efe..b5818696385fd74e2879fe678fef55fc5f0d8255 100644 (file)
@@ -187,7 +187,10 @@ specifies unlimited search time to be used.
 Specifies what version of the LDAP protocol should be used.
 .TP
 .B TIMEOUT <integer>
-Specifies a generic timeout (in seconds).  Currently ignored.
+Specifies a timeout (in seconds) after which calls to synchronous LDAP
+APIs will abort if no response is received.  Also used for any
+.BR ldap_result (3)
+calls where a NULL timeout parameter is supplied.
 .SH SASL OPTIONS
 If OpenLDAP is built with Simple Authentication and Security Layer support,
 there are more options you can specify.
@@ -368,6 +371,8 @@ user ldap configuration file
 local ldap configuration file
 .SH "SEE ALSO"
 .BR ldap (3),
+.BR ldap_set_option (3),
+.BR ldap_result (3),
 .BR openssl (1),
 .BR sasl (3)
 .SH AUTHOR