is_alive() method

Author: mirceaulinic

pyIOSXR/exceptions.py

@@ -23,7 +23,7 @@ class IOSXRException(Exception):
 
     def __init__(self, msg=None, dev=None):
 
-        super(Exception, self).__init__(msg)
+        super(IOSXRException, self).__init__(msg)
         if dev:
             self._xr = dev
             # release the XML agent
@@ -34,7 +34,11 @@ def __init__(self, msg=None, dev=None):
 class ConnectError(IOSXRException):
     """Exception while openning the connection."""
 
-    pass
+    def __init__(self, msg=None, dev=None):
+        super(ConnectError, self).__init__(msg=msg, dev=dev)
+        if dev:
+            self._xr = dev
+            self._xr._xml_agent_alive = False
 
 
 class CommitError(IOSXRException):

pyIOSXR/iosxr.py

@@ -91,6 +91,7 @@ def __init__(self,
         self.locked = False
         self._cli_prompt = None
         self._xml_agent_locker = Lock()
+        self._xml_agent_alive = False
 
     def __getattr__(self, item):
         """
@@ -155,6 +156,7 @@ def open(self):
                                          username=self.username,
                                          password=self.password)
             self.device.timeout = self.timeout
+            self._xml_agent_alive = True  # successfully open thus alive
         except NetMikoTimeoutException as t_err:
             raise ConnectError(t_err.message)
         except NetMikoAuthenticationException as au_err:
@@ -164,6 +166,12 @@ def open(self):
 
         self._enter_xml_mode()
 
+    def is_alive(self):
+        """
+        Returns the XML agent connection state.
+        """
+        return self._xml_agent_alive
+
     def _timeout_exceeded(self, start=None, msg='Timeout exceeded!'):
         if not start:
             return False  # reference not specified, noth to compare => no error

setup.py

@@ -28,7 +28,7 @@
 # e.g. ['django==1.5.1', 'mezzanine==1.4.6']
 reqs = [str(ir.req) for ir in install_reqs]
 
-version = '0.25'
+version = '0.26'
 
 setup(
     name='pyIOSXR',