From: Aram Sargsyan <aram@isc.org>
Date: Fri, 25 Oct 2024 13:35:03 +0000 (+0000)
Subject: Update the dns_dispatch_add() function's documentation
X-Git-Tag: v9.21.5~43^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9ccd1be482361b80f89e9af330b6081a5e96f81c;p=thirdparty%2Fbind9.git

Update the dns_dispatch_add() function's documentation

The 'timedout' callback no longer exists. Remove the mentioning of
the 'timedout' callback.
---

diff --git a/lib/dns/include/dns/dispatch.h b/lib/dns/include/dns/dispatch.h
index 45fc4946d2b..eced64f0af9 100644
--- a/lib/dns/include/dns/dispatch.h
+++ b/lib/dns/include/dns/dispatch.h
@@ -308,10 +308,8 @@ dns_dispatch_add(dns_dispatch_t *disp, isc_loop_t *loop,
  * with the dispatch entry object.
  *
  * The 'connected' and 'sent' callbacks are run to inform the caller when
- * the connect and send functions are complete. The 'timedout' callback
- * is run to inform the caller that a read has timed out; it may optionally
- * reset the read timer. The 'response' callback is run for recv results
- * (response packets, timeouts, or cancellations).
+ * the connect and send functions are complete. The 'response' callback is run
+ * for recv results (response packets, timeouts, or cancellations).
  *
  * All the callback functions are sent 'arg' as a parameter.
  *