[tinkerpop] branch TINKERPOP-2405 created (now a00000a)

[sp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

spmallette pushed a change to branch TINKERPOP-2405
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git.


      at a00000a  TINKERPOP-2405 Provide method to configure tornado timeouts

This branch includes the following new commits:

     new a00000a  TINKERPOP-2405 Provide method to configure tornado timeouts

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[tinkerpop] 01/01: TINKERPOP-2405 Provide method to configure tornado timeouts

[sp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

spmallette pushed a commit to branch TINKERPOP-2405
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git

commit a00000a0c03888bdb4028dd3672b9f690ed7d7e2
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Wed Aug 26 09:25:24 2020 -0400

    TINKERPOP-2405 Provide method to configure tornado timeouts
---
 CHANGELOG.asciidoc                                       |  1 +
 docs/src/reference/gremlin-variants.asciidoc             | 16 +++++++++++++---
 .../jython/gremlin_python/driver/tornado/transport.py    |  8 +++++---
 3 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index 34647e9..9d033f9 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -23,6 +23,7 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
 [[release-3-4-9]]
 === TinkerPop 3.4.9 (Release Date: NOT OFFICIALLY RELEASED YET)
 
+* Established a default read and write timeout for the `TornadoTransport` in Python, allowing it to be configurable.
 * Delegated handling of erroneous response to the worker thread pool instead of event loop thread pool in Java Driver.
 * Removed `Connection` from `Connection Pool` when server closes a connection with no pending requests in Java Driver.
 * Fixed bug in Javascript `Translator` that wasn't handling child traversals well.
diff --git a/docs/src/reference/gremlin-variants.asciidoc b/docs/src/reference/gremlin-variants.asciidoc
index 764d86c..c1f0949 100644
--- a/docs/src/reference/gremlin-variants.asciidoc
+++ b/docs/src/reference/gremlin-variants.asciidoc
@@ -732,16 +732,26 @@ can be passed to the `Client` or `DriverRemoteConnection` instance as keyword ar
 [width="100%",cols="3,10,^2",options="header"]
 |=========================================================
 |Key |Description |Default
-|protocol_factory |A callable that returns an instance of `AbstractBaseProtocol`. |`gremlin_python.driver.protocol.GremlinServerWSProtocol`
-|transport_factory |A callable that returns an instance of `AbstractBaseTransport`. |`gremlin_python.driver.tornado.transport.TornadoTransport`
-|pool_size |The number of connections used by the pool. |4
+|headers |Additional headers that will be added to each request message. |`None`
 |max_workers |Maximum number of worker threads. |Number of CPUs * 5
 |message_serializer |The message serializer implementation.|`gremlin_python.driver.serializer.GraphSONMessageSerializer`
 |password |The password to submit on requests that require authentication. |""
+|pool_size |The number of connections used by the pool. |4
+|protocol_factory |A callable that returns an instance of `AbstractBaseProtocol`. |`gremlin_python.driver.protocol.GremlinServerWSProtocol`
+|transport_factory |A callable that returns an instance of `AbstractBaseTransport`. |`gremlin_python.driver.tornado.transport.TornadoTransport`
 |username |The username to submit on requests that require authentication. |""
 |session | A unique string-based identifier (typically a UUID) to enable a <<sessions,session-based connection>>. This is not a valid configuration for `DriverRemoteConnection`. |None
 |=========================================================
 
+Note that the `transport_factory` can allow for additional configuration of the `TornadoTransport`, which exposes
+options to manage `ioloop` timeouts:
+
+```python
+g = traversal().withRemote(
+  DriverRemoteConnection('ws://localhost:8182/gremlin','g',
+                         transport_factory=lambda: TornadoTransport(read_timeout=10, write_timeout=10)))
+```
+
 === Traversal Strategies
 
 In order to add and remove <<traversalstrategy,traversal strategies>> from a traversal source, Gremlin-Python has a
diff --git a/gremlin-python/src/main/jython/gremlin_python/driver/tornado/transport.py b/gremlin-python/src/main/jython/gremlin_python/driver/tornado/transport.py
index 1ec2bfd..089a51a 100644
--- a/gremlin-python/src/main/jython/gremlin_python/driver/tornado/transport.py
+++ b/gremlin-python/src/main/jython/gremlin_python/driver/tornado/transport.py
@@ -26,8 +26,10 @@ __author__ = 'David M. Brown (davebshow@gmail.com)'
 
 class TornadoTransport(AbstractBaseTransport):
 
-    def __init__(self):
+    def __init__(self, read_timeout=30, write_timeout=30):
         self._loop = ioloop.IOLoop(make_current=False)
+        self._read_timeout = read_timeout
+        self._write_timeout = write_timeout
 
     def connect(self, url, headers=None):
         if headers:
@@ -37,10 +39,10 @@ class TornadoTransport(AbstractBaseTransport):
 
     def write(self, message):
         self._loop.run_sync(
-            lambda: self._ws.write_message(message, binary=True))
+            lambda: self._ws.write_message(message, binary=True), timeout=self._write_timeout)
 
     def read(self):
-        return self._loop.run_sync(lambda: self._ws.read_message())
+        return self._loop.run_sync(lambda: self._ws.read_message(), timeout=self._read_timeout)
 
     def close(self):
         self._ws.close()