summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorelie <elie>2015-09-18 05:59:01 +0000
committerelie <elie>2015-09-18 05:59:01 +0000
commit45355ded422185b96b41ee72f283eea764cbe0da (patch)
treeb7f062c7a168bfe01fe1b04b3b2da50896d6a985 /docs
parent69c5618398ac723f1e26f455aec56cd9dc51b789 (diff)
downloadpysnmp-45355ded422185b96b41ee72f283eea764cbe0da.tar.gz
started documenting base types
Diffstat (limited to 'docs')
-rw-r--r--docs/source/docs/contents.rst6
-rw-r--r--docs/source/docs/snmp-data-types.rst16
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/source/docs/contents.rst b/docs/source/docs/contents.rst
index 48475dc..ddde9cf 100644
--- a/docs/source/docs/contents.rst
+++ b/docs/source/docs/contents.rst
@@ -35,6 +35,12 @@ of SNMP Engine:
.. toctree::
/docs/v3arch/snmp-engine
+SNMP represents the information is manages in form of values belonging to
+a set of types.
+
+.. toctree::
+ /docs/snmp-data-types
+
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/snmp-data-types.rst b/docs/source/docs/snmp-data-types.rst
new file mode 100644
index 0000000..63d2f1a
--- /dev/null
+++ b/docs/source/docs/snmp-data-types.rst
@@ -0,0 +1,16 @@
+
+SNMP data types
+===============
+
+SNMP represents real-world objects it serves along with their
+states in form of values. Those values each belong to one
+of SNMP types (:RFC:`1902#section-2`) which, in turn, are based
+on *ASN.1* data description language. PySNMP types are derived
+from `Python ASN.1 types <http://pyasn1.sf.net>`_ implementation.
+
+.. toctree::
+ :maxdepth: 2
+
+.. autoclass:: pysnmp.proto.rfc1902.Integer(initializer)
+.. autoclass:: pysnmp.proto.rfc1902.Integer32(initializer)
+