Deploying to javadoc from @ e58903f 🚀

elblasco · Jul 30, 2024 · 9f81e19 · 9f81e19
1 parent c35873e
commit 9f81e19
Show file tree

Hide file tree

Showing 44 changed files with 694 additions and 608 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
diff --git a/javadoc/index-all.html b/javadoc/index-all.html
diff --git a/javadoc/it/unitn/disi/ds1/qtop/Client.html b/javadoc/it/unitn/disi/ds1/qtop/Client.html
@@ -96,6 +96,8 @@ <h1 title="Class Client" class="title">Class Client</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Client</span>
 <span class="extends-implements">extends akka.actor.AbstractActor</span></div>
+<div class="block">The Client actor is responsible for sending requests to the Nodes in the network. The requests are randomised
+ between read and write operations. The Client actor also has the ability to make crash a random Node in the network.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">

diff --git a/javadoc/it/unitn/disi/ds1/qtop/Controller.html b/javadoc/it/unitn/disi/ds1/qtop/Controller.html
@@ -90,6 +90,7 @@ <h1 title="Class Controller" class="title">Class Controller</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Controller</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
+<div class="block">Controller for the simulation.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -139,7 +140,9 @@ <h2>Method Summary</h2>
  int&nbsp;decisionTimeout,
  int&nbsp;voteTimeout,
  int&nbsp;writeTimeout)</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Start the simulation (network), with the given parameters.</div>
+</div>
 </div>
 </div>
 </div>
@@ -180,6 +183,15 @@ <h3>startSimulation</h3>
  int&nbsp;decisionTimeout,
  int&nbsp;voteTimeout,
  int&nbsp;writeTimeout)</span></div>
+<div class="block">Start the simulation (network), with the given parameters.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>numberOfNodes</code> - number of nodes</dd>
+<dd><code>numberOfClients</code> - number of clients</dd>
+<dd><code>decisionTimeout</code> - decision timeout</dd>
+<dd><code>voteTimeout</code> - vote timeout</dd>
+<dd><code>writeTimeout</code> - write timeout</dd>
+</dl>
 </section>
 </li>
 <li>

diff --git a/javadoc/it/unitn/disi/ds1/qtop/Logger.html b/javadoc/it/unitn/disi/ds1/qtop/Logger.html
@@ -90,6 +90,7 @@ <h1 title="Class Logger" class="title">Class Logger</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Logger</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
+<div class="block">Logger class to log messages to the console and to files.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">

diff --git a/javadoc/it/unitn/disi/ds1/qtop/Node.html b/javadoc/it/unitn/disi/ds1/qtop/Node.html
@@ -96,6 +96,8 @@ <h1 title="Class Node" class="title">Class Node</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Node</span>
 <span class="extends-implements">extends akka.actor.AbstractActor</span></div>
+<div class="block">Node class, it represents a single node in the network. It can be either receiver or coordinator.
+ During the election all the nodes become voters.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">

diff --git a/javadoc/it/unitn/disi/ds1/qtop/PairsHistory.html b/javadoc/it/unitn/disi/ds1/qtop/PairsHistory.html
@@ -100,6 +100,7 @@ <h1 title="Class PairsHistory" class="title">Class PairsHistory</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PairsHistory</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;akka.japi.Pair&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="Utils.Decision.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.Decision</a>&gt;&gt;&gt;</span></div>
+<div class="block">PairsHistory class to store the history of the pairs and the final decision associated to it</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>

diff --git a/javadoc/it/unitn/disi/ds1/qtop/QTop.html b/javadoc/it/unitn/disi/ds1/qtop/QTop.html
@@ -90,6 +90,7 @@ <h1 title="Class QTop" class="title">Class QTop</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">QTop</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
+<div class="block">Main class to start the simulation.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">

