[Nym3-commit] r433 - trunk/nymbaron/Server

[jr at conuropsis.org]

Author: jr
Date: 2005-12-02 00:43:08 +0100 (Fri, 02 Dec 2005)
New Revision: 433

Modified:
   trunk/nymbaron/Server/User.py
Log:
- add documentation to User.py [server]


Modified: trunk/nymbaron/Server/User.py
===================================================================
--- trunk/nymbaron/Server/User.py	2005-11-30 10:47:39 UTC (rev 432)
+++ trunk/nymbaron/Server/User.py	2005-12-01 23:43:08 UTC (rev 433)
@@ -108,7 +108,32 @@
     return ec == 0
     
 class User:
-    """Hold user data"""
+    """Hold user data. Specifically, this means:
+	
+	- username is the nym of the account. It is used to reference the
+	  account, but also as localpart of the email adress of the nym account.
+	- received is the list of received messages that have not been
+	  acknowledged yet.
+	- nSurbs is a upper bound on the number of surbs that can be used to
+	  send command messages to the nymholder
+	- seqNo is the index that will be given to the next message received by
+	  this nym account. It is included in the synopsis of the message and
+	  incremented after that. Starts at 0.
+	- idKey is the identification key of the nymholder (used to verify
+	  signatures)
+	- encKey is the encryption key of the nymholder (used to encrypt
+	  messages)
+	- usage is the volume of data in the account on the server
+	- quota is the maximum volume of data in the account on the server
+	- index is a dixtionary mid -> (time, status) where time is the time at
+	  which the message was received, and status describes the status of the
+	  message (whereas synopsis was sent, wheres message has been
+	  deleted...)
+	- mbox is a dictionary mid -> encrypted message
+	- syn is a list of (l, status, content) where l is the list of mids
+	  whose synopsis is in the content, status tells whether the content is
+	  encrypted or not and content contains the synopsis or encrypted
+	  synopses"""
     def __init__(self, username, config, create = 0):
         """0 : load user data throw an error if the user doesn't exist
         1 : create user data throw an error if the user exists