SF.net SVN: fclient: [149] trunk/sandbox/fcp/fcp2_0_consts.py

[<ju...@us...>]

Revision: 149
          http://fclient.svn.sourceforge.net/fclient/?rev=149&view=rev
Author:   jurner
Date:     2008-02-05 07:19:28 -0800 (Tue, 05 Feb 2008)

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

Modified Paths:
--------------
    trunk/sandbox/fcp/fcp2_0_consts.py

Modified: trunk/sandbox/fcp/fcp2_0_consts.py
===================================================================
--- trunk/sandbox/fcp/fcp2_0_consts.py	2008-02-05 12:27:53 UTC (rev 148)
+++ trunk/sandbox/fcp/fcp2_0_consts.py	2008-02-05 15:19:28 UTC (rev 149)
@@ -296,20 +296,31 @@
 
 
 class RequestStatus:
+	"""Request status flags
+	@cvar Null: no status
+	@cvar Pending: the request is not started yet
+	@cvar Compressing: the request is about to be compressed
+	@cvar Compressed: compressing is completed
+	@cvar Complete: the request is completed
+	@cvar Error: an error occured while processing ther request
+	@cvar Removed: the request is no longer present in the client (and on the nodes queue)
+	
+	@note: the FcStatus member of the params dict of a request should contain one or more
+	of the bitflags it picked up while running through the client.
+	"""
 	Null = 0x0
 	Pending = 0x1
 	Compressing = 0x2
-	Started = 0x4
-	Complete = 0x8
-	Error = 0x10
-	Removed = 0x20
-	RestoreFailed = 0x40
+	Compressed = 0x4
+	Started = 0x8
+	Complete = 0x10
+	Error = 0x20
+	Removed = 0x40
+	
 
-
 class RequestSubType:
 	"""Consts indicating the subtype of a message"""
 	
-	# some additional consts
 	Null = 0
 	GetData = 1
 	GetFile = 2
@@ -362,6 +373,9 @@
 	@cvar Identifier: the identifier has been moodified
 	@cvar PersistentUserData: thepersistent user data has been  modified
 	@cvar PriorityClass: the priority class has been modified
+	
+	@note: the FcModified member of the params dict of a request may contain
+	one or more of the bitflags
 	"""
 	Null = 0x0
 	Filename = 0x8


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