summaryrefslogtreecommitdiff
path: root/docs/source/examples/v3arch/asyncio/contents.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/examples/v3arch/asyncio/contents.rst')
-rw-r--r--docs/source/examples/v3arch/asyncio/contents.rst63
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/source/examples/v3arch/asyncio/contents.rst b/docs/source/examples/v3arch/asyncio/contents.rst
new file mode 100644
index 0000000..c668f2f
--- /dev/null
+++ b/docs/source/examples/v3arch/asyncio/contents.rst
@@ -0,0 +1,63 @@
+
+SNMP with Asynio
+================
+
+Python 3.4 introduced a new module - `asyncio <https://docs.python.org/3/library/asyncio.html>`_ (former Tulip,
+PEP 3156) featuring infrastructure for writing single-threaded concurrent
+code using coroutines, multiplexing I/O access over sockets and other
+resources.
+
+PySNMP library was originally built on top of Python's asynchronous I/O
+library called asyncio. The asyncio module offers similar functionality
+but uses much more modern and powerful language facilities. Functionally,
+asyncio can replace asyncio in PySNMP however its use requires understanding
+the concepts such as coroutines and generators. If your task is to embed SNMP
+stack into an existing asyncio-based app, using PySNMP's asyncio interfaces
+greatly simplifies the task.
+
+Older applications (Python 2.6+) can alternatively use
+`Trollius <http://trollius.readthedocs.org/>`_ instead of asyncio. Trollius
+is a backport of asyncio so it `supports </examples/current/v3arch/trollius/index.html>`_ nearly the same API as asyncio. Full support of both modules is
+built into pysnmp.
+
+All SNMP-related functionality of Native PySNMP API to Standard SNMP
+Applications (`RFC3413 <https://tools.ietf.org/html/rfc3413>`_)
+remains available to asyncio-backed applications.
+
+Command Generator Applications
+------------------------------
+
+.. toctree::
+
+ /examples/v3arch/asyncio/manager/cmdgen/snmp-versions
+ /examples/v3arch/asyncio/manager/cmdgen/modifying-variables
+ /examples/v3arch/asyncio/manager/cmdgen/walking-operations
+ /examples/v3arch/asyncio/manager/cmdgen/transport-tweaks
+
+
+Command Responder Applications
+------------------------------
+
+.. toctree::
+
+ /examples/v3arch/asyncio/agent/cmdrsp/snmp-versions
+
+Notification Originator Applications
+------------------------------------
+
+.. toctree::
+
+ /examples/v3arch/asyncio/agent/ntforg/common-notifications
+
+
+Notification Receiver Applications
+----------------------------------
+
+.. toctree::
+
+ /examples/v3arch/asyncio/manager/ntfrcv/transport-tweaks
+
+For more details on PySNMP programming model and interfaces, please
+refer to the documentation
+
+