[Zodb-checkins] CVS: ZODB3/ZEO - ServerStub.py:1.9

[Guido van Rossum]

Update of /cvs-repository/ZODB3/ZEO
In directory cvs.zope.org:/tmp/cvs-serv30399

Modified Files:
	ServerStub.py 
Log Message:
Add some nice docstrings.


=== ZODB3/ZEO/ServerStub.py 1.8 => 1.9 ===
--- ZODB3/ZEO/ServerStub.py:1.8	Sat Sep  7 20:20:20 2002
+++ ZODB3/ZEO/ServerStub.py	Tue Oct  1 14:49:12 2002
@@ -11,14 +11,35 @@
 # FOR A PARTICULAR PURPOSE
 #
 ##############################################################################
-"""Stub for interface exposed by StorageServer"""
+"""RPC stubs for interface exported by StorageServer."""
 
 class StorageServer:
 
+    """An RPC stub class for the interface exported by ClientStorage.
+
+    This is the interface presented by the StorageServer to the
+    ClientStorage; i.e. the ClientStorage calls these methods and they
+    are executed in the StorageServer.
+
+    See the StorageServer module for documentation on these methods,
+    with the exception of _update(), which is documented here.
+    """
+
     def __init__(self, rpc):
+        """Constructor.
+
+        The argument is a connection: an instance of the
+        zrpc.connection.Connection class.
+        """
         self.rpc = rpc
 
     def _update(self):
+        """Handle pending incoming messages.
+
+        This method is typically only used when no asyncore mainloop
+        is already active.  It can cause arbitrary callbacks from the
+        server to the client to be handled.
+        """
         self.rpc.pending()
 
     def register(self, storage_name, read_only):
@@ -103,7 +124,6 @@
         return self.rpc.call('undo', trans_id)
 
     def undoLog(self, first, last):
-        # XXX filter not allowed across RPC
         return self.rpc.call('undoLog', first, last)
 
     def undoInfo(self, first, last, spec):