diff options
Diffstat (limited to 'docs/source/docs/contents.rst')
| -rw-r--r-- | docs/source/docs/contents.rst | 61 |
1 files changed, 45 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 ----------- |