Changeset 2885 for TI12-security/trunk/python/ndg.security.common/ndg/security/common/m2CryptoSSLUtility.py

Timestamp:

14/09/07 09:41:25 (13 years ago)

Author:

pjkersha

Message:

ndg.security.common/ndg/security/common/m2CryptoSSLUtility.py:

• added defReadTimeout and defWriteTimeout class vars
• and pydoc

File:

• TI12-security/trunk/python/ndg.security.common/ndg/security/common/m2CryptoSSLUtility.py (modified) (3 diffs)

TI12-security/trunk/python/ndg.security.common/ndg/security/common/m2CryptoSSLUtility.py

@@ -116 +116 @@
 
 class HTTPSConnection(_HTTPSConnection):
-
+    """Modified version of M2Crypto equivalent to enable custom checks with
+    the peer and timeout settings
+    
+    @type defReadTimeout: M2Crypto.SSL.timeout
+    @cvar defReadTimeout: default timeout for read operations
+    @type defWriteTimeout: M2Crypto.SSL.timeout
+    @cvar defWriteTimeout: default timeout for write operations"""    
+    defReadTimeout = SSL.timeout(sec=3.)
+    defWriteTimeout = SSL.timeout(sec=3.)
+    
     def __init__(self, *args, **kw):
         '''Overload to enable setting of post connection check
-        callback to SSL.Connection'''
+        callback to SSL.Connection
+        
+        type *args: tuple
+        param *args: args which apply to M2Crypto.httpslib.HTTPSConnection
+        type **kw: dict
+        param **kw: additional keywords - postConnectionCheck - set class for
+        checking peer, readTimeout - M2Crypto.SSL.timeout instance - set 
+        timeout for read, similarly writeTimeout'''
+        
         if 'postConnectionCheck' in kw:
             self._postConnectionCheck = kw['postConnectionCheck']
@@ -133 +150 @@
             del kw['readTimeout']
         else:
-            self.readTimeout = SSL.timeout(sec=3.) 
+            self.readTimeout = HTTPSConnection.defReadTimeout
               
         if 'writeTimeout' in kw:
@@ -142 +159 @@
             del kw['writeTimeout']
         else:
-            self.writeTimeout = SSL.timeout(sec=3.)
+            self.writeTimeout = HTTPSConnection.defWriteTimeout
             
         _HTTPSConnection.__init__(self, *args, **kw)