]> git.sur5r.net Git - openldap/commitdiff
Changed LDAP_OPT_TIMEOUT / LDAP_OPT_NETWORK_TIMEOUT behavior
authorHoward Chu <hyc@openldap.org>
Mon, 5 Feb 2007 20:43:12 +0000 (20:43 +0000)
committerHoward Chu <hyc@openldap.org>
Mon, 5 Feb 2007 20:43:12 +0000 (20:43 +0000)
doc/man/man3/ldap_get_option.3

index 970d4b0271c6cc614b62efb83c4b8db7fe4ef42f..b98906d7562158ede61a95f14b6359d72bdee5ee 100644 (file)
@@ -56,15 +56,14 @@ must be a
 This is a read-only, handler-specific option.
 .TP
 .B LDAP_OPT_TIMEOUT
-Sets/gets a timeout value (\fIFIXME: currently unused\fP).
-.BR outvalue
+Sets/gets a timeout value for the synchronous API calls.
+.B outvalue
+and
+.B invalue
 must be a 
-.BR "struct timeval **" ,
-and the resulting pointer must be freed by the caller using
-.BR ldap_memfree (3).
-.BR invalue
-must be a
-.BR "struct timeval *" .
+.BR "struct timeval *" ,
+and they cannot be NULL. Using a struct with seconds set to -1 results
+in an infinite timeout, which is the default.
 .TP
 .B LDAP_OPT_NETWORK_TIMEOUT
 Sets/gets the network timeout value after which
@@ -72,14 +71,13 @@ Sets/gets the network timeout value after which
 following a 
 .BR connect (2) 
 returns in case of no activity.
-.BR outvalue
+.B outvalue
+and
+.B invalue
 must be a 
-.BR "struct timeval **" ,
-and the resulting pointer must be freed by the caller using
-.BR ldap_memfree (3).
-.BR invalue
-must be a
-.BR "struct timeval *" .
+.BR "struct timeval *" ,
+and they cannot be NULL. Using a struct with seconds set to -1 results
+in an infinite timeout, which is the default.
 .TP
 .B LDAP_OPT_DEREF
 Sets/gets the value that defines when alias deferencing must occur.