summaryrefslogtreecommitdiff
path: root/doc/async-backend.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/async-backend.rst')
-rw-r--r--doc/async-backend.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/async-backend.rst b/doc/async-backend.rst
new file mode 100644
index 0000000..ad3de00
--- /dev/null
+++ b/doc/async-backend.rst
@@ -0,0 +1,18 @@
+module:: dns.asyncbackend
+.. _async-backend:
+
+Asynchronous Backend Functions
+==============================
+
+Dnspython has a "backend" for Trio, Curio, and asyncio which implements
+the library-specific functionality needed by the generic asynchronous
+DNS code.
+
+Dnspython attempts to determine which backend is in use by "sniffing" for it
+with the ``sniffio`` module if it is installed, otherwise it assumes asyncio
+is in use.
+
+.. autofunction:: dns.asyncbackend.get_default_backend
+.. autofunction:: dns.asyncbackend.set_default_backend
+.. autofunction:: dns.asyncbackend.sniff
+.. autofunction:: dns.asyncbackend.get_backend