summaryrefslogtreecommitdiff
path: root/doc/message-flags.rst
diff options
context:
space:
mode:
authorBob Halley <halley@dnspython.org>2017-01-15 06:10:09 -0800
committerBob Halley <halley@dnspython.org>2017-01-15 06:10:09 -0800
commit710ac1e16b5a1d89bffa61e14cc4aa63309400ec (patch)
tree10057fa2bc3486d40fbdc1bce863725485b848cf /doc/message-flags.rst
parent1ac8189506f71b9e683e9af29431f6811ad18de1 (diff)
downloaddnspython-710ac1e16b5a1d89bffa61e14cc4aa63309400ec.tar.gz
more doco overhaul
Diffstat (limited to 'doc/message-flags.rst')
-rw-r--r--doc/message-flags.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/message-flags.rst b/doc/message-flags.rst
new file mode 100644
index 0000000..2f79343
--- /dev/null
+++ b/doc/message-flags.rst
@@ -0,0 +1,33 @@
+.. _message-flags:
+
+Message Flags
+=============
+
+DNS message flags are used for signalling of various kinds
+in the DNS protocol. For example, the ``QR`` flag indicates
+that a message is a response to a prior query.
+
+Messages flags are encoded in two locations: the DNS header
+and the EDNS flags field.
+
+Header Flags
+------------
+
+.. autodata:: dns.flags.QR
+.. autodata:: dns.flags.AA
+.. autodata:: dns.flags.TC
+.. autodata:: dns.flags.RD
+.. autodata:: dns.flags.RA
+.. autodata:: dns.flags.AD
+.. autodata:: dns.flags.CD
+
+.. autofunction:: dns.flags.from_text
+.. autofunction:: dns.flags.to_text
+
+EDNS Flags
+----------
+
+.. autodata:: dns.flags.DO
+
+.. autofunction:: dns.flags.edns_from_text
+.. autofunction:: dns.flags.edns_to_text