From 5b7b13000f75e409138c758b29363c8d17b0fa58 Mon Sep 17 00:00:00 2001
From: elie <elie>
Date: Thu, 17 Sep 2015 06:46:15 +0000
Subject: documenting async version

---
 docs/source/docs/contents.rst                         | 19 ++++++++++++-------
 .../source/docs/v3arch/asyncore/oneliner/contents.rst |  2 +-
 .../manager/cmdgen/async-command-generator.rst        |  9 +++++++++
 .../asyncore/oneliner/manager/cmdgen/contents.rst     | 13 +++++++++++++
 4 files changed, 35 insertions(+), 8 deletions(-)
 create mode 100644 docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/async-command-generator.rst

diff --git a/docs/source/docs/contents.rst b/docs/source/docs/contents.rst
index 12568a9..48475dc 100644
--- a/docs/source/docs/contents.rst
+++ b/docs/source/docs/contents.rst
@@ -5,13 +5,12 @@ Library reference
 .. toctree::
    :maxdepth: 2
 
-As dealing with 
-many features may overwhelm developers who aim at a quick and trivial task, 
-PySNMP employs a layered architecture approach where the topmost programming 
-API tries to be as simple as possible to allow immediate solutions for most 
-common use cases. For instance it will let you perform SNMP GET/SET/WALK 
-operations by pasting code snippets from this web-site right into your 
-Python interactive session.
+As dealing with many features may overwhelm developers who aim at a 
+quick and trivial task, PySNMP employs a layered architecture approach
+where the topmost programming API tries to be as simple as possible 
+to allow immediate solutions for most common use cases. For instance
+it will let you perform SNMP GET/SET/WALK operations by pasting code
+snippets from this web-site right into your Python interactive session.
 
 .. toctree::
    /docs/v3arch/asyncore/oneliner/contents
@@ -30,6 +29,12 @@ PySNMP offers native bindings to some of these framework.
 ..   /docs/v3arch/trollius/contents
 ..   /docs/v3arch/twisted/contents
 
+All programming interfaces mentioned above revolve around the notion
+of SNMP Engine:
+
+.. toctree::
+   /docs/v3arch/snmp-engine
+
 At the other end of the complexity spectrum, PySNMP offers packet-level 
 ASN.1 data structures that let you build, parse and analyze SNMP messages 
 travelling over network. This extremely low-level programming interface is 
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/contents.rst
index 5bd2df3..5a52135 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/contents.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/contents.rst
@@ -39,7 +39,7 @@ operations as well as for rapid prototyping.
    /docs/v3arch/asyncore/oneliner/agent/ntforg/async.rst
 
 SNMP security configuration is conveyed to SNMP engine via
-:py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityName`
+:py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData`
 and :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData`
 classes:
 
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/async-command-generator.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/async-command-generator.rst
new file mode 100644
index 0000000..80bf136
--- /dev/null
+++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/async-command-generator.rst
@@ -0,0 +1,9 @@
+
+Asynchronous Command Generator
+==============================
+
+.. toctree::
+   :maxdepth: 2
+
+.. autoclass:: pysnmp.entity.rfc3413.oneliner.cmdgen.AsyncCommandGenerator
+   :members:
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst
index a72c8da..0552f0e 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst
@@ -13,3 +13,16 @@ on the Command Generator Applications.
    /docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd
    /docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd
    /docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd
+
+Asynchronous Command Generator
+==============================
+
+Implementation described in this section geared towards running
+multiple simulataneous SNMP queries on top of asynchronous
+I/O framework. Otherwise it is very similar to the Synchronous
+version.
+
+.. toctree::
+   :maxdepth: 2
+
+   /docs/v3arch/asyncore/oneliner/manager/cmdgen/async-command-generator
-- 
cgit v1.2.1