deploy: ec9dbfbaa0a311ed86020fb9f847a70cd948f842

diff --git a/UDPC_8h.html b/UDPC_8h.html
index 5f0d73357dc66bcf33961d6e3a2bf810a1a4a5ed..0ca1b7137c824f2fa8612c8a416ea5eb6bca387e 100644 (file)
--- a/UDPC_8h.html
+++ b/UDPC_8h.html
@@ -307,7 +307,7 @@ UDPC_EXPORT void&#160;</td><td class="memItemRight" valign="bottom"><b>UDPC_atos
 <tr class="memdesc:a2e47fb8779abe3a9db72a08bf494dc75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free an addr string created with <a class="el" href="#a939b6c407297f6cf913f2983869f051f" title="Similar to UPDC_atostr(), but the returned ptr must be free&#39;d.">UDPC_atostr_unsafe()</a> and zeroes the pointer.  <br /></td></tr>
 <tr class="separator:a2e47fb8779abe3a9db72a08bf494dc75"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aeb40d2c285eec0c53dd77e9d2cfeb5a2" id="r_aeb40d2c285eec0c53dd77e9d2cfeb5a2"><td class="memItemLeft" align="right" valign="top">UDPC_EXPORT int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb40d2c285eec0c53dd77e9d2cfeb5a2">UDPC_set_heartbeat_millis</a> (UDPC_HContext ctx, unsigned int millis)</td></tr>
-<tr class="memdesc:aeb40d2c285eec0c53dd77e9d2cfeb5a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the amount of time between heartbeat packets.  <br /></td></tr>
+<tr class="memdesc:aeb40d2c285eec0c53dd77e9d2cfeb5a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">REVERTED FUNCTION, SEE DETAILS.  <br /></td></tr>
 <tr class="separator:aeb40d2c285eec0c53dd77e9d2cfeb5a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2ae8e7d87f785dd3b3353a00005c3dc6" id="r_a2ae8e7d87f785dd3b3353a00005c3dc6"><td class="memItemLeft" align="right" valign="top"><a id="a2ae8e7d87f785dd3b3353a00005c3dc6" name="a2ae8e7d87f785dd3b3353a00005c3dc6"></a>
 UDPC_EXPORT UDPC_IPV6_ADDR_TYPE&#160;</td><td class="memItemRight" valign="bottom"><b>UDPC_strtoa</b> (const char *addrStr)</td></tr>
@@ -1800,12 +1800,9 @@ mode", the fastest packet sending rate is 1 packet per 0.1 seconds, or 10 packet
       </table>
 </div><div class="memdoc">
 
