Full documentation

Author: thibault-martinez

docs/html/bundle_8hpp_source.html

@@ -73,7 +73,7 @@
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a367bd6329e56491bdb624c083a1b0902">addNeighbors</a>(const std::vector&lt; std::string &gt; &amp;uris) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#addb57e8a6ba98be6947b008edcb4f8a4">attachToTangle</a>(const Types::Trytes &amp;trunkTransaction, const Types::Trytes &amp;branchTransaction, const int &amp;minWeightMagnitude, const std::vector&lt; Types::Trytes &gt; &amp;trytes) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a0f9605f23dae0920d286d208a5ad806e">broadcastTransactions</a>(const std::vector&lt; Types::Trytes &gt; &amp;trytes) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>Core</b>(const std::string &amp;host, const uint16_t &amp;port, bool localPow=true, int timeout=60) (defined in <a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a>)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#adf36a2dd109c5ccc0d31c58bde7743ca">Core</a>(const std::string &amp;host, const uint16_t &amp;port, bool localPow=true, int timeout=60)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a554184bb1ea1e50e77e2097d75a9cdb0">findTransactions</a>(const std::vector&lt; Types::Trytes &gt; &amp;addresses, const std::vector&lt; Types::Trytes &gt; &amp;tags, const std::vector&lt; Types::Trytes &gt; &amp;approvees, const std::vector&lt; Types::Trytes &gt; &amp;bundles) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a869c73d1cff5cad00e654258a557c51f">getBalances</a>(const std::vector&lt; Types::Trytes &gt; &amp;addresses, const int &amp;threshold) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#ae0fa48b2ebe2fff583b65feb791804a6">getInclusionStates</a>(const std::vector&lt; Types::Trytes &gt; &amp;transactions, const std::vector&lt; Types::Trytes &gt; &amp;tips) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
@@ -85,7 +85,7 @@
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a1779df873b2877aa4ae87421ff947c72">interruptAttachingToTangle</a>() const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a1420b7aa62e8f87bb844063efab9a8c7">removeNeighbors</a>(const std::vector&lt; std::string &gt; &amp;uris) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a31fc2694189aacb9b1f55a1664661b84">storeTransactions</a>(const std::vector&lt; Types::Trytes &gt; &amp;trytes) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>~Core</b>() (defined in <a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a>)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a77c19113fb5e0f7a0a74b992e955ffce">~Core</a>()=default</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/html/class_i_o_t_a_1_1_a_p_i_1_1_core-members.html

@@ -84,9 +84,10 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
-<tr class="memitem:adf36a2dd109c5ccc0d31c58bde7743ca"><td class="memItemLeft" align="right" valign="top"><a id="adf36a2dd109c5ccc0d31c58bde7743ca"></a>
-&#160;</td><td class="memItemRight" valign="bottom"><b>Core</b> (const std::string &amp;host, const uint16_t &amp;port, bool localPow=true, int timeout=60)</td></tr>
+<tr class="memitem:adf36a2dd109c5ccc0d31c58bde7743ca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#adf36a2dd109c5ccc0d31c58bde7743ca">Core</a> (const std::string &amp;host, const uint16_t &amp;port, bool localPow=true, int timeout=60)</td></tr>
 <tr class="separator:adf36a2dd109c5ccc0d31c58bde7743ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a77c19113fb5e0f7a0a74b992e955ffce"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a77c19113fb5e0f7a0a74b992e955ffce">~Core</a> ()=default</td></tr>
+<tr class="separator:a77c19113fb5e0f7a0a74b992e955ffce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa9d616c9db7893159f16ec1b0356927f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_responses_1_1_get_node_info.html">Responses::GetNodeInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#aa9d616c9db7893159f16ec1b0356927f">getNodeInfo</a> () const</td></tr>
 <tr class="separator:aa9d616c9db7893159f16ec1b0356927f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab23af5efc04e5a04daf7c19014eb0d0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_responses_1_1_get_neighbors.html">Responses::GetNeighbors</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#ab23af5efc04e5a04daf7c19014eb0d0b">getNeighbors</a> () const</td></tr>
@@ -119,7 +120,92 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Strict implementation of IOTA core API commands.</p>
 <p><a href="https://iota.readme.io/reference">https://iota.readme.io/reference</a> </p>
