From 735180918dd51e0664b91b5cc860432de29817fc Mon Sep 17 00:00:00 2001 From: Howard Chu Date: Fri, 16 Feb 2007 11:52:46 +0000 Subject: [PATCH] More notes now that LDAP_OPT_TIMEOUT is implemented. --- doc/man/man3/ldap_result.3 | 5 ++++- doc/man/man5/ldap.conf.5 | 7 ++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/man/man3/ldap_result.3 b/doc/man/man3/ldap_result.3 index 9a64117b6c..e86aecffd1 100644 --- a/doc/man/man3/ldap_result.3 +++ b/doc/man/man3/ldap_result.3 @@ -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) diff --git a/doc/man/man5/ldap.conf.5 b/doc/man/man5/ldap.conf.5 index 78de1480ad..b581869638 100644 --- a/doc/man/man5/ldap.conf.5 +++ b/doc/man/man5/ldap.conf.5 @@ -187,7 +187,10 @@ specifies unlimited search time to be used. Specifies what version of the LDAP protocol should be used. .TP .B TIMEOUT -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 -- 2.39.5