-<p>Sets the amount of time between heartbeat packets. </p>
-<p>By default, UDPC sends a heartbeat packet every 150 milliseconds. This function can be used to increase the heartbeat interval time. Valid values are between 150 to 5000 milliseconds. Any value outside of this range will be clamped to within this range.</p>
-<p>This function affects all connections associated with the given UDPC Context.</p>
-<p>This is useful for cases where low-latency is not required. Also note that increasing the heartbeat interval may prevent UDPC from entering "good mode" for any connection. (See <a href="#details">details</a> for info on "good
-mode" and "bad mode".)</p>
-<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 if clamped to minimum, 2 if clamped to maximum, -1 if the given context is invalid. </dd></dl>
+<p>REVERTED FUNCTION, SEE DETAILS. </p>
+<p>This function and its provided functionality was deemed premature for production use. This function will therefore be a no-op until the feature is implemented and ready.</p>
+<dl class="section return"><dt>Returns</dt><dd>-1 always, indicating that this function does not yet work as intended. </dd></dl>
 
 </div>
 </div>

diff --git a/UDPC_8h_source.html b/UDPC_8h_source.html
index aba18dc6e538309af224c6e6e7eb1022ab569757..34afb63bde1083665515a9c752dc86db84e012c2 100644 (file)
--- a/UDPC_8h_source.html
+++ b/UDPC_8h_source.html
@@ -369,33 +369,33 @@ $(function(){ initResizable(false); });
 <div class="line"><a id="l00914" name="l00914"></a><span class="lineno">  914</span> </div>
 <div class="line"><a id="l00926" name="l00926"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a2e47fb8779abe3a9db72a08bf494dc75">  926</a></span>UDPC_EXPORT <span class="keywordtype">void</span> <a class="code hl_function" href="UDPC_8h.html#a2e47fb8779abe3a9db72a08bf494dc75">UDPC_atostr_unsafe_free_ptr</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> **addrBuf);</div>
 <div class="line"><a id="l00927" name="l00927"></a><span class="lineno">  927</span> </div>
-<div class="line"><a id="l00946" name="l00946"></a><span class="lineno"><a class="line" href="UDPC_8h.html#aeb40d2c285eec0c53dd77e9d2cfeb5a2">  946</a></span>UDPC_EXPORT <span class="keywordtype">int</span> <a class="code hl_function" href="UDPC_8h.html#aeb40d2c285eec0c53dd77e9d2cfeb5a2">UDPC_set_heartbeat_millis</a>(UDPC_HContext ctx, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> millis);</div>
+<div class="line"><a id="l00938" name="l00938"></a><span class="lineno"><a class="line" href="UDPC_8h.html#aeb40d2c285eec0c53dd77e9d2cfeb5a2">  938</a></span>UDPC_EXPORT <span class="keywordtype">int</span> <a class="code hl_function" href="UDPC_8h.html#aeb40d2c285eec0c53dd77e9d2cfeb5a2">UDPC_set_heartbeat_millis</a>(UDPC_HContext ctx, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> millis);</div>
+<div class="line"><a id="l00939" name="l00939"></a><span class="lineno">  939</span> </div>
+<div class="line"><a id="l00940" name="l00940"></a><span class="lineno">  940</span><span class="comment">// =============================================================================</span></div>
+<div class="line"><a id="l00941" name="l00941"></a><span class="lineno">  941</span><span class="comment">// Helpers</span></div>
+<div class="line"><a id="l00942" name="l00942"></a><span class="lineno">  942</span> </div>
+<div class="line"><a id="l00944" name="l00944"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a2ae8e7d87f785dd3b3353a00005c3dc6">  944</a></span>UDPC_EXPORT UDPC_IPV6_ADDR_TYPE <a class="code hl_function" href="UDPC_8h.html#a2ae8e7d87f785dd3b3353a00005c3dc6">UDPC_strtoa</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *addrStr);</div>
+<div class="line"><a id="l00945" name="l00945"></a><span class="lineno">  945</span> </div>
+<div class="line"><a id="l00946" name="l00946"></a><span class="lineno">  946</span>UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa_link(<span class="keyword">const</span> <span class="keywordtype">char</span> *addrStr, uint32_t *linkId_out);</div>
 <div class="line"><a id="l00947" name="l00947"></a><span class="lineno">  947</span> </div>
-<div class="line"><a id="l00948" name="l00948"></a><span class="lineno">  948</span><span class="comment">// =============================================================================</span></div>
-<div class="line"><a id="l00949" name="l00949"></a><span class="lineno">  949</span><span class="comment">// Helpers</span></div>
-<div class="line"><a id="l00950" name="l00950"></a><span class="lineno">  950</span> </div>
-<div class="line"><a id="l00952" name="l00952"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a2ae8e7d87f785dd3b3353a00005c3dc6">  952</a></span>UDPC_EXPORT UDPC_IPV6_ADDR_TYPE <a class="code hl_function" href="UDPC_8h.html#a2ae8e7d87f785dd3b3353a00005c3dc6">UDPC_strtoa</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *addrStr);</div>
-<div class="line"><a id="l00953" name="l00953"></a><span class="lineno">  953</span> </div>
-<div class="line"><a id="l00954" name="l00954"></a><span class="lineno">  954</span>UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa_link(<span class="keyword">const</span> <span class="keywordtype">char</span> *addrStr, uint32_t *linkId_out);</div>
-<div class="line"><a id="l00955" name="l00955"></a><span class="lineno">  955</span> </div>
-<div class="line"><a id="l00956" name="l00956"></a><span class="lineno">  956</span>UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_a4toa6(uint32_t a4_be);</div>
-<div class="line"><a id="l00957" name="l00957"></a><span class="lineno">  957</span> </div>
-<div class="line"><a id="l00958" name="l00958"></a><span class="lineno">  958</span>UDPC_EXPORT <span class="keywordtype">int</span> UDPC_is_big_endian();</div>
-<div class="line"><a id="l00959" name="l00959"></a><span class="lineno">  959</span> </div>
-<div class="line"><a id="l01000" name="l01000"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a09093c7edd8ed04407c84a94e0d02587"> 1000</a></span>UDPC_EXPORT uint16_t <a class="code hl_function" href="UDPC_8h.html#a09093c7edd8ed04407c84a94e0d02587">UDPC_no16i</a>(uint16_t i);</div>
-<div class="line"><a id="l01001" name="l01001"></a><span class="lineno"> 1001</span> </div>
-<div class="line"><a id="l01042" name="l01042"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a3e62beb3d497732f5e1d79e19878198c"> 1042</a></span>UDPC_EXPORT uint32_t <a class="code hl_function" href="UDPC_8h.html#a3e62beb3d497732f5e1d79e19878198c">UDPC_no32i</a>(uint32_t i);</div>
-<div class="line"><a id="l01043" name="l01043"></a><span class="lineno"> 1043</span> </div>
-<div class="line"><a id="l01084" name="l01084"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a0d6d9407ed6743a23283d8711652d757"> 1084</a></span>UDPC_EXPORT uint64_t <a class="code hl_function" href="UDPC_8h.html#a0d6d9407ed6743a23283d8711652d757">UDPC_no64i</a>(uint64_t i);</div>
-<div class="line"><a id="l01085" name="l01085"></a><span class="lineno"> 1085</span> </div>
-<div class="line"><a id="l01117" name="l01117"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a61f1ec575cd8a1020bf4d53a72497ab6"> 1117</a></span>UDPC_EXPORT <span class="keywordtype">float</span> <a class="code hl_function" href="UDPC_8h.html#a61f1ec575cd8a1020bf4d53a72497ab6">UDPC_no32f</a>(<span class="keywordtype">float</span> f);</div>
-<div class="line"><a id="l01118" name="l01118"></a><span class="lineno"> 1118</span> </div>
-<div class="line"><a id="l01150" name="l01150"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a93a1a33c4d5dcd4f3e829ce4b15df11c"> 1150</a></span>UDPC_EXPORT <span class="keywordtype">double</span> <a class="code hl_function" href="UDPC_8h.html#a93a1a33c4d5dcd4f3e829ce4b15df11c">UDPC_no64f</a>(<span class="keywordtype">double</span> f);</div>
-<div class="line"><a id="l01151" name="l01151"></a><span class="lineno"> 1151</span> </div>
-<div class="line"><a id="l01152" name="l01152"></a><span class="lineno"> 1152</span><span class="preprocessor">#ifdef __cplusplus</span></div>
-<div class="line"><a id="l01153" name="l01153"></a><span class="lineno"> 1153</span>}</div>
-<div class="line"><a id="l01154" name="l01154"></a><span class="lineno"> 1154</span><span class="preprocessor">#endif</span></div>
-<div class="line"><a id="l01155" name="l01155"></a><span class="lineno"> 1155</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00948" name="l00948"></a><span class="lineno">  948</span>UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_a4toa6(uint32_t a4_be);</div>
+<div class="line"><a id="l00949" name="l00949"></a><span class="lineno">  949</span> </div>
+<div class="line"><a id="l00950" name="l00950"></a><span class="lineno">  950</span>UDPC_EXPORT <span class="keywordtype">int</span> UDPC_is_big_endian();</div>
+<div class="line"><a id="l00951" name="l00951"></a><span class="lineno">  951</span> </div>
+<div class="line"><a id="l00992" name="l00992"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a09093c7edd8ed04407c84a94e0d02587">  992</a></span>UDPC_EXPORT uint16_t <a class="code hl_function" href="UDPC_8h.html#a09093c7edd8ed04407c84a94e0d02587">UDPC_no16i</a>(uint16_t i);</div>
+<div class="line"><a id="l00993" name="l00993"></a><span class="lineno">  993</span> </div>
+<div class="line"><a id="l01034" name="l01034"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a3e62beb3d497732f5e1d79e19878198c"> 1034</a></span>UDPC_EXPORT uint32_t <a class="code hl_function" href="UDPC_8h.html#a3e62beb3d497732f5e1d79e19878198c">UDPC_no32i</a>(uint32_t i);</div>
+<div class="line"><a id="l01035" name="l01035"></a><span class="lineno"> 1035</span> </div>
+<div class="line"><a id="l01076" name="l01076"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a0d6d9407ed6743a23283d8711652d757"> 1076</a></span>UDPC_EXPORT uint64_t <a class="code hl_function" href="UDPC_8h.html#a0d6d9407ed6743a23283d8711652d757">UDPC_no64i</a>(uint64_t i);</div>
+<div class="line"><a id="l01077" name="l01077"></a><span class="lineno"> 1077</span> </div>
+<div class="line"><a id="l01109" name="l01109"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a61f1ec575cd8a1020bf4d53a72497ab6"> 1109</a></span>UDPC_EXPORT <span class="keywordtype">float</span> <a class="code hl_function" href="UDPC_8h.html#a61f1ec575cd8a1020bf4d53a72497ab6">UDPC_no32f</a>(<span class="keywordtype">float</span> f);</div>
+<div class="line"><a id="l01110" name="l01110"></a><span class="lineno"> 1110</span> </div>
+<div class="line"><a id="l01142" name="l01142"></a><span class="lineno"><a class="line" href="UDPC_8h.html#a93a1a33c4d5dcd4f3e829ce4b15df11c"> 1142</a></span>UDPC_EXPORT <span class="keywordtype">double</span> <a class="code hl_function" href="UDPC_8h.html#a93a1a33c4d5dcd4f3e829ce4b15df11c">UDPC_no64f</a>(<span class="keywordtype">double</span> f);</div>
+<div class="line"><a id="l01143" name="l01143"></a><span class="lineno"> 1143</span> </div>
+<div class="line"><a id="l01144" name="l01144"></a><span class="lineno"> 1144</span><span class="preprocessor">#ifdef __cplusplus</span></div>
+<div class="line"><a id="l01145" name="l01145"></a><span class="lineno"> 1145</span>}</div>
+<div class="line"><a id="l01146" name="l01146"></a><span class="lineno"> 1146</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l01147" name="l01147"></a><span class="lineno"> 1147</span><span class="preprocessor">#endif</span></div>
 <div class="ttc" id="aUDPC_8h_html_a0720bec1922660c983b1b3d9f6a5de3a"><div class="ttname"><a href="UDPC_8h.html#a0720bec1922660c983b1b3d9f6a5de3a">UDPC_set_protocol_id</a></div><div class="ttdeci">UDPC_EXPORT uint32_t UDPC_set_protocol_id(UDPC_HContext ctx, uint32_t id)</div><div class="ttdoc">Sets the protocol id of the UDPC context.</div></div>
 <div class="ttc" id="aUDPC_8h_html_a09093c7edd8ed04407c84a94e0d02587"><div class="ttname"><a href="UDPC_8h.html#a09093c7edd8ed04407c84a94e0d02587">UDPC_no16i</a></div><div class="ttdeci">UDPC_EXPORT uint16_t UDPC_no16i(uint16_t i)</div><div class="ttdoc">Converts a 16-bit int into/from network byte order (big endian).</div></div>
 <div class="ttc" id="aUDPC_8h_html_a0d6d9407ed6743a23283d8711652d757"><div class="ttname"><a href="UDPC_8h.html#a0d6d9407ed6743a23283d8711652d757">UDPC_no64i</a></div><div class="ttdeci">UDPC_EXPORT uint64_t UDPC_no64i(uint64_t i)</div><div class="ttdoc">Converts a 64-bit int into/from network byte order (big endian).</div></div>
