r5191 - trunk/gnue-common/src/rpc

[jan]

Author: jan
Date: 2004-02-28 14:04:30 -0600 (Sat, 28 Feb 2004)
New Revision: 5191

Modified:
   trunk/gnue-common/src/rpc/GCommBase.py
Log:
docstrings + visual cleanup


Modified: trunk/gnue-common/src/rpc/GCommBase.py
===================================================================
--- trunk/gnue-common/src/rpc/GCommBase.py      2004-02-28 14:55:26 UTC (rev 
5190)
+++ trunk/gnue-common/src/rpc/GCommBase.py      2004-02-28 20:04:30 UTC (rev 
5191)
@@ -33,26 +33,42 @@
 import string, sys, thread
 
 
-
 ##############################################################################
 #
 # ClientAdapter
 #
 class Client:
+  """basic client adapter"""
   def request(self, service, params={}):
     pass
 
   def close():
+    """
+    Close the connection to the server
+    """
     pass
 
   def runMethod(self, method, path, *args, **params):
+    """
+    execute a remote method
+    """
     pass
 
   def setLocalArgumentChecking(self,enable):
+    """
+    Enable/Disable local argument checking. If enabled the client will check
+    the number and the type of parameter before they are passed to the server.
+
+    If this feature isn't supported by the driver, an exception will be raised.
+    """
     pass
 
   # Try to shut our services down
   def __del__(self):
+    """
+    If the client adapter is deleted manually or by the garbage collector,
+    the connection is closed down.
+    """
     try:
       self.close()
     except:
@@ -142,16 +158,14 @@
     except KeyError, mesg:
       raise AttributeError, mesg
 
-
   def __setattr__(self, attr, value):
     if attr[0] == '_':
       self.__dict__[attr] = value
     else:
       raise GComm.ProgrammingError
 
-
-
-
   def __call__(self, *args, **params):
     return self._adapter.runMethod(string.join(self._attrPath,'.'),
                                   *args, **params)
+
+