SF.net SVN: fclient: [478] trunk/fcp2/src/fcp2/client.py
Status: Pre-Alpha
Brought to you by:
jurner
Menu
▾
▴
SF.net SVN: fclient: [478] trunk/fcp2/src/fcp2/client.py
|
From: <jU...@us...> - 2008-07-02 07:04:37
|
Revision: 478
http://fclient.svn.sourceforge.net/fclient/?rev=478&view=rev
Author: jUrner
Date: 2008-07-02 00:04:45 -0700 (Wed, 02 Jul 2008)
Log Message:
-----------
fixed broken docstrings
Modified Paths:
--------------
trunk/fcp2/src/fcp2/client.py
Modified: trunk/fcp2/src/fcp2/client.py
===================================================================
--- trunk/fcp2/src/fcp2/client.py 2008-07-01 18:48:31 UTC (rev 477)
+++ trunk/fcp2/src/fcp2/client.py 2008-07-02 07:04:45 UTC (rev 478)
@@ -432,7 +432,7 @@
@param duration: (int) how many seconds try to connect before giving up
@param timeout: (int) how much time to wait before another attempt to connect
- @return: (L{message.MsgMessage}) NodeHello or None if no connection could be established
+ @return: (L{message.MsgNodeHello}) or None if no connection could be established
"""
nodeHello = None
for nodeHello in self.iterConnect(host=host, port=port, duration=duration, timeout=timeout):
@@ -454,7 +454,7 @@
@param duration: (int) how many seconds try to connect before giving up
@param timeout: (int) how much time to wait before another attempt to connect
- @return: (L{message.MsgMessage}) NodeHello if successful, None otherwise for the next iteration
+ @return: (L{message.MsgNodeHello}) if successful, None otherwise for the next iteration
@event: ClientConnected(event, message) is triggered as soon as the client is connected
"""
@@ -542,7 +542,7 @@
def newIdentifier(self, identifiers=None):
"""Creates a new identifier to be used as request identifer or whatever
- @param identifiersuuids: if desired any iterable containing identifiers to enshure the identifier is unique within the iterable
+ @param identifiers: if desired any iterable containing identifiers to enshure the identifier is unique within the iterable
@return: (str) identifier
"""
@@ -1185,8 +1185,8 @@
def sendMessage(self, msg):
"""Sends a message to freenet
- @param msg: (L{message.MsgMessage}) message to send
- @return: (L{message.MsgMessage}) disconnect if something went wrong
+ @param msg: (L{message._MessageBase}) message to send
+ @return: always None
@note: If an error occurs the client is closed
@note: you can use this method to send a message to the node, bypassing all
@@ -1260,7 +1260,7 @@
**messageParams
):
"""Requests a key from the node
- @param uri: (L{key.KeyBase}) key to request
+ @param uri: (L{key._KeyBase}) key to request
@param requestType: (L{consts.ConstRequestType}) sub type of the message
@param userData: any non persistent data to associate to the request or None
@param persistentUserData: any string to associate to the request as persistent data or None
@@ -1303,7 +1303,7 @@
):
"""Requests datae from the node
- @param uri: (L{key.KeyBase}) key to request
+ @param uri: (L{key._KeyBase}) key to request
@param allowedMimeTypes: (str) list of allowed mime types
@param binaryBlob: (bool) if True, the file is retrieved as binary blob file
@@ -1370,7 +1370,7 @@
):
"""Requests a file from the node
- @param uri: (L{key.KeyBase}) key to request
+ @param uri: (L{key._KeyBase}) key to request
@param filename: (full path) filename to store the file to
@param allowedMimeTypes: (str) list of allowed mime types
@@ -1434,7 +1434,7 @@
):
"""Requests info about a key
- @param uri: (L{key.KeyBase}) key to request
+ @param uri: (L{key._KeyBase}) key to request
@param dsOnly: if True, retrieves the file from the local data store only
@param ignoreDS: If True, ignores the local data store
@@ -1479,7 +1479,7 @@
def subscribeUSK(self, uri, dontPoll=True):
"""Asks the node to notify the client when an USK is updated
- @param uri: (L{key.USK}) key to subscribe to
+ @param uri: (L{key.KeyUSK}) key to subscribe to
@param dontPoll: if True, does whatever ???
@return: (str) identifer of the request
@@ -1660,7 +1660,7 @@
):
"""Uploads data
- @param uri: (L{key.KeyBase}) key under wich to upload the data
+ @param uri: (L{key._KeyBase}) key under wich to upload the data
@param data: (bytes) data to upload
@param contentType: (str) content type. If not specified, the node will guess the content type
@@ -1726,7 +1726,7 @@
):
"""Uploads the contents of a directory
- @param uri: (L{key.KeyBase}) key under wich to upload the directory
+ @param uri: (L{key._KeyBase}) key under wich to upload the directory
@param directory: (str) directory to upload
@param allowUnreadableFiles: if True, unreadable files in the directory are ignored, if False the request fails
if it encounters an unreadavle file
@@ -1776,7 +1776,7 @@
):
"""Uploads a file
- @param uri: (L{key.KeyBase}) key under wich to upload the file
+ @param uri: (L{key._KeyBase}) key under wich to upload the file
@param filename: (str) file to upload
@note: for other params see L{putData}
@@ -1821,7 +1821,7 @@
):
"""Uploads multiple items at once to be retrievable under one key
- @param uri: (L{key.KeyBase}) key under wich to upload the file
+ @param uri: (L{key._KeyBase}) key under wich to upload the file
@param items: (list) list of items to upload
@note: for other params see L{putDir}
@@ -1872,7 +1872,7 @@
persistentUserData='',
):
"""Uploads a redirect to another key
- @param uri: (L{key.KSK}) to insert as redirect
+ @param uri: (L{key.KeyKSK}) to insert as redirect
@param targetKey: (key.KeyBase) key to redirect to
@param maxRetries: (int) maximum number of tretries or -1 to leave the decission up to the node
@param persistence: (L{consts.ConstPersistence}) of the request
@@ -1900,7 +1900,7 @@
def getRequest(self, requestIdentifier):
"""Returns a (initial) message, given its identifier
@param requestIdentifier: identifier of the message
- @return: L{message.MsgMessage}
+ @return: L{message._MessageBase}
"""
return self._requests[requestIdentifier]
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