diff --git a/javadoc/it/unitn/disi/ds1/qtop/Simulation.html b/javadoc/it/unitn/disi/ds1/qtop/Simulation.html
@@ -90,6 +90,7 @@ <h1 title="Class Simulation" class="title">Class Simulation</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Simulation</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
+<div class="block">Simulation class layer between the UserInterface and the network.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -119,17 +120,23 @@ <h2>Method Summary</h2>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addCrashNode(int)" class="member-name-link">addCrashNode</a><wbr>(int&nbsp;crashType)</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Add a crash to the network.</div>
+</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#exit()" class="member-name-link">exit</a>()</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Shut down the network.</div>
+</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start(int,int,int,int,int)" class="member-name-link">start</a><wbr>(int&nbsp;numberOfNodes,
  int&nbsp;numberOfClients,
  int&nbsp;decisionTimeout,
  int&nbsp;voteTimeout,
  int&nbsp;writeTimeout)</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Start the network with the given parameters.</div>
+</div>
 </div>
 </div>
 </div>
@@ -169,18 +176,33 @@ <h3>start</h3>
  int&nbsp;decisionTimeout,
  int&nbsp;voteTimeout,
  int&nbsp;writeTimeout)</span></div>
+<div class="block">Start the network with the given parameters.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>numberOfNodes</code> - number of nodes</dd>
+<dd><code>numberOfClients</code> - number of clients</dd>
+<dd><code>decisionTimeout</code> - decision timeout</dd>
+<dd><code>voteTimeout</code> - vote timeout</dd>
+<dd><code>writeTimeout</code> - write timeout</dd>
+</dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addCrashNode(int)">
 <h3>addCrashNode</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addCrashNode</span><wbr><span class="parameters">(int&nbsp;crashType)</span></div>
+<div class="block">Add a crash to the network.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>crashType</code> - the type of crash</dd>
+</dl>
 </section>
 </li>
 <li>
 <section class="detail" id="exit()">
 <h3>exit</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">exit</span>()</div>
+<div class="block">Shut down the network.</div>
 </section>
 </li>
 </ul>

diff --git a/javadoc/it/unitn/disi/ds1/qtop/SimulationCallback.html b/javadoc/it/unitn/disi/ds1/qtop/SimulationCallback.html
@@ -90,6 +90,7 @@ <h1 title="Interface SimulationCallback" class="title">Interface SimulationCallb
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SimulationCallback</span></div>
+<div class="block">SimulationCallback interface to handle the simulation callbacks</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -106,10 +107,14 @@ <h2>Method Summary</h2>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clientMenu()" class="member-name-link">clientMenu</a>()</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="block">Display to the user the textual menu.</div>
+</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#start()" class="member-name-link">start</a>()</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="block">Start the simulation.</div>
+</div>
 </div>
 </div>
 </div>
@@ -128,12 +133,14 @@ <h2>Method Details</h2>
 <section class="detail" id="start()">
 <h3>start</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">start</span>()</div>
+<div class="block">Start the simulation.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="clientMenu()">
 <h3>clientMenu</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">clientMenu</span>()</div>
+<div class="block">Display to the user the textual menu.</div>
 </section>
 </li>
 </ul>

diff --git a/javadoc/it/unitn/disi/ds1/qtop/TimeOutManager.html b/javadoc/it/unitn/disi/ds1/qtop/TimeOutManager.html
@@ -98,6 +98,7 @@ <h1 title="Class TimeOutManager" class="title">Class TimeOutManager</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TimeOutManager</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/EnumMap.html" title="class or interface in java.util" class="external-link">EnumMap</a>&lt;<a href="Utils.TimeOutReason.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.TimeOutReason</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;akka.japi.Pair&lt;akka.actor.Cancellable,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&gt;&gt;</span></div>
+<div class="block">TimeOutManager class to manage the timeouts of a Node</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>

diff --git a/javadoc/it/unitn/disi/ds1/qtop/UserInterface.html b/javadoc/it/unitn/disi/ds1/qtop/UserInterface.html
@@ -95,6 +95,7 @@ <h1 title="Class UserInterface" class="title">Class UserInterface</h1>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">UserInterface</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 implements <a href="SimulationCallback.html" title="interface in it.unitn.disi.ds1.qtop">SimulationCallback</a></span></div>
+<div class="block">UserInterface class to manage/generate the user interface.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">

