- Fix #779: [doc] Missing documention in ub_resolve_event() for

  callback parameter was_ratelimited.

diff --git a/doc/Changelog b/doc/Changelog
index 85a22e58edc66e998a368acefa0ca8af8e227903..66cc6161df615977e7007c23a7bf2f944da8c0c3 100644 (file)
--- a/doc/Changelog
+++ b/doc/Changelog
@@ -1,3 +1,7 @@
+11 November 2022: Wouter
+       - Fix #779: [doc] Missing documention in ub_resolve_event() for
+         callback parameter was_ratelimited.
+
 9 November 2022: George
        - Complementary fix for distutils.sysconfig deprecation in Python 3.10
          to commit 62c5039ab9da42713e006e840b7578e01d66e7f2.

diff --git a/libunbound/unbound-event.h b/libunbound/unbound-event.h
index a5d5c038b68fa25013c673349f24b67f456619e9..5fa74df78186fbeaafb87f77125a1c5050fe7685 100644 (file)
--- a/libunbound/unbound-event.h
+++ b/libunbound/unbound-event.h
@@ -230,7 +230,7 @@ int ub_ctx_set_event(struct ub_ctx* ctx, struct event_base* base);
  * @param callback: this is called on completion of the resolution.
  *     It is called as:
  *     void callback(void* mydata, int rcode, void* packet, int packet_len,
- *             int sec, char* why_bogus)
+ *             int sec, char* why_bogus, int was_ratelimited)
  *     with mydata: the same as passed here, you may pass NULL,
  *     with rcode: 0 on no error, nonzero for mostly SERVFAIL situations,
  *             this is a DNS rcode.
@@ -241,6 +241,7 @@ int ub_ctx_set_event(struct ub_ctx* ctx, struct event_base* base);
  *     with packet_len: length in bytes of the packet buffer.
  *     with sec: 0 if insecure, 1 if bogus, 2 if DNSSEC secure.
  *     with why_bogus: text string explaining why it is bogus (or NULL).
+ *     with was_ratelimited: if the query was ratelimited.
  *     These point to buffers inside unbound; do not deallocate the packet or
  *     error string.
  *