summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorelie <elie>2015-09-27 11:47:50 +0000
committerelie <elie>2015-09-27 11:47:50 +0000
commit47924797214dd70ca948b93e487df0ec5a7b579f (patch)
tree7ee907c311361b5f751337e4a69e4c2b894bccd8
parent958f4ae17d92b10efe9c3d8debec5c3c31598778 (diff)
downloadpysnmp-47924797214dd70ca948b93e487df0ec5a7b579f.tar.gz
another rearrangementHEADoriginmaster
-rw-r--r--docs/source/docs/contents.rst61
-rw-r--r--docs/source/docs/hlapi/asyncore/sync/agent/ntforg/notification.rst8
-rw-r--r--docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd.rst8
-rw-r--r--docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/getcmd.rst8
-rw-r--r--docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd.rst8
-rw-r--r--docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/setcmd.rst8
6 files changed, 85 insertions, 16 deletions
diff --git a/docs/source/docs/contents.rst b/docs/source/docs/contents.rst
index d2447f1..ce11a00 100644
--- a/docs/source/docs/contents.rst
+++ b/docs/source/docs/contents.rst
@@ -13,6 +13,11 @@ It will let you perform SNMP GET/SET/WALK and TRAP/INFORM operations by
pasting code snippets from PySNMP documentation and example scripts
right into your Python interactive session.
+Most of SNMP operations involve packet exchange over network. PySNMP
+is shipped with a set of bindings to popular asynchronous Python I/O
+frameworks that let you run PySNMP in parallel with other tasks your
+application may perform.
+
Synchronous SNMP
----------------
@@ -25,29 +30,31 @@ Command Generator
.. toctree::
:maxdepth: 2
- /docs/hlapi/asyncore/manager/cmdgen/getcmd
- /docs/hlapi/asyncore/manager/cmdgen/setcmd
- /docs/hlapi/asyncore/manager/cmdgen/nextcmd
- /docs/hlapi/asyncore/manager/cmdgen/bulkcmd
+ /docs/hlapi/asyncore/sync/manager/cmdgen/getcmd
+ /docs/hlapi/asyncore/sync/manager/cmdgen/setcmd
+ /docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd
+ /docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd
Notification Originator
.. toctree::
:maxdepth: 2
- /docs/hlapi/asyncore/agent/ntforg/notification
+ /docs/hlapi/asyncore/sync/agent/ntforg/notification
Transport configuration
++++++++++++++++++++++++
+
+The following shortcut classes convey configuration information to
+SNMP engine's Local Configuration Datastore (:RFC:`2271#section-3.4.2`)
+as well as to underlying socket API. Once committed to LCD, SNMP engine
+saves its configuration for the lifetime of SNMP engine object.
.. toctree::
:maxdepth: 2
- /docs/hlapi/asyncore/transport-configuration
-
-Most of SNMP operations involve packet exchange over network. PySNMP
-is shipped with a set of bindings to popular asynchronous Python I/O
-frameworks that let you run PySNMP in parallel with other tasks your
-application may perform.
+.. autoclass:: pysnmp.hlapi.UdpTransportTarget
+.. autoclass:: pysnmp.hlapi.Udp6TransportTarget
Asynchronous: asyncore
----------------------
@@ -56,11 +63,31 @@ The :mod:`asyncore` module is in Python standard library since ancient
times. Main loop is built around :mod:`select` dispatcher, user
code is invoked through callback callables.
+Command Generator
+
.. toctree::
:maxdepth: 2
- /docs/hlapi/asyncore/manager/cmdgen/async-command-generator
- /docs/hlapi/asyncore/agent/ntforg/async-notification-originator
+ /docs/hlapi/asyncore/manager/cmdgen/getcmd
+ /docs/hlapi/asyncore/manager/cmdgen/setcmd
+ /docs/hlapi/asyncore/manager/cmdgen/nextcmd
+ /docs/hlapi/asyncore/manager/cmdgen/bulkcmd
+
+Notification Originator
+
+.. toctree::
+ :maxdepth: 2
+
+ /docs/hlapi/asyncore/agent/ntforg/notification
+
+Transport configuration
++++++++++++++++++++++++
+
+.. toctree::
+ :maxdepth: 2
+
+.. autoclass:: pysnmp.hlapi.asyncore.UdpTransportTarget
+.. autoclass:: pysnmp.hlapi.asyncore.Udp6TransportTarget
.. _asyncio:
@@ -90,11 +117,13 @@ Notification Originator
/docs/hlapi/asyncio/agent/ntforg/notification
Transport configuration
++++++++++++++++++++++++
.. toctree::
:maxdepth: 2
- /docs/hlapi/asyncio/transport-configuration
+.. autoclass:: pysnmp.hlapi.asyncio.UdpTransportTarget
+.. autoclass:: pysnmp.hlapi.asyncio.Udp6TransportTarget
.. _trollius:
@@ -137,12 +166,12 @@ Notification Originator
/docs/hlapi/twisted/agent/ntforg/notification
Transport configuration
++++++++++++++++++++++++
.. toctree::
:maxdepth: 2
- /docs/hlapi/twisted/transport-configuration
-
+.. autoclass:: pysnmp.hlapi.twisted.UdpTransportTarget
SNMP Engine
-----------
diff --git a/docs/source/docs/hlapi/asyncore/sync/agent/ntforg/notification.rst b/docs/source/docs/hlapi/asyncore/sync/agent/ntforg/notification.rst
new file mode 100644
index 0000000..619b13d
--- /dev/null
+++ b/docs/source/docs/hlapi/asyncore/sync/agent/ntforg/notification.rst
@@ -0,0 +1,8 @@
+
+TRAP/INFORM notification
+========================
+
+.. toctree::
+ :maxdepth: 2
+
+.. autofunction:: pysnmp.hlapi.sendNotification
diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd.rst
new file mode 100644
index 0000000..5791755
--- /dev/null
+++ b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd.rst
@@ -0,0 +1,8 @@
+
+GETBULK command
+===============
+
+.. toctree::
+ :maxdepth: 2
+
+.. autofunction:: pysnmp.hlapi.bulkCmd
diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/getcmd.rst
new file mode 100644
index 0000000..8d344e9
--- /dev/null
+++ b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/getcmd.rst
@@ -0,0 +1,8 @@
+
+GET command
+===========
+
+.. toctree::
+ :maxdepth: 2
+
+.. autofunction:: pysnmp.hlapi.getCmd
diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd.rst
new file mode 100644
index 0000000..6b8dd6b
--- /dev/null
+++ b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd.rst
@@ -0,0 +1,8 @@
+
+GETNEXT command
+===============
+
+.. toctree::
+ :maxdepth: 2
+
+.. autofunction:: pysnmp.hlapi.nextCmd
diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/setcmd.rst
new file mode 100644
index 0000000..09e6ad5
--- /dev/null
+++ b/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/setcmd.rst
@@ -0,0 +1,8 @@
+
+SET command
+===========
+
+.. toctree::
+ :maxdepth: 2
+
+.. autofunction:: pysnmp.hlapi.setCmd