-</div><h2 class="groupheader">Member Function Documentation</h2>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="adf36a2dd109c5ccc0d31c58bde7743ca"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#adf36a2dd109c5ccc0d31c58bde7743ca">&#9670;&nbsp;</a></span>Core()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">IOTA::API::Core::Core </td>
+          <td>(</td>
+          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramname"><em>host</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const uint16_t &amp;&#160;</td>
+          <td class="paramname"><em>port</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>localPow</em> = <code>true</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>timeout</em> = <code>60</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Full init ctor.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">host</td><td>The host of the node to connect to. </td></tr>
+    <tr><td class="paramname">port</td><td>The port of the node to connect to. </td></tr>
+    <tr><td class="paramname">localPow</td><td>Whether to do local or remote proof of work. </td></tr>
+    <tr><td class="paramname">timeout</td><td>Timeout for the requests. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a id="a77c19113fb5e0f7a0a74b992e955ffce"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a77c19113fb5e0f7a0a74b992e955ffce">&#9670;&nbsp;</a></span>~Core()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual IOTA::API::Core::~Core </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Default dtor. </p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
 <a id="a367bd6329e56491bdb624c083a1b0902"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a367bd6329e56491bdb624c083a1b0902">&#9670;&nbsp;</a></span>addNeighbors()</h2>
 

docs/html/class_i_o_t_a_1_1_a_p_i_1_1_core.html

@@ -76,7 +76,7 @@
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#aa84894cbaa3fa57252a8a34a75e0d7ab">broadcastAndStore</a>(const std::vector&lt; Types::Trytes &gt; &amp;trytes) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a0f9605f23dae0920d286d208a5ad806e">broadcastTransactions</a>(const std::vector&lt; Types::Trytes &gt; &amp;trytes) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a3d8110759b1c46eaa152fbd882c50b82">bundlesFromAddresses</a>(const std::vector&lt; IOTA::Types::Trytes &gt; &amp;addresses, bool inclusionStates) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Core</b>(const std::string &amp;host, const uint16_t &amp;port, bool localPow=true, int timeout=60) (defined in <a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a>)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#adf36a2dd109c5ccc0d31c58bde7743ca">Core</a>(const std::string &amp;host, const uint16_t &amp;port, bool localPow=true, int timeout=60)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a24292e0b13d2bfe35584f733c322b8c9">Extended</a>(const std::string &amp;host, const uint16_t &amp;port, bool localPow=true, int timeout=60, Crypto::SpongeType cryptoType=Crypto::SpongeType::KERL)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a84744f17dd0c8f5b8b26062aff52d473">findTailTransactionHash</a>(const Types::Trytes &amp;hash) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#acc8853851f134c15210cf2145f1fc4c8">findTransactionObjects</a>(const std::vector&lt; IOTA::Types::Trytes &gt; &amp;addresses) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
@@ -103,15 +103,15 @@
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#ad6f5cdbb41044f62c491f2dab06bf52b">getTrytes</a>(const std::vector&lt; Types::Trytes &gt; &amp;hashes) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a7f7e50d7f7cff0387b8e9b40994c0a7d">initiateTransfer</a>(int securitySum, const Types::Trytes &amp;inputAddress, const Types::Trytes &amp;remainderAddress, std::vector&lt; Models::Transfer &gt; &amp;transfers) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a1779df873b2877aa4ae87421ff947c72">interruptAttachingToTangle</a>() const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>prepareTransfers</b>(const Types::Trytes &amp;seed, int security, std::vector&lt; Models::Transfer &gt; &amp;transfers, const std::string &amp;remainder, const std::vector&lt; Models::Input &gt; &amp;inputs, bool validateInputs=true) const (defined in <a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a>)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#ab9f67c089ccc3b0051fcaddbb147a2af">prepareTransfers</a>(const Types::Trytes &amp;seed, int security, std::vector&lt; Models::Transfer &gt; &amp;transfers, const std::string &amp;remainder, const std::vector&lt; Models::Input &gt; &amp;inputs, bool validateInputs=true) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a1420b7aa62e8f87bb844063efab9a8c7">removeNeighbors</a>(const std::vector&lt; std::string &gt; &amp;uris) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a1ba2e1ee23eea14dd2aa8a1f4b5ee653">replayBundle</a>(const Types::Trytes &amp;transaction, int depth, int minWeightMagnitude) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a9e2687ef56ef0340cd21be97f4d359f8">sendTransfer</a>(const Types::Trytes &amp;seed, int security, int depth, int minWeightMagnitude, std::vector&lt; Models::Transfer &gt; &amp;transfers, const std::vector&lt; Models::Input &gt; &amp;inputs, const Types::Trytes &amp;address) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a58a127282d2f4d9e8dff38a74eb70d67">sendTrytes</a>(const std::vector&lt; Types::Trytes &gt; &amp;trytes, const unsigned int &amp;depth, const unsigned int &amp;minWeightMagnitude) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a31fc2694189aacb9b1f55a1664661b84">storeTransactions</a>(const std::vector&lt; Types::Trytes &gt; &amp;trytes) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a7b5c4d33e956c0d76f98aa5a7a1c6f8f">traverseBundle</a>(const Types::Trytes &amp;trunkTx) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#a395484ad3ff8c373adb8c981b4f79cd3">traverseBundle</a>(const Types::Trytes &amp;trunkTx, Types::Trytes bundleHash, Models::Bundle &amp;bundle) const</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>~Core</b>() (defined in <a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a>)</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html#a77c19113fb5e0f7a0a74b992e955ffce">~Core</a>()=default</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_core.html">IOTA::API::Core</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html#ae292873ec0cd8936d28e7ffe95cb6c83">~Extended</a>()=default</td><td class="entry"><a class="el" href="class_i_o_t_a_1_1_a_p_i_1_1_extended.html">IOTA::API::Extended</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->