From c316b1d7d54c276698ddcef53652aba807558474 Mon Sep 17 00:00:00 2001 From: George Thessalonikefs Date: Mon, 10 Feb 2020 10:31:47 +0100 Subject: [PATCH] - Document 'ub_result.was_ratelimited' in libunbound. --- doc/Changelog | 3 +++ doc/libunbound.3.in | 7 ++++--- libunbound/unbound.h | 5 +++-- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/Changelog b/doc/Changelog index 9fec42bbe..dc2856263 100644 --- a/doc/Changelog +++ b/doc/Changelog @@ -1,3 +1,6 @@ +10 February 2020: George + - Document 'ub_result.was_ratelimited' in libunbound. + 6 February 2020: George - Fix num_reply_states and num_detached_states counting with serve_expired_callback. diff --git a/doc/libunbound.3.in b/doc/libunbound.3.in index 5bd4ad8a1..548969142 100644 --- a/doc/libunbound.3.in +++ b/doc/libunbound.3.in @@ -396,12 +396,13 @@ The result of the DNS resolution and validation is returned as char* canonname; /* canonical name of result */ int rcode; /* additional error code in case of no data */ void* answer_packet; /* full network format answer packet */ - int answer_len; /* length of packet in octets */ + int answer_len; /* length of packet in octets */ int havedata; /* true if there is data */ int nxdomain; /* true if nodata because name does not exist */ - int secure; /* true if result is secure */ - int bogus; /* true if a security failure happened */ + int secure; /* true if result is secure */ + int bogus; /* true if a security failure happened */ char* why_bogus; /* string with error if bogus */ + int was_ratelimited; /* true if the query was ratelimited (SERVFAIL) by unbound */ int ttl; /* number of seconds the result is valid */ }; .fi diff --git a/libunbound/unbound.h b/libunbound/unbound.h index 04661838c..ca9592d62 100644 --- a/libunbound/unbound.h +++ b/libunbound/unbound.h @@ -204,8 +204,9 @@ struct ub_result { char* why_bogus; /** - * If the query or one of its subqueries was ratelimited. Useful if - * ratelimiting is enabled and answer is SERVFAIL. + * If the query or one of its subqueries was ratelimited. Useful if + * ratelimiting is enabled and answer to the client is SERVFAIL as a + * result. */ int was_ratelimited;