diff options
| author | Bob Halley <halley@dnspython.org> | 2017-01-16 06:29:01 -0800 |
|---|---|---|
| committer | Bob Halley <halley@dnspython.org> | 2017-01-16 06:29:01 -0800 |
| commit | 55ea2cb6973c9184a67fcd3ec0f880d7703cc279 (patch) | |
| tree | 53ff9dc3d4dfa6451fe44f481d17d13c005c104c /doc | |
| parent | 8cd2dadb45fbe08b9e0cf58e323f0e5b4a134e9f (diff) | |
| download | dnspython-55ea2cb6973c9184a67fcd3ec0f880d7703cc279.tar.gz | |
query doco
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/exceptions.rst | 9 | ||||
| -rw-r--r-- | doc/manual.rst | 2 | ||||
| -rw-r--r-- | doc/query.rst | 33 | ||||
| -rw-r--r-- | doc/resolver.rst | 8 |
4 files changed, 51 insertions, 1 deletions
diff --git a/doc/exceptions.rst b/doc/exceptions.rst index 9f5e22c..cc04afc 100644 --- a/doc/exceptions.rst +++ b/doc/exceptions.rst @@ -45,7 +45,14 @@ dns.opcode Exceptions --------------------- .. autoexception:: dns.opcode.UnknownOpcode - + +dns.query Exceptions +-------------------- + +.. autoexception:: dns.query.BadResponse +.. autoexception:: dns.query.UnexpectedSource + + dns.rcode Exceptions -------------------- diff --git a/doc/manual.rst b/doc/manual.rst index c032f4f..f152894 100644 --- a/doc/manual.rst +++ b/doc/manual.rst @@ -10,5 +10,7 @@ Dnspython Manual rdata message dnssec + query + resolver exceptions utilities diff --git a/doc/query.rst b/doc/query.rst new file mode 100644 index 0000000..77e1c6b --- /dev/null +++ b/doc/query.rst @@ -0,0 +1,33 @@ +.. module:: dns.query +.. _query: + +DNS Query Support +================= + +The ``dns.query`` module is for sending messages to DNS servers, and +processing their responses. If you want "stub resolver" behavior, then +you should use the higher level ``dns.resolver`` module; see :ref:`resolver`. + +For UDP and TCP, the module provides a single "do everything" query +function, and also provides the send and receive halves of this function +individually for situations where more sophisticated I/O handling is in +being used by the application. + +UDP +--- + +.. autofunction:: dns.query.udp +.. autofunction:: dns.query.send_udp +.. autofunction:: dns.query.receive_udp + +TCP +--- + +.. autofunction:: dns.query.tcp +.. autofunction:: dns.query.send_tcp +.. autofunction:: dns.query.receive_tcp + +Zone Transfers +-------------- + +.. autofunction:: dns.query.xfr diff --git a/doc/resolver.rst b/doc/resolver.rst new file mode 100644 index 0000000..6fad36d --- /dev/null +++ b/doc/resolver.rst @@ -0,0 +1,8 @@ +.. module:: dns.resolver +.. _resolver: + +Stub Resolver +============= + +This is a placeholder. + |