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
@@ -211,7 +211,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<p>This constructor must be followed by a call to <a class="el" href="classRNGClass.html#a77eb101a225ce541800ac1361a92b1a6" title="Initializes the random number generator. ">begin()</a> to properly initialize the random number generator.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a77eb101a225ce541800ac1361a92b1a6" title="Initializes the random number generator. ">begin()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00238">238</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00261">261</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -240,7 +240,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<p>RNG supports a maximum of four noise sources. If the application needs more than that then the application must poll the noise sources itself by calling <a class="el" href="classNoiseSource.html#a7ce647815524fe84f562aca5256e12f3" title="Stirs entropy from this noise source into the global random number pool. ">NoiseSource::stir()</a> directly.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a8cb91e39f0c4591de5bf98b1e2880b13" title="Run periodic housekeeping tasks on the random number generator. ">loop()</a>, <a class="el" href="classRNGClass.html#a77eb101a225ce541800ac1361a92b1a6" title="Initializes the random number generator. ">begin()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00467">467</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00517">517</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -283,7 +283,7 @@ Static Public Attributes</h2></td></tr>
|
||||
</div><!-- fragment --><p>If <em>len</em> is larger than the maximum number of entropy credits supported by the random number pool (384 bits, 48 bytes), then the maximum will be used instead. For example, asking if 512 bits (64 bytes) are available will return true if in reality only 384 bits are available. If this is a problem for the application's security requirements, then large requests for random data should be broken up into smaller chunks with the application waiting for the entropy pool to refill between chunks.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a418a833cf18198fd7e5d6dbd78c99c29" title="Generates random bytes into a caller-supplied buffer. ">rand()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00593">593</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00660">660</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -311,7 +311,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<p>This function should be followed by calls to <a class="el" href="classRNGClass.html#aacf23b192b0e4cc8726d9abe05f5a9db" title="Adds a noise source to the random number generator. ">addNoiseSource()</a> to register the application's noise sources.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#aacf23b192b0e4cc8726d9abe05f5a9db" title="Adds a noise source to the random number generator. ">addNoiseSource()</a>, <a class="el" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02" title="Stirs additional entropy data into the random pool. ">stir()</a>, <a class="el" href="classRNGClass.html#a139584fb249148e2058d1d645d090db7" title="Saves the random seed to EEPROM. ">save()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00360">360</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00385">385</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -334,7 +334,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="classRNGClass.html#a418a833cf18198fd7e5d6dbd78c99c29" title="Generates random bytes into a caller-supplied buffer. ">rand()</a> and <a class="el" href="classRNGClass.html#a139584fb249148e2058d1d645d090db7" title="Saves the random seed to EEPROM. ">save()</a> functions take some care to manage the random number pool in a way that makes prediction of past outputs from a captured state very difficult. Future outputs may be predictable if noise or other high-entropy data is not mixed in with <a class="el" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02" title="Stirs additional entropy data into the random pool. ">stir()</a> on a regular basis.</dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a77eb101a225ce541800ac1361a92b1a6" title="Initializes the random number generator. ">begin()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00819">819</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00914">914</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -354,7 +354,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<p>Run periodic housekeeping tasks on the random number generator. </p>
|
||||
<p>This function must be called on a regular basis from the application's main "loop()" function. </p>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00728">728</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00804">804</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -394,7 +394,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<p>If the application requires a specific amount of entropy before generating important values, the <a class="el" href="classRNGClass.html#a49e3231ba65a5e4b045bc90976e0a659" title="Determine if there is sufficient entropy available for a specific request size. ">available()</a> function can be polled to determine when sufficient entropy is available.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a49e3231ba65a5e4b045bc90976e0a659" title="Determine if there is sufficient entropy available for a specific request size. ">available()</a>, <a class="el" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02" title="Stirs additional entropy data into the random pool. ">stir()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00516">516</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00566">566</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -418,7 +418,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<p>The seed that is saved is generated in such a way that it cannot be used to predict random values that were generated previously or subsequently in the current session. So a compromise of the EEPROM contents of a captured device should not result in compromise of random values that have already been generated. However, if power is lost and the system restarted, then there will be a short period of time where the random state will be predictable from the seed. For this reason it is very important to <a class="el" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02" title="Stirs additional entropy data into the random pool. ">stir()</a> in new noise data at startup.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a8cb91e39f0c4591de5bf98b1e2880b13" title="Run periodic housekeeping tasks on the random number generator. ">loop()</a>, <a class="el" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02" title="Stirs additional entropy data into the random pool. ">stir()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00695">695</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00762">762</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -447,7 +447,7 @@ Static Public Attributes</h2></td></tr>
|
||||
<p>This function is intended to help with EEPROM wear by slowing down how often seed data is saved as noise is stirred into the random pool. The exact period to use depends upon how long you intend to field the device before replacing it. For example, an EEPROM rated for 100k erase/write cycles will last about 69 days saving once a minute or 11 years saving once an hour.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a139584fb249148e2058d1d645d090db7" title="Saves the random seed to EEPROM. ">save()</a>, <a class="el" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02" title="Stirs additional entropy data into the random pool. ">stir()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00492">492</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00542">542</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -495,7 +495,7 @@ Static Public Attributes</h2></td></tr>
|
||||
</div><!-- fragment --><p>If <em>credit</em> is zero, then the <em>data</em> will be stirred in but no entropy credit is given. This is useful for static values like serial numbers and MAC addresses that are different between devices but highly predictable.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRNGClass.html#a8cb91e39f0c4591de5bf98b1e2880b13" title="Run periodic housekeeping tasks on the random number generator. ">loop()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00626">626</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
<p>Definition at line <a class="el" href="RNG_8cpp_source.html#l00693">693</a> of file <a class="el" href="RNG_8cpp_source.html">RNG.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -532,7 +532,7 @@ Static Public Attributes</h2></td></tr>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Feb 18 2018 09:12:23 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Mon Apr 2 2018 18:36:53 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.6
|
||||
</small></address>
|
||||
|
||||
Reference in New Issue
Block a user