From c3a1e56608ebe08f1ddc07273d85ff9c2779de9b Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Thu, 3 Jun 2010 14:14:38 +0200
Subject: Implement support for user controllable timetrap parameters (multiply
 and scale)

Documentation still missing.
---
 lib/test_server/doc/src/test_server.xml      | 16 ++++++++++++++++
 lib/test_server/doc/src/test_server_ctrl.xml | 25 +++++++++++++++++++++++++
 2 files changed, 41 insertions(+)

(limited to 'lib/test_server/doc/src')

diff --git a/lib/test_server/doc/src/test_server.xml b/lib/test_server/doc/src/test_server.xml
index 6e75425862..0cae75d692 100644
--- a/lib/test_server/doc/src/test_server.xml
+++ b/lib/test_server/doc/src/test_server.xml
@@ -166,6 +166,22 @@
           numbers.</p>
       </desc>
     </func>
+    <func>
+      <name>adjusted_sleep(MSecs) -> ok</name>
+      <fsummary>Suspens the calling task for a specified time.</fsummary>
+      <type>
+        <v>MSecs = integer() | float() | infinity</v>
+        <d>The default number of milliseconds to sleep</d>
+      </type>
+      <desc>
+        <p>This function suspends the calling process for at least the
+          supplied number of milliseconds. The function behaves the same
+	  way as <c>test_server:sleep/1</c>, only <c>MSecs</c>
+	  will be multiplied by the 'multiply_timetraps' value, if set,
+	  and also automatically scaled up if 'scale_timetraps' is set
+	  to true (which it is by default).</p>
+      </desc>
+    </func>
     <func>
       <name>hours(N) -> MSecs</name>
       <name>minutes(N) -> MSecs</name>
diff --git a/lib/test_server/doc/src/test_server_ctrl.xml b/lib/test_server/doc/src/test_server_ctrl.xml
index 8b60849b61..2368c4bacc 100644
--- a/lib/test_server/doc/src/test_server_ctrl.xml
+++ b/lib/test_server/doc/src/test_server_ctrl.xml
@@ -375,6 +375,31 @@ Optional, if not given the test server controller node
           multiplied by <c>N</c>.</p>
       </desc>
     </func>
+    <func>
+      <name>scale_timetraps(Bool) -> ok</name>
+      <fsummary>.</fsummary>
+      <type>
+        <v>Bool = true | false</v>
+      </type>
+      <desc>
+        <p>This function should be called before a test is started.
+	  The parameter specifies if test_server should attempt
+	  to automatically scale the timetrap value in order to compensate
+	  for delays caused by e.g. the cover tool.</p>
+      </desc>
+    </func>
+    <func>
+      <name>get_timetrap_parameters() -> {N,Bool} </name>
+      <fsummary>Read the parameter values that affect timetraps.</fsummary>
+      <type>
+        <v>N = integer() | infinity</v>
+        <v>Bool = true | false</v>
+      </type>
+      <desc>
+        <p>This function may be called to read the values set by
+	<c>multiply_timetraps/1</c> and <c>scale_timetraps/1</c>.</p>
+      </desc>
+    </func>
     <func>
       <name>cover(Application,Analyse) -> ok</name>
       <name>cover(CoverFile,Analyse) -> ok</name>
-- 
cgit v1.2.3