doc/BigBench/Configuration.html in bigbench-0.0.1 vs doc/BigBench/Configuration.html in bigbench-0.0.2
- old
+ new
@@ -99,10 +99,12 @@
<li><a href="../BigBench/Benchmark.html">BigBench::Benchmark</a>
<li><a href="../BigBench/Benchmark/Benchmark.html">BigBench::Benchmark::Benchmark</a>
+ <li><a href="../BigBench/Benchmark/Looper.html">BigBench::Benchmark::Looper</a>
+
<li><a href="../BigBench/Bot.html">BigBench::Bot</a>
<li><a href="../BigBench/Configuration.html">BigBench::Configuration</a>
<li><a href="../BigBench/Configuration/Config.html">BigBench::Configuration::Config</a>
@@ -127,18 +129,18 @@
<li><a href="../BigBench/Tracker.html">BigBench::Tracker</a>
<li><a href="../BigBench/Tracker/Tracker.html">BigBench::Tracker::Tracker</a>
+ <li><a href="../EventMachineLoop.html">EventMachineLoop</a>
+
<li><a href="../Float.html">Float</a>
<li><a href="../Helpers.html">Helpers</a>
<li><a href="../Object.html">Object</a>
- <li><a href="../TestWebServer.html">TestWebServer</a>
-
</ul>
</nav>
</div>
</nav>
@@ -149,13 +151,14 @@
<div id="description" class="description">
<p>The configuration is configured in the test reciepts and looks like this:</p>
<pre class="ruby"><span class="ruby-constant">BigBench</span>.<span class="ruby-identifier">configure</span> = {
- :<span class="ruby-identifier">duration</span> =<span class="ruby-operator">></span> <span class="ruby-value">10</span>.<span class="ruby-identifier">seconds</span>,
- :<span class="ruby-identifier">output</span> =<span class="ruby-operator">></span> <span class="ruby-string">"test.ljson"</span>,
- :<span class="ruby-identifier">threads</span> =<span class="ruby-operator">></span> <span class="ruby-value">20</span>
+ :<span class="ruby-identifier">duration</span> =<span class="ruby-operator">></span> <span class="ruby-value">10</span>.<span class="ruby-identifier">seconds</span>,
+ :<span class="ruby-identifier">output</span> =<span class="ruby-operator">></span> <span class="ruby-string">"test.ljson"</span>,
+ :<span class="ruby-identifier">users</span> =<span class="ruby-operator">></span> <span class="ruby-value">20</span>,
+ :<span class="ruby-identifier">basic_auth</span> =<span class="ruby-operator">></span> [<span class="ruby-string">'username'</span>, <span class="ruby-string">'secret'</span>]
}
</pre>
<p>Single values can be set and retrieved like this:</p>
@@ -174,14 +177,20 @@
<p>The file where the results should be written to. Usually one takes the
<code>*.ljson</code> format which is simply a file that contains a fully
valid JSON object on every line. This makes it easy to process the results
later on, because there’s no need to parse the whole results JSON, which
can get huge, at once.</p>
-</dd><dt>threads
+</dd><dt>users
<dd>
-<p>How many threads execute the benchmarks. This can be overridden by every
-benchmark and defaults to <code>1</code>.</p>
+<p>How many users execute the benchmarks concurrently. This can be overridden
+by every benchmark and defaults to <code>1</code>.</p>
+</dd><dt>basic_auth
+<dd>
+<p>A basic authentication that is used by ALL requests. This can be overridden
+per fragment in every benchmark.</p>
+
+<pre>BigBench.config.basic_auth = ['username', 'password']</pre>
</dd></dl>
</div><!-- description -->
@@ -216,11 +225,11 @@
<p>Returns the current config object</p>
<div class="method-source-code" id="config-source">
- <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 70</span>
+ <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 76</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">config</span>
<span class="ruby-ivar">@config</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- config-source -->
@@ -247,11 +256,11 @@
present yet, they are added to the config object</p>
<div class="method-source-code" id="configure-3D-source">
- <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 61</span>
+ <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">configure=</span>(<span class="ruby-identifier">config</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Config must be a Hash"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">option</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">add_option</span>(<span class="ruby-identifier">option</span>)
<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">send</span> <span class="ruby-node">"#{option}="</span>, <span class="ruby-identifier">value</span>
@@ -281,10 +290,10 @@
<p>Resets the config object</p>
<div class="method-source-code" id="reset-21-source">
- <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 75</span>
+ <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 81</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reset!</span>
<span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- reset-21-source -->