[CalendarServer-changes] [9076] CalendarServer/branches/users/glyph/ipv6-client/twext/internet/ adaptendpoint.py

[source_changes at macosforge.org]

Revision: 9076
          http://trac.macosforge.org/projects/calendarserver/changeset/9076
Author:   glyph at apple.com
Date:     2012-04-13 11:45:45 -0700 (Fri, 13 Apr 2012)
Log Message:
-----------
better docstring

Modified Paths:
--------------
    CalendarServer/branches/users/glyph/ipv6-client/twext/internet/adaptendpoint.py

Modified: CalendarServer/branches/users/glyph/ipv6-client/twext/internet/adaptendpoint.py
===================================================================
--- CalendarServer/branches/users/glyph/ipv6-client/twext/internet/adaptendpoint.py	2012-04-13 18:45:40 UTC (rev 9075)
+++ CalendarServer/branches/users/glyph/ipv6-client/twext/internet/adaptendpoint.py	2012-04-13 18:45:45 UTC (rev 9076)
@@ -143,8 +143,21 @@
 
 def connect(endpoint, clientFactory):
     """
-    Connect a L{twisted.internet.protocol.ClientFactory} using the given
-    L{twisted.internet.interfaces.IStreamClientEndpoint}.
+    Connect a L{twisted.internet.protocol.ClientFactory} to a remote host using
+    the given L{twisted.internet.interfaces.IStreamClientEndpoint}.  This relays
+    C{clientConnectionFailed} and C{clientConnectionLost} notifications as
+    legacy code using the L{ClientFactory} interface, such as,
+    L{ReconnectingClientFactory} would expect.
+
+    @param endpoint: The endpoint to connect to.
+    @type endpoint: L{twisted.internet.interfaces.IStreamClientEndpoint}
+
+    @param clientFactory: The client factory doing the connecting.
+    @type clientFactory: L{twisted.internet.protocol.ClientFactory}
+
+    @return: A connector object representing the connection attempt just
+        initiated.
+    @rtype: L{IConnector}
     """
     wrap = LegacyClientFactoryWrapper(clientFactory, endpoint)
     wrap.connect()
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20120413/6651ff7c/attachment.html>