From 2f24177c361ba4d9deba2d7378f84aa96111db80 Mon Sep 17 00:00:00 2001
From: elie <elie>
Date: Mon, 14 Sep 2015 05:20:24 +0000
Subject: * synchronous oneliner apps redesigned to offer Python
 generator-based   API along with a more comprehensive set of accepted
 parameters. * massively documented (in Sphinx, NumPy style)

---
 pysnmp/entity/rfc3413/oneliner/target.py | 81 ++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)

(limited to 'pysnmp/entity/rfc3413/oneliner/target.py')

diff --git a/pysnmp/entity/rfc3413/oneliner/target.py b/pysnmp/entity/rfc3413/oneliner/target.py
index 04ecb5f..ecb7882 100644
--- a/pysnmp/entity/rfc3413/oneliner/target.py
+++ b/pysnmp/entity/rfc3413/oneliner/target.py
@@ -37,6 +37,42 @@ class _AbstractTransportTarget:
     def _resolveAddr(self, transportAddr): raise NotImplementedError()
 
 class UdpTransportTarget(_AbstractTransportTarget):
+    """Creates UDP/IPv4 configuration entry and initialize socket API if needed.
+
+    This object can be used by 
+    :py:class:`~pysnmp.entity.rfc3413.oneliner.cmdgen.AsyncCommandGenerator` or
+    :py:class:`~pysnmp.entity.rfc3413.oneliner.ntforg.AsyncNotificationOriginator`
+    and their derevatives for adding new entries to Local Configuration
+    Datastore (LCD) managed by :py:class:`~pysnmp.entity.engine.SnmpEngine`
+    class instance.
+
+    See :RFC:`1906#section-3` for more information on the UDP transport mapping.
+
+    Parameters
+    ----------
+    transportAddr : tuple
+        Indicates remote address in Python :py:mod:`socket` module format
+        which is a tuple of FQDN, port where FQDN is a string representing
+        either hostname or IPv4 address in quad-dotted form, port is an
+        integer.
+    timeout : int
+        Response timeout in seconds.
+    retries : int
+        Maximum number of request retries, 0 retries means just a single
+        request.
+    tagList : str
+        Arbitrary string that contains a list of tag values which are used
+        to select target addresses for a particular operation 
+        (:RFC:`3413#section-4.1.4`).
+
+    Examples
+    --------
+    >>> from pysnmp.entity.rfc3413.oneliner.target import UdpTransportTarget
+    >>> UdpTransportTarget(('demo.snmplabs.com', 161))
+    UdpTransportTarget(('195.218.195.228', 161), timeout=1, retries=5, tagList='')
+    >>> 
+
+    """
     transportDomain = udp.domainName
     protoTransport = udp.UdpSocketTransport
     def _resolveAddr(self, transportAddr):
@@ -50,6 +86,51 @@ class UdpTransportTarget(_AbstractTransportTarget):
             raise error.PySnmpError('Bad IPv4/UDP transport address %s: %s' % ('@'.join([ str(x) for x in transportAddr ]), sys.exc_info()[1]))
 
 class Udp6TransportTarget(_AbstractTransportTarget):
+    """Creates UDP/IPv6 configuration entry and initialize socket API if needed.
+
+    This object can be used by 
+    :py:class:`~pysnmp.entity.rfc3413.oneliner.cmdgen.AsyncCommandGenerator` or
+    :py:class:`~pysnmp.entity.rfc3413.oneliner.ntforg.AsyncNotificationOriginator`
+    and their derevatives for adding new entries to Local Configuration
+    Datastore (LCD) managed by :py:class:`~pysnmp.entity.engine.SnmpEngine`
+    class instance.
+
+    See :RFC:`1906#section-3`, :RFC:`2851#section-4` for more information
+    on the UDP and IPv6 transport mapping.
+
+    Parameters
+    ----------
+    transportAddr : tuple
+        Indicates remote address in Python :py:mod:`socket` module format
+        which is a tuple of FQDN, port where FQDN is a string representing
+        either hostname or IPv6 address in one of three conventional forms
+        (:RFC:`1924#section-3`), port is an integer.
+    timeout : int
+        Response timeout in seconds.
+    retries : int
+        Maximum number of request retries, 0 retries means just a single
+        request.
+    tagList : str
+        Arbitrary string that contains a list of tag values which are used
+        to select target addresses for a particular operation
+        (:RFC:`3413#section-4.1.4`).
+
+    Examples
+    --------
+    >>> from pysnmp.entity.rfc3413.oneliner.target import Udp6TransportTarget
+    >>> Udp6TransportTarget(('google.com', 161))
+    Udp6TransportTarget(('2a00:1450:4014:80a::100e', 161), timeout=1, retries=5, tagList='')
+    >>> Udp6TransportTarget(('FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', 161))
+    Udp6TransportTarget(('fedc:ba98:7654:3210:fedc:ba98:7654:3210', 161), timeout=1, retries=5, tagList='')
+    >>> Udp6TransportTarget(('1080:0:0:0:8:800:200C:417A', 161))
+    Udp6TransportTarget(('1080::8:800:200c:417a', 161), timeout=1, retries=5, tagList='')
+    >>> Udp6TransportTarget(('::0', 161))
+    Udp6TransportTarget(('::', 161), timeout=1, retries=5, tagList='')
+    >>> Udp6TransportTarget(('::', 161))
+    Udp6TransportTarget(('::', 161), timeout=1, retries=5, tagList='')
+    >>> 
+
+    """
     transportDomain = udp6.domainName
     protoTransport = udp6.Udp6SocketTransport
     def _resolveAddr(self, transportAddr):
-- 
cgit v1.2.1