@@ -461,7 +461,7 @@ $(function(){ initResizable(false); });
 <div class="ttc" id="aUDPC_8h_html_ae0261958047ebb5c6a402aa805e4e55b"><div class="ttname"><a href="UDPC_8h.html#ae0261958047ebb5c6a402aa805e4e55b">UDPC_PacketInfo</a></div><div class="ttdeci">struct UDPC_EXPORT UDPC_PacketInfo UDPC_PacketInfo</div><div class="ttdoc">Data representing a received/sent packet.</div></div>
 <div class="ttc" id="aUDPC_8h_html_ae5afb11964c7a55edf34ddf9097779b2"><div class="ttname"><a href="UDPC_8h.html#ae5afb11964c7a55edf34ddf9097779b2">UDPC_ConnectionId</a></div><div class="ttdeci">struct UDPC_EXPORT UDPC_ConnectionId UDPC_ConnectionId</div><div class="ttdoc">Data identifying a peer via addr, port, and scope_id.</div></div>
 <div class="ttc" id="aUDPC_8h_html_aea7e32ca9fdc04530f95c97459391e6d"><div class="ttname"><a href="UDPC_8h.html#aea7e32ca9fdc04530f95c97459391e6d">UDPC_create_id</a></div><div class="ttdeci">UDPC_EXPORT UDPC_ConnectionId UDPC_create_id(UDPC_IPV6_ADDR_TYPE addr, uint16_t port)</div><div class="ttdoc">Creates an UDPC_ConnectionId with the given addr and port.</div></div>
