Merge pull request #213 from pahaz/pahaz-patch-1

Set set_keepalive to 5.0 by default

changelog.rst

@@ -20,7 +20,8 @@ CHANGELOG
 =========
 
 - v.0.3.0 (`Pahaz`_)
-    + Change default with context behavior to use `.stop(force=True)` on exit (backward incmpatible)
+    + Change default with context behavior to use `.stop(force=True)` on exit (is not fully backward compatible)
+    + Set transport keepalive to 5 second by default (disabled for version < 0.3.0)
     + Deprecate and remove `block_on_close` option
     + Drop `daemon_forward_servers = True` hack for "deadlocks" / "tunneling hangs" (`#173`_, `#201`_, `#162`_)
 

sshtunnel.py

@@ -664,9 +664,10 @@ class SSHTunnelForwarder(object):
             Interval in seconds defining the period in which, if no data
             was sent over the connection, a *'keepalive'* packet will be
             sent (and ignored by the remote host). This can be useful to
-            keep connections alive over a NAT
+            keep connections alive over a NAT. You can set to 0.0 for
+            disable keepalive.
 
-            Default: 0.0 (no keepalive packets are sent)
+            Default: 5.0 (no keepalive packets are sent)
 
             .. versionadded:: 0.0.7
 
@@ -888,7 +889,7 @@ def __init__(
             mute_exceptions=False,
             remote_bind_address=None,
             remote_bind_addresses=None,
-            set_keepalive=0.0,
+            set_keepalive=5.0,
             threaded=True,  # old version False
             compression=None,
             allow_agent=True,  # look for keys from an SSH agent