[Pkg-privacy-commits] [obfsproxy] 217/353: Trivial doc tweaks and ChangeLog entries for #10342.

[Ximin Luo]

This is an automated email from the git hooks/post-receive script.

infinity0 pushed a commit to branch master
in repository obfsproxy.

commit a8e54d599d4bd4be0c4dfbf5f0e6d758da0322c9
Author: George Kadianakis <desnacked at riseup.net>
Date:   Thu Dec 12 17:15:02 2013 +0000

    Trivial doc tweaks and ChangeLog entries for #10342.
---
 ChangeLog                    |  4 ++++
 obfsproxy/network/network.py |  6 ++++--
 obfsproxy/transports/base.py | 10 +++++-----
 3 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 4608760..611af58 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -8,6 +8,10 @@ Changes in version 0.2.5 - UNRELEASED
    transports to filter server-side options that should not be announced
    to BridgeDB (because they might leak filesystem paths etc.) .
    Patch by David Stainton. Fixes #10243.
+ - Make the circuit an attribute of the transport, rather than passing it
+   as a method argument. Patch by Ximin Luo. Fixes #10342.
+ - Rename the handshake() method to circuitConnected().
+   Patch by Ximin Luo.
 
 
 Changes in version 0.2.4 - 2013-09-30
diff --git a/obfsproxy/network/network.py b/obfsproxy/network/network.py
index 78b4484..038f4b6 100644
--- a/obfsproxy/network/network.py
+++ b/obfsproxy/network/network.py
@@ -123,9 +123,11 @@ class Circuit(Protocol):
 
         log.debug("%s: Circuit completed." % self.name)
 
-        # Call the transport-specific handshake method since this is a
-        # good time to perform a handshake.
+        # Set us as the circuit of our pluggable transport instance.
         self.transport.circuit = self
+
+        # Call the transport-specific circuitConnected method since
+        # this is a good time to perform a handshake.
         self.transport.circuitConnected()
 
         # Do a dummy dataReceived on the initiating connection in case
diff --git a/obfsproxy/transports/base.py b/obfsproxy/transports/base.py
index 71bac88..2cda011 100644
--- a/obfsproxy/transports/base.py
+++ b/obfsproxy/transports/base.py
@@ -81,25 +81,25 @@ class BaseTransport(object):
 
     def circuitConnected(self):
         """
-        The Circuit 'self.circuit' was completed, and this is a good time
-        to do your transport-specific handshake on its downstream side.
+        Our circuit was completed, and this is a good time to do your
+        transport-specific handshake on its downstream side.
         """
 
     def circuitDestroyed(self, reason, side):
         """
-        Circuit 'self.circuit' was tore down.
+        Our circuit was tore down.
         Both connections of the circuit are closed when this callback triggers.
         """
 
     def receivedDownstream(self, data):
         """
-        Received 'data' in the downstream side of 'self.circuit'.
+        Received 'data' in the downstream side of our circuit.
         'data' is an obfsproxy.network.buffer.Buffer.
         """
 
     def receivedUpstream(self, data):
         """
-        Received 'data' in the upstream side of 'self.circuit'.
+        Received 'data' in the upstream side of our circuit.
         'data' is an obfsproxy.network.buffer.Buffer.
         """
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/obfsproxy.git