SF.net SVN: fclient: [394] trunk/sandbox/fcp2/client.py

[<jU...@us...>]

Revision: 394
          http://fclient.svn.sourceforge.net/fclient/?rev=394&view=rev
Author:   jUrner
Date:     2008-04-09 14:45:27 -0700 (Wed, 09 Apr 2008)

Log Message:
-----------
fixed docs

Modified Paths:
--------------
    trunk/sandbox/fcp2/client.py

Modified: trunk/sandbox/fcp2/client.py
===================================================================
--- trunk/sandbox/fcp2/client.py	2008-04-09 21:26:57 UTC (rev 393)
+++ trunk/sandbox/fcp2/client.py	2008-04-09 21:45:27 UTC (rev 394)
@@ -1390,11 +1390,9 @@
 		
 		@return: (str) request identifier
 		
-		@event: (L{events.Event.RequestCompleted}) triggered when the request is complete
-		@event: (L{events.Event.RequestFailed}) triggered when the request failes
-		@event: (L{events.Event.RequestFetchable}) triggered as soon as the request is fetchable
-		@event: (L{events.Event.RequestCompressing}) triggered when the request is about to be compressed
-		@event: (L{events.Event.RequestCompressed}) triggered as soon as compressing of the request is completed
+		@event: (L{events.Events.RequestCompleted}) triggered when the request is complete
+		@event: (L{events.Events.RequestFailed}) triggered when the request failes
+		@event: (L{events.Events.RequestFetchable}) triggered as soon as the request is fetchable
 		
 		filename changes or the request is modified otherwise (see L{modifyRequest})
 		
@@ -1745,20 +1743,20 @@
 		@param dontCompress: (bool) if True, the node won't try to compress the data
 		@param maxRetries: (int) maximum number of retries  or -1 to retry forver or None to leave it to the node to decide
 		@param priorityClass: (L{consts.Priority}) priority of the request
-		@paramtargetFilename: (str) filename to append to the key (may not contain slashes)
+		@param targetFilename: (str) filename to append to the key (may not contain slashes)
 		
 		@param userData: any non persistent data to associate to the request
 		@param persistentUserData: any string to associate to the request as persistent data
 		
-		@event: (L{events.Event.RequestCompleted}) triggered when the request is complete
-		@event: (L{events.Event.RequestFailed}) triggered when the request failes
-		@event: (L{events.Event.RequestFetchable}) triggered as soon as the request is fetchable
-		@event: (L{events.Event.RequestCompressing}) triggered when the request is about to be compressed
-		@event: (L{events.Event.RequestCompressed}) triggered as soon as compressing of the request is completed
+		@event: (L{events.Events.RequestCompleted}) triggered when the request is complete
+		@event: (L{events.Events.RequestFailed}) triggered when the request failes
+		@event: (L{events.Events.RequestFetchable}) triggered as soon as the request is fetchable
+		@event: (L{events.Events.RequestCompressionStarted}) triggered when the request is about to be compressed
+		@event: (L{events.Events.RequestCompressionComopleted}) triggered as soon as compressing of the request is completed
 		
 		@note: if the upload is successful the node will create a L{consts.KeyType.CHK} key under wich
 		the data can be retreieved. The key can be accessed as 'URI' member of the request as soon
-		as the 	L{events.Event.RequestFetchable} or the L{events.Event.RequestCompleted} event
+		as the 	L{events.Events.RequestFetchable} or the L{events.Events.RequestCompleted} event
 		is triggered.
 		
 		@todo: EarlyEncode and GetCHKOnly message params not implemented
@@ -1972,7 +1970,7 @@
 		"""Uploads data that can be updated by the owner
 		
 		@param data: (bytes) data to upload
-		@params privateKey: see: private key as generated by L{generateKeypair} + '/' + name
+		@param privateKey: see: private key as generated by L{generateKeypair} + '/' + name
 		
 		@note: for other params see L{chkPutData}
 		@note: use this method to upload updatable data. First you need to create a public / private
@@ -2369,7 +2367,7 @@
 		
 		@note: the client does not keep track of messages send to a plugin, because the plugin
 		may or may not return. If the plugin sends a reply, a L{events.PluginMessage} is triggered.
-		If something goes wrong, L{events.ProtocolError} or an is L{events.IdentifierCollision} 
+		If something goes wrong, L{events.Events.ProtocolError} or an is L{events.Events.IdentifierCollision} 
 		is triggered. Use the identifier passed to	identify responses.
 				
 		@todo: this is method not tested. Assumption: identifer does not have to be unique to


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.