summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/async-query.rst9
-rw-r--r--doc/inbound-xfr-class.rst14
-rw-r--r--doc/query.rst7
-rw-r--r--doc/zone-class.rst9
-rw-r--r--doc/zone.rst1
5 files changed, 38 insertions, 2 deletions
diff --git a/doc/async-query.rst b/doc/async-query.rst
index e2466ea..7202bdf 100644
--- a/doc/async-query.rst
+++ b/doc/async-query.rst
@@ -9,8 +9,8 @@ processing their responses. If you want "stub resolver" behavior, then
you should use the higher level ``dns.asyncresolver`` module; see
:ref:`async_resolver`.
-There is currently no support for zone transfers or DNS-over-HTTPS
-using asynchronous I/O but we hope to offer this in the future.
+There is currently no support for DNS-over-HTTPS using asynchronous
+I/O but we hope to offer this in the future.
UDP
---
@@ -31,3 +31,8 @@ TLS
---
.. autofunction:: dns.asyncquery.tls
+
+Zone Transfers
+--------------
+
+.. autofunction:: dns.asyncquery.inbound_xfr
diff --git a/doc/inbound-xfr-class.rst b/doc/inbound-xfr-class.rst
new file mode 100644
index 0000000..73eaf57
--- /dev/null
+++ b/doc/inbound-xfr-class.rst
@@ -0,0 +1,14 @@
+.. _inbound-xfr-class:
+
+The dns.xfr.Inbound Class and make_query() function
+---------------------------------------------------
+
+The ``Inbound`` class provides support for inbound DNS zone transfers, both
+AXFR and IXFR. I/O is handled in other classes. When a message related
+to the transfer arrives, the I/O code calls the ``process_message()`` method
+which adds the content to the pending transaction.
+
+.. autoclass:: dns.xfr.Inbound
+ :members:
+
+.. autofunction:: dns.xfr.make_query
diff --git a/doc/query.rst b/doc/query.rst
index 08940b4..beb0869 100644
--- a/doc/query.rst
+++ b/doc/query.rst
@@ -41,4 +41,11 @@ HTTPS
Zone Transfers
--------------
+As of dnspython 2.1, ``dns.query.xfr`` is deprecated. Please use
+``dns.query.inbound_xfr`` instead.
+
+.. autoclass:: dns.query.UDPMode
+
+.. autofunction:: dns.query.inbound_xfr
+
.. autofunction:: dns.query.xfr
diff --git a/doc/zone-class.rst b/doc/zone-class.rst
index bdaf884..48e138e 100644
--- a/doc/zone-class.rst
+++ b/doc/zone-class.rst
@@ -91,6 +91,15 @@ See below for more information on the ``Transaction`` API.
A ``bool``, which is ``True`` if names in the zone should be relativized.
+The TransactionManager Class
+----------------------------
+
+This is the abstract base class of all objects that support transactions.
+
+.. autoclass:: dns.transaction.TransactionManager
+ :members:
+
+
The Transaction Class
---------------------
diff --git a/doc/zone.rst b/doc/zone.rst
index 777f08b..17d9e9d 100644
--- a/doc/zone.rst
+++ b/doc/zone.rst
@@ -8,3 +8,4 @@ DNS Zones
zone-class
zone-make
+ inbound-xfr-class