Deploying to javadoc from @ f4ef0ac 🚀

javadoc/index-all.html

@@ -105,25 +105,13 @@ <h2 class="title" id="I:C">C</h2>
 </dd>
 <dt><a href="it/unitn/disi/ds1/qtop/Controller.html#%3Cinit%3E(it.unitn.disi.ds1.qtop.Simulation,it.unitn.disi.ds1.qtop.UserInterface)" class="member-name-link">Controller(Simulation, UserInterface)</a> - Constructor for class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Controller.html" title="class in it.unitn.disi.ds1.qtop">Controller</a></dt>
 <dd>&nbsp;</dd>
-<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#COORDINATOR_AFTER_RW_REQUEST" class="member-name-link">COORDINATOR_AFTER_RW_REQUEST</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
+<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#COORDINATOR_ON_DECISION_RESPONSE" class="member-name-link">COORDINATOR_ON_DECISION_RESPONSE</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
 <dd>
-<div class="block">Coordinator crash after propagating a R/W request.</div>
+<div class="block">Probabilistic crash during a decision multicast.</div>
 </dd>
-<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#COORDINATOR_BEFORE_RW_REQUEST" class="member-name-link">COORDINATOR_BEFORE_RW_REQUEST</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
+<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#COORDINATOR_ON_VOTE_REQUEST" class="member-name-link">COORDINATOR_ON_VOTE_REQUEST</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
 <dd>
-<div class="block">Coordinator crash before receiving propagating a R/W request.</div>
-</dd>
-<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#COORDINATOR_NO_QUORUM" class="member-name-link">COORDINATOR_NO_QUORUM</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
-<dd>
-<div class="block">Coordinator crash after receiving a vote.</div>
-</dd>
-<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#COORDINATOR_ON_COMMUNICATION" class="member-name-link">COORDINATOR_ON_COMMUNICATION</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
-<dd>
-<div class="block">Probabilistic crash during a multicast.</div>
-</dd>
-<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#COORDINATOR_QUORUM" class="member-name-link">COORDINATOR_QUORUM</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
-<dd>
-<div class="block">Coordinator crash after reaching the quorum.</div>
+<div class="block">Probabilistic crash during a vote request multicast.</div>
 </dd>
 <dt><a href="it/unitn/disi/ds1/qtop/Utils.CountDown.html#%3Cinit%3E(it.unitn.disi.ds1.qtop.Utils.TimeOutReason,it.unitn.disi.ds1.qtop.Utils.EpochPair)" class="member-name-link">CountDown(Utils.TimeOutReason, Utils.EpochPair)</a> - Constructor for record class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CountDown.html" title="class in it.unitn.disi.ds1.qtop">Utils.CountDown</a></dt>
 <dd>
@@ -333,14 +321,19 @@ <h2 class="title" id="I:G">G</h2>
 <dd>
 <div class="block">Get the latest epoch and iteration.</div>
 </dd>
+<dt><a href="it/unitn/disi/ds1/qtop/PairsHistory.html#getLatestCommitted()" class="member-name-link">getLatestCommitted()</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/PairsHistory.html" title="class in it.unitn.disi.ds1.qtop">PairsHistory</a></dt>
+<dd>
+<div class="block">Get the epoch and iteration of the last commited transaction, by commited transaction we consider a
+ transaction that has non-pending state.</div>
+</dd>
 <dt><a href="it/unitn/disi/ds1/qtop/Utils.StartMessage.html#group()" class="member-name-link">group()</a> - Method in record class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.StartMessage.html" title="class in it.unitn.disi.ds1.qtop">Utils.StartMessage</a></dt>
 <dd>
 <div class="block">Returns the value of the <code>group</code> record component.</div>
 </dd>
 </dl>
 <h2 class="title" id="I:H">H</h2>
 <dl class="index">
-<dt><a href="it/unitn/disi/ds1/qtop/TimeOutManager.html#handleCountDown(it.unitn.disi.ds1.qtop.Utils.TimeOutReason,int,it.unitn.disi.ds1.qtop.Node)" class="member-name-link">handleCountDown(Utils.TimeOutReason, int, Node)</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/TimeOutManager.html" title="class in it.unitn.disi.ds1.qtop">TimeOutManager</a></dt>
+<dt><a href="it/unitn/disi/ds1/qtop/TimeOutManager.html#handleCountDown(it.unitn.disi.ds1.qtop.Utils.TimeOutReason,int,akka.actor.ActorRef)" class="member-name-link">handleCountDown(Utils.TimeOutReason, int, ActorRef)</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/TimeOutManager.html" title="class in it.unitn.disi.ds1.qtop">TimeOutManager</a></dt>
 <dd>
 <div class="block">Decrease the time left for a specific count-down.</div>
 </dd>
@@ -571,7 +564,13 @@ <h2 class="title" id="I:P">P</h2>
 <div class="block">PairsHistory class to store the history of the pairs and the final decision associated to it</div>
 </dd>
 <dt><a href="it/unitn/disi/ds1/qtop/PairsHistory.html#%3Cinit%3E()" class="member-name-link">PairsHistory()</a> - Constructor for class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/PairsHistory.html" title="class in it.unitn.disi.ds1.qtop">PairsHistory</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Default constructor.</div>
+</dd>
+<dt><a href="it/unitn/disi/ds1/qtop/PairsHistory.html#%3Cinit%3E(it.unitn.disi.ds1.qtop.PairsHistory)" class="member-name-link">PairsHistory(PairsHistory)</a> - Constructor for class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/PairsHistory.html" title="class in it.unitn.disi.ds1.qtop">PairsHistory</a></dt>
+<dd>
+<div class="block">Copy constructor.</div>
+</dd>
 <dt><a href="it/unitn/disi/ds1/qtop/Utils.Decision.html#PENDING" class="member-name-link">PENDING</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.Decision.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.Decision</a></dt>
 <dd>
 <div class="block">The coordinator is still waiting for the votes.</div>

