r47166 - docstring
glyph-TA+aISz0psMTMxyoc4vAAJOcrHinNvQL0E9HWUfgJXw@public.gmane.org Tue, 5 Apr 2016 16:59:22 -0600 (MDT)
| Newsgroups | gmane.comp.python.twisted.commits |
|---|---|
| Message-ID | <[email protected]> |
Author: glyph
Date: Tue Apr 5 16:59:19 2016
New Revision: 47166
Modified:
branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_wrapper.py
Log:
docstring
Modified: branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_wrapper.py
==============================================================================
--- branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_wrapper.py (original)
+++ branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_wrapper.py Tue Apr 5 16:59:19 2016
@@ -98,6 +98,14 @@
def proxyEndpoint(wrappedEndpoint):
"""
-
+ Wrap an endpoint with PROXY protocol support, so that the transport's
+ C{getHost} and C{getPeer} methods reflect the attributes of the proxied
+ connection rather than the underlying connection.
+
+ @param wrappedEndpoint: The underlying listening endpoint.
+ @type wrappedEndpoint: L{IStreamServerEndpoint}
+
+ @return: a new listening endpoint that speaks the PROXY protocol.
+ @rtype: L{IStreamServerEndpoint}
"""
return _WrapperServerEndpoint(wrappedEndpoint, HAProxyWrappingFactory)