-<div class="ttc" id="aUDPC_8h_html_aeb40d2c285eec0c53dd77e9d2cfeb5a2"><div class="ttname"><a href="UDPC_8h.html#aeb40d2c285eec0c53dd77e9d2cfeb5a2">UDPC_set_heartbeat_millis</a></div><div class="ttdeci">UDPC_EXPORT int UDPC_set_heartbeat_millis(UDPC_HContext ctx, unsigned int millis)</div><div class="ttdoc">Sets the amount of time between heartbeat packets.</div></div>
+<div class="ttc" id="aUDPC_8h_html_aeb40d2c285eec0c53dd77e9d2cfeb5a2"><div class="ttname"><a href="UDPC_8h.html#aeb40d2c285eec0c53dd77e9d2cfeb5a2">UDPC_set_heartbeat_millis</a></div><div class="ttdeci">UDPC_EXPORT int UDPC_set_heartbeat_millis(UDPC_HContext ctx, unsigned int millis)</div><div class="ttdoc">REVERTED FUNCTION, SEE DETAILS.</div></div>
 <div class="ttc" id="aUDPC_8h_html_affa8655a4e7e3475be441060e92213b3"><div class="ttname"><a href="UDPC_8h.html#affa8655a4e7e3475be441060e92213b3">UDPC_get_received</a></div><div class="ttdeci">UDPC_EXPORT UDPC_PacketInfo UDPC_get_received(UDPC_HContext ctx, unsigned long *remaining)</div><div class="ttdoc">Get a received packet from a given UDPC context.</div></div>
 <div class="ttc" id="astructUDPC__ConnectionId_html"><div class="ttname"><a href="structUDPC__ConnectionId.html">UDPC_ConnectionId</a></div><div class="ttdoc">Data identifying a peer via addr, port, and scope_id.</div><div class="ttdef"><b>Definition</b> UDPC.h:169</div></div>
 <div class="ttc" id="astructUDPC__Event_html"><div class="ttname"><a href="structUDPC__Event.html">UDPC_Event</a></div><div class="ttdoc">A struct containing information related to the type of event.</div><div class="ttdef"><b>Definition</b> UDPC.h:267</div></div>