1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Update docs

This commit is contained in:
Rhys Weatherley
2015-03-25 19:36:25 +10:00
parent fba6ac9417
commit efb2741e4a
306 changed files with 2931 additions and 1386 deletions

View File

@@ -111,21 +111,47 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;Hash.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classHash.html#af482880ad75b67a09d2dcb5e86244d80"> 35</a></span>&#160;<a class="code" href="classHash.html#af482880ad75b67a09d2dcb5e86244d80">Hash::Hash</a>()</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;}</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classHash.html#a4e4b4797dda8678aaed058bae155813e"> 47</a></span>&#160;<a class="code" href="classHash.html#a4e4b4797dda8678aaed058bae155813e">Hash::~Hash</a>()</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;{</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;}</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="ttc" id="classHash_html_af482880ad75b67a09d2dcb5e86244d80"><div class="ttname"><a href="classHash.html#af482880ad75b67a09d2dcb5e86244d80">Hash::Hash</a></div><div class="ttdeci">Hash()</div><div class="ttdoc">Constructs a new hash object. </div><div class="ttdef"><b>Definition:</b> <a href="Hash_8cpp_source.html#l00035">Hash.cpp:35</a></div></div>
<div class="ttc" id="classHash_html_a4e4b4797dda8678aaed058bae155813e"><div class="ttname"><a href="classHash.html#a4e4b4797dda8678aaed058bae155813e">Hash::~Hash</a></div><div class="ttdeci">virtual ~Hash()</div><div class="ttdoc">Destroys this hash object. </div><div class="ttdef"><b>Definition:</b> <a href="Hash_8cpp_source.html#l00047">Hash.cpp:47</a></div></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;string.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classHash.html#af482880ad75b67a09d2dcb5e86244d80"> 36</a></span>&#160;<a class="code" href="classHash.html#af482880ad75b67a09d2dcb5e86244d80">Hash::Hash</a>()</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classHash.html#a4e4b4797dda8678aaed058bae155813e"> 48</a></span>&#160;<a class="code" href="classHash.html#a4e4b4797dda8678aaed058bae155813e">Hash::~Hash</a>()</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;}</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="classHash.html#ab6f40c9af91dc3d738d9fcce59af63cc"> 162</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classHash.html#ab6f40c9af91dc3d738d9fcce59af63cc">Hash::formatHMACKey</a>(<span class="keywordtype">void</span> *block, <span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> len, uint8_t pad)</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;{</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keywordtype">size_t</span> size = <a class="code" href="classHash.html#a4e4297812e3483410556830fe5d47bdf">blockSize</a>();</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <a class="code" href="classHash.html#a7b94309acaa5f52386785fb780e5be61">reset</a>();</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordflow">if</span> (len &lt;= size) {</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; memcpy(block, key, len);</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <a class="code" href="classHash.html#aec9761ee427d122e7450de8df200265c">update</a>(key, len);</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; len = <a class="code" href="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8">hashSize</a>();</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <a class="code" href="classHash.html#a09b3ccec22763fc86b1415695862977c">finalize</a>(block, len);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <a class="code" href="classHash.html#a7b94309acaa5f52386785fb780e5be61">reset</a>();</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; }</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; memset(block + len, pad, size - len);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; uint8_t *b = (uint8_t *)block;</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keywordflow">while</span> (len &gt; 0) {</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; *b++ ^= pad;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; --len;</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; }</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;}</div>
<div class="ttc" id="classHash_html_a4e4297812e3483410556830fe5d47bdf"><div class="ttname"><a href="classHash.html#a4e4297812e3483410556830fe5d47bdf">Hash::blockSize</a></div><div class="ttdeci">virtual size_t blockSize() const =0</div><div class="ttdoc">Size of the internal block used by the hash algorithm. </div></div>
<div class="ttc" id="classHash_html_af482880ad75b67a09d2dcb5e86244d80"><div class="ttname"><a href="classHash.html#af482880ad75b67a09d2dcb5e86244d80">Hash::Hash</a></div><div class="ttdeci">Hash()</div><div class="ttdoc">Constructs a new hash object. </div><div class="ttdef"><b>Definition:</b> <a href="Hash_8cpp_source.html#l00036">Hash.cpp:36</a></div></div>
<div class="ttc" id="classHash_html_a7b94309acaa5f52386785fb780e5be61"><div class="ttname"><a href="classHash.html#a7b94309acaa5f52386785fb780e5be61">Hash::reset</a></div><div class="ttdeci">virtual void reset()=0</div><div class="ttdoc">Resets the hash ready for a new hashing process. </div></div>
<div class="ttc" id="classHash_html_adcdd30de3e5ecaa2f798c0c5644d9ef8"><div class="ttname"><a href="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8">Hash::hashSize</a></div><div class="ttdeci">virtual size_t hashSize() const =0</div><div class="ttdoc">Size of the hash result from finalize(). </div></div>
<div class="ttc" id="classHash_html_a4e4b4797dda8678aaed058bae155813e"><div class="ttname"><a href="classHash.html#a4e4b4797dda8678aaed058bae155813e">Hash::~Hash</a></div><div class="ttdeci">virtual ~Hash()</div><div class="ttdoc">Destroys this hash object. </div><div class="ttdef"><b>Definition:</b> <a href="Hash_8cpp_source.html#l00048">Hash.cpp:48</a></div></div>
<div class="ttc" id="classHash_html_aec9761ee427d122e7450de8df200265c"><div class="ttname"><a href="classHash.html#aec9761ee427d122e7450de8df200265c">Hash::update</a></div><div class="ttdeci">virtual void update(const void *data, size_t len)=0</div><div class="ttdoc">Updates the hash with more data. </div></div>
<div class="ttc" id="classHash_html_ab6f40c9af91dc3d738d9fcce59af63cc"><div class="ttname"><a href="classHash.html#ab6f40c9af91dc3d738d9fcce59af63cc">Hash::formatHMACKey</a></div><div class="ttdeci">void formatHMACKey(void *block, const void *key, size_t len, uint8_t pad)</div><div class="ttdoc">Formats a HMAC key into a block. </div><div class="ttdef"><b>Definition:</b> <a href="Hash_8cpp_source.html#l00162">Hash.cpp:162</a></div></div>
<div class="ttc" id="classHash_html_a09b3ccec22763fc86b1415695862977c"><div class="ttname"><a href="classHash.html#a09b3ccec22763fc86b1415695862977c">Hash::finalize</a></div><div class="ttdeci">virtual void finalize(void *hash, size_t len)=0</div><div class="ttdoc">Finalizes the hashing process and returns the hash. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 22 2015 15:54:26 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Mar 25 2015 19:36:07 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>