Add timeout (sec) parameter to RemoteEnvironment.connect().

sven1977 · michaelschaarschmidt · commit 48f55ba96207 · 2018-02-21T09:11:45.000Z
diff --git a/tensorforce/contrib/remote_environment.py b/tensorforce/contrib/remote_environment.py
@@ -22,6 +22,7 @@
 import os
 from tensorforce import TensorForceError
 import logging
+import time
 
 
 class RemoteEnvironment(Environment):
@@ -54,20 +55,34 @@ def close(self):
         """
         self.disconnect()
 
-    def connect(self):
+    def connect(self, timeout=600):
         """
         Starts the server tcp connection on the given host:port.
+
+        Args:
+            timeout (int): The time (in seconds) for which we will attempt a connection to the remote
+                (every 5sec). After that (or if timeout is None or 0), an error is raised.
         """
         # If we are already connected, return error.
         if self.socket:
             raise TensorForceError("Already connected to {}:{}. Only one connection allowed at a time. " +
                                    "Close first by calling `close`!".format(self.host, self.port))
         self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-        self.socket.settimeout(5)
-        err = self.socket.connect_ex((self.host, self.port))
+
+        if timeout < 5 or timeout is None:
+            timeout = 5
+
+        err = 0
+        start_time = time.time()
+        while time.time() - start_time < timeout:
+            self.socket.settimeout(5)
+            err = self.socket.connect_ex((self.host, self.port))
+            if err == 0:
+                break
+            time.sleep(1)
         if err != 0:
-            raise TensorForceError("Error when trying to connect to {}:{}: errno={} '{}'".
-                                   format(self.host, self.port, errno.errorcode[err], os.strerror(err)))
+            raise TensorForceError("Error when trying to connect to {}:{}: errno={} errcode='{}' '{}'".
+                                   format(self.host, self.port, err, errno.errorcode[err], os.strerror(err)))
 
     def disconnect(self):
         """
diff --git a/tensorforce/contrib/unreal_engine.py b/tensorforce/contrib/unreal_engine.py
@@ -50,8 +50,8 @@ def __init__(
                 This would be necessary e.g. for agents that use q-networks where the output are q-values per discrete
                 state-action pair.
             delta_time (float): The fake delta time to use for each single game tick.
-            num_ticks (int): The number of ticks to be executed in this step (each tick will repeat the same given
-            actions).
+            num_ticks (int): The number of ticks to be executed in a single act call (each tick will
+                repeat the same given actions).
         """
         RemoteEnvironment.__init__(self, host, port)
 
