Skip to content

Commit

Permalink
Deploying to javadoc from @ 66fb234 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
elblasco committed Jul 30, 2024
1 parent 1a481ab commit 0099b3e
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 131 deletions.
28 changes: 0 additions & 28 deletions javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,6 @@ <h2 class="title" id="I:A">A</h2>
</dl>
<h2 class="title" id="I:B">B</h2>
<dl class="index">
<dt><a href="it/unitn/disi/ds1/qtop/Node.html#becomeCoordinator()" class="member-name-link">becomeCoordinator()</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a></dt>
<dd>
<div class="block">Make the current Node become a coordinator.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Node.html#becomeReceiver()" class="member-name-link">becomeReceiver()</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a></dt>
<dd>
<div class="block">Make the current Node become a receiver, aka, a normal replica.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Node.html#becomeVoter()" class="member-name-link">becomeVoter()</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a></dt>
<dd>
<div class="block">Make the current Node become a voter for the election process.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Utils.Election.html#bestCandidateId()" class="member-name-link">bestCandidateId()</a> - Method in record class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.Election.html" title="class in it.unitn.disi.ds1.qtop">Utils.Election</a></dt>
<dd>
<div class="block">Returns the value of the <a href="./it/unitn/disi/ds1/qtop/Utils.Election.html#param-bestCandidateId"><code>bestCandidateId</code></a> record component.</div>
Expand Down Expand Up @@ -137,18 +125,6 @@ <h2 class="title" id="I:C">C</h2>
<dd>
<div class="block">Coordinator crash after reaching the quorum.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Node.html#coordinatorBehaviour()" class="member-name-link">coordinatorBehaviour()</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a></dt>
<dd>
<div class="block">Mask for to the Coordinator actor.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Node.html#coordinatorOnStartMessage(it.unitn.disi.ds1.qtop.Utils.StartMessage)" class="member-name-link">coordinatorOnStartMessage(Utils.StartMessage)</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a></dt>
<dd>
<div class="block">Initial set up for the Coordinator, should be called whenever an ActorRef becomes Coordinator.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Node.html#coordinatorOnVoteResponse(it.unitn.disi.ds1.qtop.Utils.VoteResponse)" class="member-name-link">coordinatorOnVoteResponse(Utils.VoteResponse)</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a></dt>
<dd>
<div class="block">Register a Node vote.</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>
<div class="block">Creates an instance of a <code>CountDown</code> record class.</div>
Expand Down Expand Up @@ -995,10 +971,6 @@ <h2 class="title" id="I:V">V</h2>
<dd>
<div class="block">Creates an instance of a <code>VotePair</code> record class.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Node.html#voterBehaviour()" class="member-name-link">voterBehaviour()</a> - Method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Node.html" title="class in it.unitn.disi.ds1.qtop">Node</a></dt>
<dd>
<div class="block">Mask for to the voter actor.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Utils.VoteRequest.html#%3Cinit%3E(int,it.unitn.disi.ds1.qtop.Utils.EpochPair)" class="member-name-link">VoteRequest(int, Utils.EpochPair)</a> - Constructor for record class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.VoteRequest.html" title="class in it.unitn.disi.ds1.qtop">Utils.VoteRequest</a></dt>
<dd>
<div class="block">Creates an instance of a <code>VoteRequest</code> record class.</div>
Expand Down
102 changes: 0 additions & 102 deletions javadoc/it/unitn/disi/ds1/qtop/Node.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,36 +142,6 @@ <h2>Method Summary</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<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="#becomeCoordinator()" class="member-name-link">becomeCoordinator</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Make the current Node become a coordinator.</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="#becomeReceiver()" class="member-name-link">becomeReceiver</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Make the current Node become a receiver, aka, a normal replica.</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="#becomeVoter()" class="member-name-link">becomeVoter</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Make the current Node become a voter for the election process.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>akka.actor.AbstractActor.Receive</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#coordinatorBehaviour()" class="member-name-link">coordinatorBehaviour</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Mask for to the Coordinator actor.</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="#coordinatorOnStartMessage(it.unitn.disi.ds1.qtop.Utils.StartMessage)" class="member-name-link">coordinatorOnStartMessage</a><wbr>(<a href="Utils.StartMessage.html" title="class in it.unitn.disi.ds1.qtop">Utils.StartMessage</a>&nbsp;msg)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Initial set up for the Coordinator, should be called whenever an ActorRef becomes Coordinator.</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="#coordinatorOnVoteResponse(it.unitn.disi.ds1.qtop.Utils.VoteResponse)" class="member-name-link">coordinatorOnVoteResponse</a><wbr>(@NotNull <a href="Utils.VoteResponse.html" title="class in it.unitn.disi.ds1.qtop">Utils.VoteResponse</a>&nbsp;msg)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Register a Node vote.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>akka.actor.AbstractActor.Receive</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createReceive()" class="member-name-link">createReceive</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
Expand All @@ -192,11 +162,6 @@ <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">Send a message to a destination actor with a random delay, within 0 and 29 milliseconds.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>akka.actor.AbstractActor.Receive</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#voterBehaviour()" class="member-name-link">voterBehaviour</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Mask for to the voter actor.</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -263,38 +228,6 @@ <h3>tell</h3>
</section>
</li>
<li>
<section class="detail" id="becomeCoordinator()">
<h3>becomeCoordinator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">becomeCoordinator</span>()</div>
<div class="block">Make the current Node become a coordinator.</div>
</section>
</li>
<li>
<section class="detail" id="becomeVoter()">
<h3>becomeVoter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">becomeVoter</span>()</div>
<div class="block">Make the current Node become a voter for the election process.</div>
</section>
</li>
<li>
<section class="detail" id="becomeReceiver()">
<h3>becomeReceiver</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">becomeReceiver</span>()</div>
<div class="block">Make the current Node become a receiver, aka, a normal replica.</div>
</section>
</li>
<li>
<section class="detail" id="voterBehaviour()">
<h3>voterBehaviour</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">akka.actor.AbstractActor.Receive</span>&nbsp;<span class="element-name">voterBehaviour</span>()</div>
<div class="block">Mask for to the voter actor.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the Receive object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createReceive()">
<h3>createReceive</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">akka.actor.AbstractActor.Receive</span>&nbsp;<span class="element-name">createReceive</span>()</div>
Expand All @@ -307,41 +240,6 @@ <h3>createReceive</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="coordinatorBehaviour()">
<h3>coordinatorBehaviour</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">akka.actor.AbstractActor.Receive</span>&nbsp;<span class="element-name">coordinatorBehaviour</span>()</div>
<div class="block">Mask for to the Coordinator actor.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the Receive object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="coordinatorOnStartMessage(it.unitn.disi.ds1.qtop.Utils.StartMessage)">
<h3>coordinatorOnStartMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">coordinatorOnStartMessage</span><wbr><span class="parameters">(<a href="Utils.StartMessage.html" title="class in it.unitn.disi.ds1.qtop">Utils.StartMessage</a>&nbsp;msg)</span></div>
<div class="block">Initial set up for the Coordinator, should be called whenever an ActorRef becomes Coordinator.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>msg</code> - the init message</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="coordinatorOnVoteResponse(it.unitn.disi.ds1.qtop.Utils.VoteResponse)">
<h3>coordinatorOnVoteResponse</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">coordinatorOnVoteResponse</span><wbr><span class="parameters">(@NotNull
@NotNull <a href="Utils.VoteResponse.html" title="class in it.unitn.disi.ds1.qtop">Utils.VoteResponse</a>&nbsp;msg)</span></div>
<div class="block">Register a Node vote.
Then, if the quorum is reached or everybody voted, fix the decision and multicast the decision.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>msg</code> - request to make a vote</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down
Loading

0 comments on commit 0099b3e

Please sign in to comment.