document timeout support in searches

This commit is contained in:
Pierangelo Masarati 2007-01-26 02:05:49 +00:00
parent 6155d91143
commit 5ef5652125
2 changed files with 32 additions and 17 deletions

View File

@ -446,13 +446,15 @@ support is detected by reading the remote server's root DSE.
This directive allows to set per-operation timeouts. This directive allows to set per-operation timeouts.
Operations can be Operations can be
\fB<op> ::= bind, add, delete, modrdn, modify, compare\fP \fB<op> ::= bind, add, delete, modrdn, modify, compare, search\fP
The \fBsearch\fP operation is already controlled either The overall duration of the \fBsearch\fP operation is controlled either
by the \fBtimelimit\fP parameter or by server-side enforced by the \fBtimelimit\fP parameter or by server-side enforced
time limits (see \fBtimelimit\fP and \fBlimits\fP in time limits (see \fBtimelimit\fP and \fBlimits\fP in
.BR slapd.conf (5) .BR slapd.conf (5)
for details). for details).
This \fBtimeout\fP parameter controls how long the target can be
irresponsive before the operation is aborted.
Timeout is meaningless for the remaining operations, Timeout is meaningless for the remaining operations,
\fBunbind\fP and \fBabandon\fP, which do not imply any response, \fBunbind\fP and \fBabandon\fP, which do not imply any response,
while it is not yet implemented in currently supported \fBextended\fP while it is not yet implemented in currently supported \fBextended\fP

View File

@ -371,22 +371,35 @@ If set before any target specification, it affects all targets, unless
overridden by any per-target directive. overridden by any per-target directive.
.TP .TP
.B timeout [{add|delete|modify|modrdn}=]<seconds> [...] .B timeout [<op>=]<val> [...]
This directive allows to set per-database, per-target and per-operation This directive allows to set per-operation timeouts.
timeouts. Operations can be
If no operation is specified, it affects all.
Currently, only write operations are addressed, because searches \fB<op> ::= bind, add, delete, modrdn, modify, compare, search\fP
can already be limited by means of the
.B limits The overall duration of the \fBsearch\fP operation is controlled either
directive (see by the \fBtimelimit\fP parameter or by server-side enforced
time limits (see \fBtimelimit\fP and \fBlimits\fP in
.BR slapd.conf (5) .BR slapd.conf (5)
for details), and other operations are not supposed to incur into the for details).
need for timeouts. This \fBtimeout\fP parameter controls how long the target can be
Note: if the timelimit is exceeded, the operation is abandoned; irresponsive before the operation is aborted.
the protocol does not provide any means to rollback the operation, Timeout is meaningless for the remaining operations,
so the client will not know if the operation eventually succeeded or not. \fBunbind\fP and \fBabandon\fP, which do not imply any response,
If set before any target specification, it affects all targets, unless while it is not yet implemented in currently supported \fBextended\fP
overridden by any per-target directive. operations.
If no operation is specified, the timeout \fBval\fP affects all
supported operations.
If specified before any target definition, it affects all targets
unless overridden by per-target directives.
Note: if the timelimit is exceeded, the operation is cancelled
(according to the \fBcancel\fP directive);
the protocol does not provide any means to rollback operations,
so the client will not be notified about the result of the operation,
which may eventually succeeded or not.
In case the timeout is exceeded during a bind operation, the connection
is destroyed, according to RFC4511.
.TP .TP
.B tls {[try-]start|[try-]propagate} .B tls {[try-]start|[try-]propagate}