Updated API and docs

JeffersonLab · Sep 19, 2024 · be7f65f · be7f65f
1 parent 42ed863
commit be7f65f
Show file tree

Hide file tree

Showing 13 changed files with 339 additions and 304 deletions.
diff --git a/docs/classe2sar_1_1_net_util.html b/docs/classe2sar_1_1_net_util.html
@@ -98,8 +98,36 @@
 Static Public Member Functions</h2></td></tr>
 <tr class="memitem:a407c8e63faa4e7dffad004927a6f551a" id="r_a407c8e63faa4e7dffad004927a6f551a"><td class="memItemLeft" align="right" valign="top">static u_int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a407c8e63faa4e7dffad004927a6f551a">getMTU</a> (const std::string &amp;interfaceName)</td></tr>
 <tr class="separator:a407c8e63faa4e7dffad004927a6f551a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af867824b8202ec0cf8a17e476cfb9028" id="r_af867824b8202ec0cf8a17e476cfb9028"><td class="memItemLeft" align="right" valign="top">static result&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af867824b8202ec0cf8a17e476cfb9028">getHostName</a> ()</td></tr>
+<tr class="separator:af867824b8202ec0cf8a17e476cfb9028"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Member Function Documentation</h2>
+<a id="af867824b8202ec0cf8a17e476cfb9028" name="af867824b8202ec0cf8a17e476cfb9028"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af867824b8202ec0cf8a17e476cfb9028">&#9670;&#160;</a></span>getHostName()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">result&lt; std::string &gt; e2sar::NetUtil::getHostName </td>
+          <td>(</td>
+          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">static</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Get the hostname of the host </p>
+
+</div>
+</div>
 <a id="a407c8e63faa4e7dffad004927a6f551a" name="a407c8e63faa4e7dffad004927a6f551a"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a407c8e63faa4e7dffad004927a6f551a">&#9670;&#160;</a></span>getMTU()</h2>
 
@@ -129,7 +157,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a407c8e63faa4e7dffad00492
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>MTU or 1500 as the best guess</dd></dl>
-<p>Get MTU of a given interface </p>
+<p>Get MTU of a given interface. Used in constructors, so doesn't return error. </p>
 
 </div>
 </div>

diff --git a/docs/classe2sar_1_1_reassembler.html b/docs/classe2sar_1_1_reassembler.html
@@ -113,8 +113,8 @@
 <tr class="memitem:a4cd88bc7413ab25f6f16769978541f09" id="r_a4cd88bc7413ab25f6f16769978541f09"><td class="memItemLeft" align="right" valign="top"><a id="a4cd88bc7413ab25f6f16769978541f09" name="a4cd88bc7413ab25f6f16769978541f09"></a>
 <a class="el" href="classe2sar_1_1_reassembler.html">Reassembler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classe2sar_1_1_reassembler.html">Reassembler</a> &amp;o)=delete</td></tr>
 <tr class="separator:a4cd88bc7413ab25f6f16769978541f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5804969f47c755008cf171c765e3b7e5" id="r_a5804969f47c755008cf171c765e3b7e5"><td class="memItemLeft" align="right" valign="top">result&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5804969f47c755008cf171c765e3b7e5">registerWorker</a> (const std::string &amp;node_name, float weight, float min_factor, float max_factor) noexcept</td></tr>
-<tr class="separator:a5804969f47c755008cf171c765e3b7e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0dad039205e55e202942af00ae4c68d6" id="r_a0dad039205e55e202942af00ae4c68d6"><td class="memItemLeft" align="right" valign="top">result&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0dad039205e55e202942af00ae4c68d6">registerWorker</a> (const std::string &amp;node_name) noexcept</td></tr>
+<tr class="separator:a0dad039205e55e202942af00ae4c68d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af1d74bb1d375c7d0d513075b49046ac7" id="r_af1d74bb1d375c7d0d513075b49046ac7"><td class="memItemLeft" align="right" valign="top">result&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af1d74bb1d375c7d0d513075b49046ac7">deregisterWorker</a> () noexcept</td></tr>
 <tr class="separator:af1d74bb1d375c7d0d513075b49046ac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:adcdcbd4ac51cda97e16d74d20ba25c7f" id="r_adcdcbd4ac51cda97e16d74d20ba25c7f"><td class="memItemLeft" align="right" valign="top">result&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adcdcbd4ac51cda97e16d74d20ba25c7f">openAndStart</a> () noexcept</td></tr>
@@ -507,8 +507,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a15704c5f2d91322390cb0899
 
 </div>
 </div>
-<a id="a5804969f47c755008cf171c765e3b7e5" name="a5804969f47c755008cf171c765e3b7e5"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a5804969f47c755008cf171c765e3b7e5">&#9670;&#160;</a></span>registerWorker()</h2>
+<a id="a0dad039205e55e202942af00ae4c68d6" name="a0dad039205e55e202942af00ae4c68d6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0dad039205e55e202942af00ae4c68d6">&#9670;&#160;</a></span>registerWorker()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -519,22 +519,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5804969f47c755008cf171c7
         <tr>
           <td class="memname">result&lt; int &gt; e2sar::Reassembler::registerWorker </td>
           <td>(</td>
-          <td class="paramtype">const std::string &amp;</td>          <td class="paramname"><span class="paramname"><em>node_name</em></span>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>weight</em></span>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>min_factor</em></span>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
+          <td class="paramtype">const std::string &amp;</td>          <td class="paramname"><span class="paramname"><em>node_name</em></span></td><td>)</td>
           <td></td>
-          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>max_factor</em></span>&#160;)</td>
         </tr>
       </table>
   </td>
@@ -546,9 +532,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5804969f47c755008cf171c7
 <p>Register a worker with the control plane </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">node_name</td><td>- name of this node (any unique string) </td></tr>
-    <tr><td class="paramname">weight</td><td>- weight given to this node in terms of processing power </td></tr>
-    <tr><td class="paramname">min_factor</td><td>- multiplied with the number of slots that would be assigned evenly to determine min number of slots for example, 4 nodes with a minFactor of 0.5 = (512 slots / 4) * 0.5 = min 64 slots </td></tr>
-    <tr><td class="paramname">max_factor</td><td>- multiplied with the number of slots that would be assigned evenly to determine max number of slots for example, 4 nodes with a maxFactor of 2 = (512 slots / 4) * 2 = max 256 slots set to 0 to specify no maximum </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/docs/doxygen_crawl.html b/docs/doxygen_crawl.html
@@ -147,10 +147,11 @@
 <a href="classe2sar_1_1_l_b_manager.html#aff4d68d73fd135c879e77e77aabef0c5"/>
 <a href="classe2sar_1_1_net_util.html"/>
 <a href="classe2sar_1_1_net_util.html#a407c8e63faa4e7dffad004927a6f551a"/>
+<a href="classe2sar_1_1_net_util.html#af867824b8202ec0cf8a17e476cfb9028"/>
 <a href="classe2sar_1_1_reassembler.html"/>
+<a href="classe2sar_1_1_reassembler.html#a0dad039205e55e202942af00ae4c68d6"/>
 <a href="classe2sar_1_1_reassembler.html#a15704c5f2d91322390cb0899ff4bbac9"/>
 <a href="classe2sar_1_1_reassembler.html#a1dac1a760ca3e903abd3e3a8000d5a5d"/>
-<a href="classe2sar_1_1_reassembler.html#a5804969f47c755008cf171c765e3b7e5"/>
 <a href="classe2sar_1_1_reassembler.html#a5cda1d99a76c3b1c0e62397d695455f3"/>
 <a href="classe2sar_1_1_reassembler.html#a679e7fc30486417e84976857b47bb440"/>
 <a href="classe2sar_1_1_reassembler.html#a782bf8bedae1067fefbcbb8f8554a2b7"/>