From 71ddbcc6ce1e68a5e9fb52112d29725b0c78fd8c Mon Sep 17 00:00:00 2001 From: Remi Gacogne Date: Tue, 13 Oct 2020 16:28:56 +0200 Subject: [PATCH] dnsdist: Add the missing documentation for some dnsheader methods --- pdns/dnsdistdist/docs/reference/dq.rst | 52 ++++++++++++++++++++------ 1 file changed, 41 insertions(+), 11 deletions(-) diff --git a/pdns/dnsdistdist/docs/reference/dq.rst b/pdns/dnsdistdist/docs/reference/dq.rst index 378f942f2a..0a69752eea 100644 --- a/pdns/dnsdistdist/docs/reference/dq.rst +++ b/pdns/dnsdistdist/docs/reference/dq.rst @@ -274,21 +274,43 @@ DNSHeader (``dh``) object This object holds a representation of a DNS packet's header. + .. method:: DNSHeader:getAA() -> bool + + Get authoritative answer flag. + + .. method:: DNSHeader:getAD() -> bool + + Get authentic data flag. + + .. method:: DNSHeader:getCD() -> bool + + Get checking disabled flag. + + .. method:: DNSHeader:getRA() -> bool + + Get recursion available flag. + .. method:: DNSHeader:getRD() -> bool Get recursion desired flag. - .. method:: DNSHeader:setRD(rd) + .. method:: DNSHeader:setAA(aa) - Set recursion desired flag. + Set authoritative answer flag. - :param bool rd: State of the RD flag + :param bool aa: State of the AA flag - .. method:: DNSHeader:setTC(tc) + .. method:: DNSHeader:setAD(ad) - Set truncation flag (TC). + Set authentic data flag. - :param bool tc: State of the TC flag + :param bool ad: State of the AD flag + + .. method:: DNSHeader:setCD(cd) + + Set checking disabled flag. + + :param bool cd: State of the CD flag .. method:: DNSHeader:setQR(qr) @@ -297,15 +319,23 @@ DNSHeader (``dh``) object :param bool qr: State of the QR flag - .. method:: DNSHeader:getCD() -> bool + .. method:: DNSHeader:setRA(ra) - Get checking disabled flag. + Set recursion available flag. - .. method:: DNSHeader:setCD(cd) + :param bool ra: State of the RA flag - Set checking disabled flag. + .. method:: DNSHeader:setRD(rd) - :param bool cd: State of the CD flag + Set recursion desired flag. + + :param bool rd: State of the RD flag + + .. method:: DNSHeader:setTC(tc) + + Set truncation flag (TC). + + :param bool tc: State of the TC flag .. _EDNSOptionView: -- 2.47.2