summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorelie <elie>2015-09-27 19:18:10 +0000
committerelie <elie>2015-09-27 19:18:10 +0000
commit2c4c4598c1188a76e955a48f7d222897e446a216 (patch)
treee3887aa07f790c3cc3def638b558aa852a33325f /docs
parent6a494e2e72309dd80e0985ac2cccadd3634351cd (diff)
downloadpysnmp-git-2c4c4598c1188a76e955a48f7d222897e446a216.tar.gz
cleanup
Diffstat (limited to 'docs')
-rw-r--r--docs/source/docs/contents.rst8
-rw-r--r--docs/source/examples/contents.rst45
-rw-r--r--docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst11
-rw-r--r--docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst11
-rw-r--r--docs/source/examples/hlapi/trollius/contents.rst2
-rw-r--r--docs/source/quick-start.rst8
6 files changed, 44 insertions, 41 deletions
diff --git a/docs/source/docs/contents.rst b/docs/source/docs/contents.rst
index ce11a003..8781df6f 100644
--- a/docs/source/docs/contents.rst
+++ b/docs/source/docs/contents.rst
@@ -89,8 +89,6 @@ Transport configuration
.. autoclass:: pysnmp.hlapi.asyncore.UdpTransportTarget
.. autoclass:: pysnmp.hlapi.asyncore.Udp6TransportTarget
-.. _asyncio:
-
Asynchronous: asyncio
---------------------
@@ -125,20 +123,16 @@ Transport configuration
.. autoclass:: pysnmp.hlapi.asyncio.UdpTransportTarget
.. autoclass:: pysnmp.hlapi.asyncio.Udp6TransportTarget
-.. _trollius:
-
Asynchronous: trollius
----------------------
-An almost compatible alternative to :ref:`asyncio` for pre-3.3 Python
+An almost compatible alternative to *asyncio* for pre-3.3 Python
is `Trollius <http://trollius.readthedocs.org>`_ module. PySNMP's
`asyncio` bindings automatically work with Trolleus.
Please refer to :doc:`Trollius examples </examples/contents>` for
more information.
-.. _twisted:
-
Asynchronous: Twisted
---------------------
diff --git a/docs/source/examples/contents.rst b/docs/source/examples/contents.rst
index a7c1f29d..20e3053b 100644
--- a/docs/source/examples/contents.rst
+++ b/docs/source/examples/contents.rst
@@ -73,15 +73,48 @@ framework being used.
Packet-level SNMP
-----------------
-Low-level API that lets you build SNMP messages from Python
-objects and exchange them through asyncore transport (or you could
-write your own). These interfaces are very low-level and aimed at
-a rather specific programming tasks.
+In cases where performance is your top priority and you only need to
+work with SNMP v1 and v2c systems and you do not mind writing much
+more code, then there is a low-level API to SNMP v1/v2c PDU and
+PySNMP I/O engine. There's practically no SNMP engine or SMI
+infrastructure involved in the operations of these almost wire-level
+interfaces. Although MIB services can still be used separately.
+
+A packet-level API-based application typically manages both SNMP
+message building/parsing and network communication via one or more
+transports. It's fully up to the application to handle failures on
+message and transport levels.
+
+Command Generator
++++++++++++++++++
+
+.. toctree::
+
+ /examples/v1arch/asyncore/manager/cmdgen/fetching-variables
+ /examples/v1arch/asyncore/manager/cmdgen/modifying-variables
+ /examples/v1arch/asyncore/manager/cmdgen/walking-operations
+ /examples/v1arch/asyncore/manager/cmdgen/transport-tweaks
+
+Command Responder
++++++++++++++++++
+
+.. toctree::
+
+ /examples/v1arch/asyncore/agent/cmdrsp/agent-side-mib-implementations
+
+Notification Originator
++++++++++++++++++++++++
+
+.. toctree::
+
+ /examples/v1arch/asyncore/agent/ntforg/transport-tweaks
+
+Notification Receiver
++++++++++++++++++++++
.. toctree::
- :maxdepth: 2
- /examples/v1arch/asyncore/contents
+ /examples/v1arch/asyncore/manager/ntfrcv/transport-tweaks
Using these examples
--------------------
diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst
index 415e86ac..f8fd26ab 100644
--- a/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst
+++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst
@@ -4,17 +4,6 @@
Walking operations
------------------
-.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py
- :start-after: """
- :end-before: """#
-
-.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py
- :start-after: """#
- :language: python
-
-:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py>` script.
-
-
.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py
:start-after: """
:end-before: """#
diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst
index dcd8fbe8..99f89f89 100644
--- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst
+++ b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst
@@ -4,17 +4,6 @@
Walking operations
------------------
-.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/async-pull-mibs-from-multiple-agents-at-once.py
- :start-after: """
- :end-before: """#
-
-.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/async-pull-mibs-from-multiple-agents-at-once.py
- :start-after: """#
- :language: python
-
-:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/async-pull-mibs-from-multiple-agents-at-once.py>` script.
-
-
.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py
:start-after: """
:end-before: """#
diff --git a/docs/source/examples/hlapi/trollius/contents.rst b/docs/source/examples/hlapi/trollius/contents.rst
index 52a1d168..1424c7d0 100644
--- a/docs/source/examples/hlapi/trollius/contents.rst
+++ b/docs/source/examples/hlapi/trollius/contents.rst
@@ -38,7 +38,6 @@ More examples on Command Generator API usage follow.
/examples/hlapi/trollius/manager/cmdgen/snmp-versions
/examples/hlapi/trollius/manager/cmdgen/walking-operations
- /examples/hlapi/trollius/manager/cmdgen/advanced-topics
Sending SNMP TRAP's and INFORM's is as easy with PySNMP library.
The following code sends SNMP TRAP:
@@ -56,7 +55,6 @@ More examples on Notification Originator API usage follow.
.. toctree::
/examples/hlapi/trollius/agent/ntforg/common-notifications
- /examples/hlapi/trollius/agent/ntforg/advanced-topics
More sophisticated or less popular SNMP operations can still be performed
with PySNMP through its Native API to Standard SNMP Applications.
diff --git a/docs/source/quick-start.rst b/docs/source/quick-start.rst
index 9e14c03f..b79892b9 100644
--- a/docs/source/quick-start.rst
+++ b/docs/source/quick-start.rst
@@ -17,11 +17,11 @@ So just cut&paste the following code right into your Python prompt. The
code will performs SNMP GET operation for a sysDescr.0 object at a
publically available SNMP Agent at **demo.snmplabs.com**:
-.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py
+.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py
:start-after: """#
:language: python
-:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py>` script.
+:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py>` script.
If everything works as it should you will get:
@@ -39,11 +39,11 @@ Send SNMP TRAP
To send a trivial TRAP message to your local Notification Receiver
just cut&paste the following code into your interactive Python session:
-.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py
+.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py
:start-after: """#
:language: python
-:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py>` script.
+:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py>` script.
For more sophisticated examples and use cases please refer to
:doc:`examples <examples/contents>` and :doc:`library reference <docs/contents>`