From: Pierangelo Masarati <ando@openldap.org>
Date: Wed, 24 May 2006 17:56:48 +0000 (+0000)
Subject: document "cancel" feature
X-Git-Tag: OPENLDAP_REL_ENG_2_4_3ALPHA~9^2~225
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=3f3d1e48b6546fadcc62c6f15a9b85512a01e5a0;p=openldap

document "cancel" feature
---

diff --git a/doc/man/man5/slapd-ldap.5 b/doc/man/man5/slapd-ldap.5
index 0011354612..2df474253c 100644
--- a/doc/man/man5/slapd-ldap.5
+++ b/doc/man/man5/slapd-ldap.5
@@ -121,6 +121,36 @@ and
 .BR acl-passwd .
 .RE
 
+.TP
+.B cancel {ABANDON|ignore|exop[-discover]}
+Defines how to handle operation cancellation.
+By default,
+.B abandon
+is invoked, so the operation is abandoned immediately.
+If set to
+.BR ignore ,
+no action is taken and any further response is ignored; this may result
+in further response messages to be queued for that connection, so it is
+recommended that long lasting connections are timed out either by
+.I idle-timeout
+or
+.IR conn-ttl ,
+so that resources eventually get released.
+If set to
+.BR exop ,
+a
+.I cancel
+operation (RFC 3909) is issued, resulting in the cancellation 
+of the current operation; the
+.I cancel
+operation waits for remote server response, so its use 
+may not be recommended.
+If set to
+.BR exop-discover ,
+support of the
+.I cancel 
+extended operation is detected by reading the remote server's root DSE.
+
 .TP
 .B chase-referrals {YES|no}
 enable/disable automatic referral chasing, which is delegated to the