Commits

Florian Schlachter committed 11e7121

Readme improvedments

  • Participants
  • Parent commits 08dd1e7

Comments (0)

Files changed (1)

 transporting it via TCP to the remote host.
 
 Due to it's nature, cPickle is not intended to be secure. Under special
-cirmunstances (e. g. malicious messages) remote executions might be possible.
+circumstances (e. g. malicious messages) remote executions might be possible.
 Therefore you must ensure that the server is only reachable by trusted clients
 in a secure and restricted environment (a public server is therefore absolutely
-**not** recommended).
+**not** recommended).
+
+## Usage
+
+Using PyRPC is pretty simple. See `client_example.py` for client-usage. The server
+consists of two classes:
+
+ * `RPCServer`
+ * `RPCServerHandler`
+
+`RPCServer` is used to manage all client connections; the `RPCServerHandler`
+is newly instantiated for every request. It implements all provided procedures 
+to the client; the method name is prefixed by `handle_`.
+
+Within every method a procedure has access to the following instance attributes:
+
+ * `address` - contains a (ip, port)-tuple of the remote client address
+ * `data` - provides raw access to the request as a `dict`-object 
+
+See `server_example.py` for corressponding server-usage.