From 46807d94fbdac2ba4cf72a69b3928e788709fd07 Mon Sep 17 00:00:00 2001 From: Kevin Menard Date: Mon, 10 May 2010 21:42:35 -0400 Subject: [PATCH] Documented the new session max wait time setting. --- doc/website/configuring-and-tuning.markdown | 26 ++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/doc/website/configuring-and-tuning.markdown b/doc/website/configuring-and-tuning.markdown index a0f1c871..70c1654b 100644 --- a/doc/website/configuring-and-tuning.markdown +++ b/doc/website/configuring-and-tuning.markdown @@ -124,4 +124,28 @@ Changing Remote Control Self-Healing Parameters e.g. ant -DhubPollerIntervalInSeconds=120 launch-hub - \ No newline at end of file + +Changing Maximum Wait Time for New Session +========================================== + + By default the Hub will block until a Remote Control becomes available when + requesting a new browser session. This can be problematic if the requesting + client times out. Since the Hub is unaware of this timeout, it will request + the new session anyway and that session will become effectively orphaned. + + If your client cannot wait for the session you may change the maximum time the + Hub will wait in `grid_configuration.yml`. When the `newSessionMaxWaitTimeInSeconds` + value is exceeded, the Hub will return an Error indicating that no Remote Controls + were available to fulfill the request. + + For instance: + + hub: + newSessionMaxWaitTimeInSeconds: 120 + + This sample configuration will instruct the Hub to block for up to 2 minutes + while waiting for a Remote Control to become available to handle the new session + request. + + NB: If this configuration value is not provided, the default value of infinite + will be used. \ No newline at end of file