Merge branch 'feature/websocket_timeout' into develop

Author: Sam McHardy

binance/websockets.py

@@ -66,13 +66,15 @@ class BinanceSocketManager(threading.Thread):
     WEBSOCKET_DEPTH_10 = '10'
     WEBSOCKET_DEPTH_20 = '20'
 
-    _user_timeout = 30 * 60  # 30 minutes
+    DEFAULT_USER_TIMEOUT = 30 * 60  # 30 minutes
 
-    def __init__(self, client):
+    def __init__(self, client, user_timeout=DEFAULT_USER_TIMEOUT):
         """Initialise the BinanceSocketManager
 
         :param client: Binance API client
         :type client: binance.Client
+        :param user_timeout: Custom websocket timeout
+        :type user_timeout: int
 
         """
         threading.Thread.__init__(self)
@@ -81,6 +83,7 @@ def __init__(self, client):
         self._user_listen_key = None
         self._user_callback = None
         self._client = client
+        self._user_timeout = user_timeout
 
     def _start_socket(self, path, callback, prefix='ws/'):
         if path in self._conns:

docs/websockets.rst

@@ -37,6 +37,13 @@ A callback to process messages would take the format
         print(msg)
         # do something
 
+Set a custom timeout for the websocket connection
+
+.. code:: python
+
+    # set a timeout of 60 seconds
+    bm = BinanceSocketManager(client, user_timeout=60)
+
 
 Websocket Errors
 ----------------