diff --git a/javadoc/it/unitn/disi/ds1/qtop/Utils.CountDown.html b/javadoc/it/unitn/disi/ds1/qtop/Utils.CountDown.html
@@ -90,6 +90,11 @@ <h1 title="Record Class Utils.CountDown" class="title">Record Class Utils.CountD
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
+<dt>Record Components:</dt>
+<dd><code><span id="param-reason">reason</span></code> - the reason for the timeout</dd>
+<dd><code><span id="param-epoch">epoch</span></code> - (optional) epoch associated to it</dd>
+</dl>
+<dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
 </dl>
@@ -101,6 +106,7 @@ <h1 title="Record Class Utils.CountDown" class="title">Record Class Utils.CountD
 <div class="type-signature"><span class="modifiers">public static record </span><span class="element-name type-name-label">Utils.CountDown</span>(<a href="Utils.TimeOutReason.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.TimeOutReason</a>&nbsp;reason, <a href="Utils.EpochPair.html" title="class in it.unitn.disi.ds1.qtop">Utils.EpochPair</a>&nbsp;epoch)
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">Record</a>
 implements <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
+<div class="block">Message self-lopped by a node to trigger a timeout.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
@@ -142,7 +148,7 @@ <h2>Method Summary</h2>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Utils.EpochPair.html" title="class in it.unitn.disi.ds1.qtop">Utils.EpochPair</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#epoch()" class="member-name-link">epoch</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Returns the value of the <code>epoch</code> record component.</div>
+<div class="block">Returns the value of the <a href="#param-epoch"><code>epoch</code></a> record component.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</code></div>
@@ -157,7 +163,7 @@ <h2>Method Summary</h2>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Utils.TimeOutReason.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.TimeOutReason</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reason()" class="member-name-link">reason</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Returns the value of the <code>reason</code> record component.</div>
+<div class="block">Returns the value of the <a href="#param-reason"><code>reason</code></a> record component.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
@@ -189,8 +195,8 @@ <h3>CountDown</h3>
 <div class="block">Creates an instance of a <code>CountDown</code> record class.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
-<dd><code>reason</code> - the value for the <code>reason</code> record component</dd>
-<dd><code>epoch</code> - the value for the <code>epoch</code> record component</dd>
+<dd><code>reason</code> - the value for the <a href="#param-reason"><code>reason</code></a> record component</dd>
+<dd><code>epoch</code> - the value for the <a href="#param-epoch"><code>epoch</code></a> record component</dd>
 </dl>
 </section>
 </li>
@@ -247,21 +253,21 @@ <h3>equals</h3>
 <section class="detail" id="reason()">
 <h3>reason</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Utils.TimeOutReason.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.TimeOutReason</a></span>&nbsp;<span class="element-name">reason</span>()</div>
-<div class="block">Returns the value of the <code>reason</code> record component.</div>
+<div class="block">Returns the value of the <a href="#param-reason"><code>reason</code></a> record component.</div>
 <dl class="notes">
 <dt>Returns:</dt>
-<dd>the value of the <code>reason</code> record component</dd>
+<dd>the value of the <a href="#param-reason"><code>reason</code></a> record component</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="epoch()">
 <h3>epoch</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Utils.EpochPair.html" title="class in it.unitn.disi.ds1.qtop">Utils.EpochPair</a></span>&nbsp;<span class="element-name">epoch</span>()</div>
-<div class="block">Returns the value of the <code>epoch</code> record component.</div>
+<div class="block">Returns the value of the <a href="#param-epoch"><code>epoch</code></a> record component.</div>
 <dl class="notes">
 <dt>Returns:</dt>
-<dd>the value of the <code>epoch</code> record component</dd>
+<dd>the value of the <a href="#param-epoch"><code>epoch</code></a> record component</dd>
 </dl>
 </section>
 </li>

diff --git a/javadoc/it/unitn/disi/ds1/qtop/Utils.CrashACK.html b/javadoc/it/unitn/disi/ds1/qtop/Utils.CrashACK.html
@@ -101,6 +101,7 @@ <h1 title="Record Class Utils.CrashACK" class="title">Record Class Utils.CrashAC
 <div class="type-signature"><span class="modifiers">public static record </span><span class="element-name type-name-label">Utils.CrashACK</span>()
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Record.html" title="class or interface in java.lang" class="external-link">Record</a>
 implements <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
+<div class="block">Message to acknowledge a CrashRequest.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>