SF.net SVN: fclient: [125] trunk/sandbox/fcp/fcp2_0_types.py
Status: Pre-Alpha
Brought to you by:
jurner
Menu
▾
▴
SF.net SVN: fclient: [125] trunk/sandbox/fcp/fcp2_0_types.py
|
From: <ju...@us...> - 2008-02-03 13:13:51
|
Revision: 125
http://fclient.svn.sourceforge.net/fclient/?rev=125&view=rev
Author: jurner
Date: 2008-02-03 05:13:56 -0800 (Sun, 03 Feb 2008)
Log Message:
-----------
beautifications
Modified Paths:
--------------
trunk/sandbox/fcp/fcp2_0_types.py
Modified: trunk/sandbox/fcp/fcp2_0_types.py
===================================================================
--- trunk/sandbox/fcp/fcp2_0_types.py 2008-02-03 13:13:25 UTC (rev 124)
+++ trunk/sandbox/fcp/fcp2_0_types.py 2008-02-03 13:13:56 UTC (rev 125)
@@ -186,10 +186,10 @@
#
#***************************************************************************************
class ConfigMessageParams(object):
-
- ComponentsSep = '.'
+ """Parameter --> FcpType mapping for config related messages"""
-
+ ComponentSep = '.'
+
# first component of a config message param is always the param class
ParamClassCurrent = 'current'
@@ -208,9 +208,7 @@
ParamClassShortDescription,
ParamClassLongDescription,
)
-
-
-
+
# all known config keys (param class stripped)
Params = {
@@ -220,8 +218,7 @@
'console.enabled': FcpTypeBool,
'console.port': FcpTypeIPort,
'console.ssl': FcpTypeBool,
-
-
+
'fcp.allowedHosts': FcpTypeIPList,
'fcp.allowedHostsFullAccess': FcpTypeIPList,
'fcp.assumeDownloadDDAIsAllowed': FcpTypeBool,
@@ -233,8 +230,7 @@
'fcp.persistentDownloadsInterval': FcpTypeIntWithBounds(0, None),
'fcp.port': FcpTypeIPort,
'fcp.ssl': FcpTypeBool,
-
-
+
'fproxy.CSSOverride': FcpTypeBool,
'fproxy.advancedModeEnabled': FcpTypeBool,
'fproxy.allowedHosts': FcpTypeIPList,
@@ -247,18 +243,16 @@
'fproxy.port': FcpTypeIPort,
'fproxy.showPanicButton': FcpTypeBool,
'fproxy.ssl': FcpTypeBool,
-
-
+
'logger.dirname': FcpTypeDirname,
'logger.enabled': FcpTypeBool,
'logger.interval': FcpType, # ??? 1HOUR ??
'logger.maxCachedBytes': FcpTypeNumBytes,
- 'logger.maxCachedLines': FcpTypeNumBytes, # ???
+ 'logger.maxCachedLines': FcpTypeNumBytes, # ???
'logger.maxZippedLogsSize': FcpTypeNumBytes, # ???
'logger.priority': FcpTypeChoiceLoggerPriority,
'logger.priorityDetail': FcpType, # ???? is it Detailed priority thresholds ???
-
-
+
'node.alwaysAllowLocalAddresses': FcpTypeBool,
'node.assumeNATed': FcpTypeBool,
'node.bindTo': FcpTypeIP,
@@ -290,11 +284,9 @@
'node.tempIPAddressHint': FcpTypeIP, # ???
'node.testingDropPacketsEvery': FcpTypeIntWithBounds(0, None),
'node.uploadAllowedDirs': FcpTypeChoiceNodeDownloadAllowedDirs,
-
-
- 'node.testnet.enabled': FcpTypeBool,
-
+ 'node.testnet.enabled': FcpTypeBool,
+
'node.load.aggressiveGC': FcpType, # ???
'node.load.freeHeapBytesThreshold': FcpTypeNumBytes,
'node.load.freeHeapPercentThreshold': FcpTypePercent,
@@ -302,7 +294,6 @@
'node.load.nodeThrottleFile': FcpTypeFilename,
'node.load.threadLimit': FcpTypeIntWithBounds(0, None),
-
'node.opennet.acceptSeedConnections': FcpTypeBool,
'node.opennet.alwaysAllowLocalAddresses': FcpTypeBool,
'node.opennet.assumeNATed': FcpTypeBool,
@@ -324,11 +315,9 @@
'node.updater.extURI': FcpTypeUri,
'node.updater.revocationURI': FcpTypeUri,
-
'pluginmanager.loadplugin': FcpTypeStringList,
'pluginmanager2.loadedPlugins': FcpTypeStringList,
-
-
+
'ssl.sslEnable': FcpTypeBool,
'ssl.sslKeyPass': FcpTypeString,
'ssl.sslKeyStore': FcpTypeFilename,
@@ -336,22 +325,32 @@
'ssl.sslVersion': FcpTypeChoiceSSLVersion,
'toadletsymlinker.symlinks': FcpTypeStringList,
-
}
-
def __init__(self):
pass
-
def splitAll(self, paramName):
- return paramName.split(self.ComponentsSep)
+ """Splits a parameter name into its components
+ @param (str) paramName: parameter name to split
+ @return: (list) components
+ """
+ return paramName.split(self.ComponentSep)
+
def splitParamClass(self, paramName):
- return paramName.split(self.ComponentsSep, 1)
+ """Splits the parameter class from a parameter name
+ @param (str) paramName: parameter name to split
+ @return: (tuple) paramClass, tail
+ """
+ return paramName.split(self.ComponentSep, 1)
def get(self, paramName, default=None):
+ """Returns the type of a parameter or default
+ @param paramName: (str) name of the parameter to retuen the type for
+ @return: (FcpType)
+ """
try:
return self[paramName]
except KeyError:
@@ -359,6 +358,10 @@
def __getitem__(self, paramName):
+ """Returns the type of a parameter
+ @param paramName: (str) name of the parameter to retuen the type for
+ @return: (FcpType)
+ """
paramClass, paramKey = self.splitParamClass(paramName)
if paramClass == self.ParamClassCurrent:
return self.Params[paramKey]
@@ -387,8 +390,7 @@
PeerMessageParams = {
'ark.number': FcpTypeInt,
'auth.negTypes': FcpTypeInt,
-
-
+
'location': FcpTypeFloat,
'opennet': FcpTypeBool,
'testnet': FcpTypeBool,
@@ -440,8 +442,7 @@
'location': FcpTypeFloat,
'opennet': FcpTypeBool,
'testnet': FcpTypeBool,
-
-
+
'volatile.allocatedJavaMemory': FcpTypeInt,
'volatile.availableCPUs': FcpTypeInt,
'volatile.averagePingTime': FcpTypeFloat,
@@ -527,14 +528,14 @@
>>all other NodeData message params here....
>>
>> physical.udp=000.000.000.000:00000
->> dsaPubKey.y=GgrpsNUK9m.................................................
+>> dsaPubKey.y=GarpsNUKe.................................................
>> version=Fred,0.7,1.0,1107
>> myName=whatever
>> ark.pubURI=SSK@...............
>> dsaGroup.q=ALFDNoq.....
>> dsaGroup.p=AIYIrE9VNhM3.............
->> volatile.avgConnectedPeersPerNode=15.35................
+>> volatile.avgConnectedPeersPerNode=00.00................
>> dsaGroup.g=UaRa.............
>> dsaPrivKey.x=Pwam..................
>> ark.privURI=SSK@.................
@@ -553,93 +554,111 @@
MessageParamTypes = {
# client messages
-
+ #
+ #'AddPeer': # added later as PeerMessageParams
+ 'ClientGet': {
+ 'BinaryBlob': FcpTypeBool,
+ 'Global': FcpTypeBool,
+ 'IgnoreDS': FcpTypeBool,
+ 'DSOnly': FcpTypeBool,
+ 'MaxSize': FcpTypeInt,
+ 'MaxTempSize': FcpTypeInt,
+ 'Verbosity': FcpTypeInt,
+ },
+ 'ClientPut': {
+ 'BinaryBlob': FcpTypeBool,
+ 'DontCompress': FcpTypeBool,
+ 'EarlyEncode': FcpTypeBool,
+ 'GetCHKOnly': FcpTypeBool,
+ 'Global': FcpTypeBool,
+ 'MaxRetries': FcpTypeInt,
+ 'Verbosity': FcpTypeInt,
+ },
+ 'GetConfig': {
+ 'WithCurrent': FcpTypeBool,
+ 'WithDefaults': FcpTypeBool,
+ 'WithSortOrder': FcpTypeBool,
+ 'WithExpertFlag': FcpTypeBool,
+ 'WithForceWriteFlag': FcpTypeBool,
+ 'WithShortDescription': FcpTypeBool,
+ 'WithLongDescription': FcpTypeBool,
+ },
+ 'GetNode': {
+ 'GiveOpennetRef': FcpTypeBool,
+ 'WithPrivate': FcpTypeBool,
+ 'WithVolatile': FcpTypeBool,
+ },
+ 'GetPluginInfo': {
+ 'Detailed': FcpTypeBool,
+ },
+ 'GetRequestStatus': {
+ 'Global': FcpTypeBool,
+ 'OnlyData': FcpTypeBool,
+ },
'ListPeer': {
'WithMetadata': FcpTypeBool,
'WithVolantile': FcpTypeBool,
},
-
'ListPeers': {
'WithMetadata': FcpTypeBool,
'WithVolantile': FcpTypeBool,
},
-
- #'AddPeer': # added later as PeerMessageParams
-
'ModifyPeer': {
'AllowLocalAddresses': FcpTypeBool,
'IsDisabled': FcpTypeBool,
'ListenOnly': FcpTypeBool,
},
-
+ #'ModifyConfig': # added later as ConfigMessageParams()
'ModifyPeerNote': {
'NoteText': FcpTypeBase64EncodedString,
},
-
- 'GetNode': {
- 'GiveOpennetRef': FcpTypeBool,
- 'WithPrivate': FcpTypeBool,
- 'WithVolatile': FcpTypeBool,
+ 'ModifyPersistentRequest': {
+ 'Global': FcpTypeBool,
},
- 'GetConfig': {
- 'WithCurrent': FcpTypeBool,
- 'WithDefaults': FcpTypeBool,
- 'WithSortOrder': FcpTypeBool,
- 'WithExpertFlag': FcpTypeBool,
- 'WithForceWriteFlag': FcpTypeBool,
- 'WithShortDescription': FcpTypeBool,
- 'WithLongDescription': FcpTypeBool,
- },
-
- #'ModifyConfig': # added later as ConfigMessageParams()
-
- 'TestDDARequest': {
- 'WantReadDirectory': FcpTypeBool,
- 'WantWriteDirectory': FcpTypeBool,
- },
- 'ClientPut': {
- 'BinaryBlob': FcpTypeBool,
- 'DontCompress': FcpTypeBool,
- 'EarlyEncode': FcpTypeBool,
- 'GetCHKOnly': FcpTypeBool,
+ 'RemopvePersistentRequest': {
'Global': FcpTypeBool,
- 'MaxRetries': FcpTypeInt,
- 'Verbosity': FcpTypeInt,
},
- 'ClientGet': {
- 'BinaryBlob': FcpTypeBool,
- 'Global': FcpTypeBool,
- 'IgnoreDS': FcpTypeBool,
- 'DSOnly': FcpTypeBool,
- 'MaxSize': FcpTypeInt,
- 'MaxTempSize': FcpTypeInt,
- 'Verbosity': FcpTypeInt,
- },
'SubscribeUSK': {
'DontPoll': FcpTypeBool,
},
+ 'TestDDARequest': {
+ 'WantReadDirectory': FcpTypeBool,
+ 'WantWriteDirectory': FcpTypeBool,
+ },
'WatchGlobal': {
'Enabled': FcpTypeBool,
'VerbosityMask': FcpTypeInt,
},
- 'GetRequestStatus': {
+
+ # node messages
+ #
+ 'AllData': {
'Global': FcpTypeBool,
- 'OnlyData': FcpTypeBool,
+ #NOTE: we ignore startup and completion time here as long as it is not passed in all related messages
},
- 'RemopvePersistentRequest': {
+ #'ConfigData': # added later as ConfigMessageParams()
+ 'DataFound': {
'Global': FcpTypeBool,
+ 'DataLength': FcpTypeInt,
},
- 'ModifyPersistentRequest': {
- 'Global': FcpTypeBool,
+ 'FinishedCompression': {
+ 'OriginalSize': FcpTypeInt,
+ 'CompressedSize': FcpTypeInt,
},
+ 'GetFailed': {
+ 'Code': FcpTypeInt,
+ 'ExpectedDataLength': FcpTypeInt_GetFailed_ExpectedDataLenght,
+ 'Fatal': FcpTypeBool,
+ 'FinalizedExpected': FcpTypeBool,
+ 'Global': FcpTypeBool,
+ },
'GetPluginInfo': {
- 'Detailed': FcpTypeBool,
+ 'Started': FcpTypeBool,
},
-
-
-
- # node messages
-
+ 'IdentifierCollision': {
+ 'Global': FcpTypeBool,
+ },
+ #'NodeData': # added later as NodeMessageParams
'NodeHello': {
'Build': FcpTypeInt,
'CompressionCodecs': FcpTypeInt,
@@ -648,37 +667,27 @@
'FcpVersion': FcpTypeFloat,
'Testnet': FcpTypeBool,
},
-
#'Peer': # added later as PeerMessageParams
-
'PeerNote': {
'NoteText': FcpTypeBase64EncodedString,
},
-
-
- #'NodeData': # added later as NodeMessageParams
- #'ConfigData': # added later as ConfigMessageParams()
-
- 'TestDDAComplete': {
- 'ReadDirectoryAllowed': FcpTypeBool,
- 'WriteDirectoryAllowed': FcpTypeBool,
- },
- 'PutFetchable': {
+ 'PersistentRequestModified': {
'Global': FcpTypeBool,
- },
- 'DataFound': {
+ },
+ 'PersistentRequestRemoved': {
'Global': FcpTypeBool,
- 'DataLength': FcpTypeInt,
},
- 'AllData': {
+ 'ProtocolError': {
+ 'Code': FcpTypeInt,
'Global': FcpTypeBool,
- #NOTE: we ignore startup and completion time here as long as it is not passed in all related messages
-
+ },
+ 'PutFailed': {
+ 'Global': FcpTypeBool,
+ 'Code': FcpTypeInt,
+ },
+ 'PutFetchable': {
+ 'Global': FcpTypeBool,
},
- 'FinishedCompression': {
- 'OriginalSize': FcpTypeInt,
- 'CompressedSize': FcpTypeInt,
- },
'SimpleProgress': {
'Total': FcpTypeInt,
'Required': FcpTypeInt,
@@ -687,38 +696,13 @@
'Succeeded': FcpTypeInt,
'Finalized': FcpTypeBool,
},
- 'PersistentRequestRemoved': {
- 'Global': FcpTypeBool,
- },
- 'PersistentRequestModified': {
- 'Global': FcpTypeBool,
- },
- 'PutFailed': {
- 'Global': FcpTypeBool,
- 'Code': FcpTypeInt,
- },
- 'GetFailed': {
- 'Code': FcpTypeInt,
- 'ExpectedDataLength': FcpTypeInt_GetFailed_ExpectedDataLenght,
- 'Fatal': FcpTypeBool,
- 'FinalizedExpected': FcpTypeBool,
- 'Global': FcpTypeBool,
- },
- 'ProtocolError': {
- 'Code': FcpTypeInt,
- 'Global': FcpTypeBool,
- },
-
- 'IdentifierCollision': {
- 'Global': FcpTypeBool,
- },
'SubscribedUSKUpdate': {
'Edition': FcpTypeInt,
},
- 'GetPluginInfo': {
- 'Started': FcpTypeBool,
+ 'TestDDAComplete': {
+ 'ReadDirectoryAllowed': FcpTypeBool,
+ 'WriteDirectoryAllowed': FcpTypeBool,
},
-
}
MessageParamTypes['ClientPutDiskDir'] = MessageParamTypes['ClientPut']
@@ -728,9 +712,7 @@
MessageParamTypes['PersistentGet'] = MessageParamTypes['ClientGet']
MessageParamTypes['PersistentPut'] = MessageParamTypes['ClientPut']
-
MessageParamTypes['ModifyConfig'] = MessageParamTypes['ConfigData'] = ConfigMessageParams()
-
MessageParamTypes['Peer'] = MessageParamTypes['AddPeer'] = PeerMessageParams
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