javadoc/it/unitn/disi/ds1/qtop/PairsHistory.html

@@ -130,7 +130,13 @@ <h2>Constructor Summary</h2>
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">PairsHistory</a>()</code></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Default constructor.</div>
+</div>
+<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(it.unitn.disi.ds1.qtop.PairsHistory)" class="member-name-link">PairsHistory</a><wbr>(@NotNull <a href="PairsHistory.html" title="class in it.unitn.disi.ds1.qtop">PairsHistory</a>&nbsp;sourceObject)</code></div>
+<div class="col-last odd-row-color">
+<div class="block">Copy constructor.</div>
+</div>
 </div>
 </section>
 </li>
@@ -150,28 +156,34 @@ <h2>Method Summary</h2>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get the latest epoch and iteration.</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="#insert(int,int,int)" class="member-name-link">insert</a><wbr>(int&nbsp;e,
+<div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLatestCommitted()" class="member-name-link">getLatestCommitted</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Get the epoch and iteration of the last commited transaction, by commited transaction we consider a
+ transaction that has non-pending state.</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="#insert(int,int,int)" class="member-name-link">insert</a><wbr>(int&nbsp;e,
  int&nbsp;i,
  int&nbsp;element)</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Insert a new element in the history.</div>
 </div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readValidVariable()" class="member-name-link">readValidVariable</a>()</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readValidVariable()" class="member-name-link">readValidVariable</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Read the last valid, i.e., committed, variable.</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="#setState(int,int,it.unitn.disi.ds1.qtop.Utils.Decision)" class="member-name-link">setState</a><wbr>(int&nbsp;e,
+<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="#setState(int,int,it.unitn.disi.ds1.qtop.Utils.Decision)" class="member-name-link">setState</a><wbr>(int&nbsp;e,
  int&nbsp;i,
  <a href="Utils.Decision.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.Decision</a>&nbsp;finalState)</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get the state of the given epoch and iteration.</div>
 </div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 odd-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>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 </div>
 </div>
 </div>
@@ -205,6 +217,19 @@ <h2>Constructor Details</h2>
 <section class="detail" id="&lt;init&gt;()">
 <h3>PairsHistory</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PairsHistory</span>()</div>
+<div class="block">Default constructor.</div>
+</section>
+</li>
+<li>
+<section class="detail" id="&lt;init&gt;(it.unitn.disi.ds1.qtop.PairsHistory)">
+<h3>PairsHistory</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PairsHistory</span><wbr><span class="parameters">(@NotNull
+ @NotNull <a href="PairsHistory.html" title="class in it.unitn.disi.ds1.qtop">PairsHistory</a>&nbsp;sourceObject)</span></div>
+<div class="block">Copy constructor.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>sourceObject</code> - source object to copy</dd>
+</dl>
 </section>
 </li>
 </ul>
@@ -268,6 +293,18 @@ <h3>getLatest</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="getLatestCommitted()">
+<h3>getLatestCommitted</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">getLatestCommitted</span>()</div>
+<div class="block">Get the epoch and iteration of the last commited transaction, by commited transaction we consider a
+ transaction that has non-pending state.</div>
+<dl class="notes">
+<dt>Returns:</dt>
+<dd>the latest epoch and iteration committed</dd>
+</dl>
+</section>
+</li>
+<li>
 <section class="detail" id="toString()">
 <h3>toString</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">toString</span>()</div>

javadoc/it/unitn/disi/ds1/qtop/TimeOutManager.html

@@ -164,9 +164,9 @@ <h2>Method Summary</h2>
 <div class="block">Reset the data structure to start a new post election phase.</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="#handleCountDown(it.unitn.disi.ds1.qtop.Utils.TimeOutReason,int,it.unitn.disi.ds1.qtop.Node)" class="member-name-link">handleCountDown</a><wbr>(<a href="Utils.TimeOutReason.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.TimeOutReason</a>&nbsp;reason,
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handleCountDown(it.unitn.disi.ds1.qtop.Utils.TimeOutReason,int,akka.actor.ActorRef)" class="member-name-link">handleCountDown</a><wbr>(<a href="Utils.TimeOutReason.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.TimeOutReason</a>&nbsp;reason,
  int&nbsp;i,
- <a href="Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a>&nbsp;node)</code></div>
+ akka.actor.ActorRef&nbsp;nodeRef)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Decrease the time left for a specific count-down.</div>
 </div>
@@ -252,17 +252,17 @@ <h3>startCountDown</h3>
 </section>
 </li>
 <li>
-<section class="detail" id="handleCountDown(it.unitn.disi.ds1.qtop.Utils.TimeOutReason,int,it.unitn.disi.ds1.qtop.Node)">
+<section class="detail" id="handleCountDown(it.unitn.disi.ds1.qtop.Utils.TimeOutReason,int,akka.actor.ActorRef)">
 <h3>handleCountDown</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">handleCountDown</span><wbr><span class="parameters">(<a href="Utils.TimeOutReason.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.TimeOutReason</a>&nbsp;reason,
  int&nbsp;i,
- <a href="Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a>&nbsp;node)</span></div>
+ akka.actor.ActorRef&nbsp;nodeRef)</span></div>
 <div class="block">Decrease the time left for a specific count-down.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>reason</code> - the reason for the count-down</dd>
 <dd><code>i</code> - the index of the count-down</dd>
-<dd><code>node</code> - the node that is handling the count-down</dd>
+<dd><code>nodeRef</code> - the ActorRef of the node that is handling the count-down</dd>
 </dl>
 </section>
 </li>