Commit ddbd0185 authored by Guido van Rossum's avatar Guido van Rossum

Add some nice docstrings.

parent 1471dc55
...@@ -11,14 +11,35 @@ ...@@ -11,14 +11,35 @@
# FOR A PARTICULAR PURPOSE # FOR A PARTICULAR PURPOSE
# #
############################################################################## ##############################################################################
"""Stub for interface exposed by StorageServer""" """RPC stubs for interface exported by StorageServer."""
class 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): def __init__(self, rpc):
"""Constructor.
The argument is a connection: an instance of the
zrpc.connection.Connection class.
"""
self.rpc = rpc self.rpc = rpc
def _update(self): 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() self.rpc.pending()
def register(self, storage_name, read_only): def register(self, storage_name, read_only):
...@@ -103,7 +124,6 @@ class StorageServer: ...@@ -103,7 +124,6 @@ class StorageServer:
return self.rpc.call('undo', trans_id) return self.rpc.call('undo', trans_id)
def undoLog(self, first, last): def undoLog(self, first, last):
# XXX filter not allowed across RPC
return self.rpc.call('undoLog', first, last) return self.rpc.call('undoLog', first, last)
def undoInfo(self, first, last, spec): def undoInfo(self, first, last, spec):
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment