Merge pull request #207 from pahaz/v-0-2-2

v 0.2.2

README.rst

@@ -107,7 +107,7 @@ port.
     from sshtunnel import SSHTunnelForwarder
 
     server = SSHTunnelForwarder(
-        'pahaz.urfuclub.ru',
+        'alfa.8iq.dev',
         ssh_username="pahaz",
         ssh_password="secret",
         remote_bind_address=('127.0.0.1', 8080)
@@ -229,7 +229,7 @@ CLI usage
                      ssh_address
 
     Pure python ssh tunnel utils
-    Version 0.2.1
+    Version 0.2.2
 
     positional arguments:
       ssh_address           SSH server IP address (GW for SSH tunnels)

changelog.rst

@@ -19,6 +19,9 @@ CONTRIBUTORS
 CHANGELOG
 =========
 
+- v.0.2.2 (`Pahaz`_)
+      + Add `.stop(force=True)` for force close active connections (`#201`_)
+
 - v.0.2.1 (`Pahaz`_, `Eddie Chiang`_ and `kkrasovskii`_)
       + Fixes bug with orphan thread for a tunnel that is DOWN (`#170`_)
 
@@ -148,4 +151,5 @@ CHANGELOG
 .. _#43: https://github.com/pahaz/sshtunnel/issues/43
 .. _#46: https://github.com/pahaz/sshtunnel/issues/46
 .. _#170: https://github.com/pahaz/sshtunnel/issues/170
+.. _#201: https://github.com/pahaz/sshtunnel/issues/201
 .. _detail: https://github.com/pahaz/sshtunnel/commit/64af238b799b0e0057c4f9b386cda247e0006da9#diff-76bc1662a114401c2954deb92b740081R127

sshtunnel.py

@@ -36,7 +36,7 @@
     input_ = input
 
 
-__version__ = '0.2.1'
+__version__ = '0.2.2'
 __author__ = 'pahaz'
 
 
@@ -1329,7 +1329,12 @@ def start(self):
 
     def stop(self, force=False):
         """
-        Shut the tunnel down.
+        Shut the tunnel down. By default we are always waiting until closing
+        all connections. You can use `force=True` to force close connections
+
+        Keyword Arguments:
+            force (bool):
+                Force close current connections
 
         .. note:: This **had** to be handled with care before ``0.1.0``: