Skip to content

Commit 06c3cdb

Browse files
committed
Document the new connection configuration option.
1 parent c3a0ed6 commit 06c3cdb

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.rdoc

+13-1
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,19 @@ that make use of interactions (so you have users watching the workflows
313313
running) then it should probably be set lower.
314314

315315
There are a number of options for configuring the connection to the Taverna
316-
Server. These are actually provided by the underlying
316+
Server. The first specifies how many times an initial connection to Taverna
317+
Server will be retried if there are any low level network errors.
318+
319+
config.server_connection_error_retries = 5
320+
321+
These can be events such as timeouts, broken connections, refused connections
322+
or anything else out of our control. If such an error is detected Taverna
323+
Player will back off for the amount of time specified by
324+
<tt>config.server_retry_interval</tt> before retrying. If the maximum number of
325+
retries is reached and there is still an error then the run will fail; the
326+
network error message will be recorded as the reason for the run's failure.
327+
328+
The rest of the connection options are actually provided by the underlying
317329
{t2-server client library}[https://rubygems.org/gems/t2-server] and surfaced
318330
here for extra control. They are
319331
{documented in more detail}[http://mygrid.github.io/t2-server-gem/] elsewhere

0 commit comments

Comments
 (0)