SF.net SVN: fclient: [278] trunk/sandbox/fcp2/client.py
Status: Pre-Alpha
Brought to you by:
jurner
From: <ju...@us...> - 2008-02-26 17:22:22
|
Revision: 278 http://fclient.svn.sourceforge.net/fclient/?rev=278&view=rev Author: jurner Date: 2008-02-26 08:22:06 -0800 (Tue, 26 Feb 2008) Log Message: ----------- fixed some crossreferences for epydoc Modified Paths: -------------- trunk/sandbox/fcp2/client.py Modified: trunk/sandbox/fcp2/client.py =================================================================== --- trunk/sandbox/fcp2/client.py 2008-02-26 16:21:17 UTC (rev 277) +++ trunk/sandbox/fcp2/client.py 2008-02-26 16:22:06 UTC (rev 278) @@ -453,7 +453,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{fcp2_0_message.Message}) NodeHello or None if no connection could be established + @return: (L{message.Message}) NodeHello or None if no connection could be established """ nodeHello = None for nodeHello in self.iterConnect(host=host, port=port, duration=duration, timeout=timeout): @@ -468,7 +468,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{fcp2_0_message.Message}) NodeHello if successful, None otherwise for the next iteration + @return: (L{message.Message}) NodeHello if successful, None otherwise for the next iteration @event: ClientConnected(event, message) is triggered as soon as the client is connected """ @@ -1398,10 +1398,9 @@ @return: (str) request identifier - @event: L{events.RequestCompleted} triggered as soon as the request is complete - @event: L{events.RequestFailed} triggered if the request failes - @event: L{events.RequestStarted} triggered as soon as the request is started - @event: L{events.RequestModified} trigggered if the request identifier changes + @event: L{events.Events.RequestCompleted} triggered as soon as the request is complete + @event: L{events.Events.RequestFailed} triggered if the request failes + @event: L{events.Events.RequestModified} trigggered if the request identifier changes or the request is modified otherwise (see L{modifyRequest}) @note: the identifier of the request may change at any time. You should be prepaired to handle @@ -1990,7 +1989,7 @@ def getRequest(self, requestIdentifier): """Returns a (initial) message, given its identifier @param requestIdentifier: identifier of the message - @return: L{Message} + @return: L{message.Message} """ return self._requests[requestIdentifier] @@ -2079,7 +2078,7 @@ def resendRequest(self, request): """Resends a request - @param request: (L{fcp2_0_message.Message}) + @param request: (L{message.Message}) @return: (str) request identifier @note: you can use this method to resend get / put requests.All attempts to resend other requests @@ -2273,7 +2272,7 @@ @param keypairType: type of keypair to generate (either L{consts.KeyType.SSK} or L{consts.KeyType.SSK}) @return: identifier of the request - @event: L{events.KeypairGenerated} triggered as soon as the request is complete + @event: L{events.Events.KeypairGenerated} triggered as soon as the request is complete @requestparam: B{FcModified:} (dict) @requestparam: B{FcPrivateKey:} None. Will contain the private key as soon as the key is generated This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |