<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crypto++: NonblockingRng Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Crypto++  <span id="projectnumber">7.0</span> </div> <div id="projectbrief">Free C++ class library of cryptographic schemes</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="class_nonblocking_rng-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">NonblockingRng Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Wrapper class for /dev/random and /dev/srandom. <a href="class_nonblocking_rng.html#details">More...</a></p> <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for NonblockingRng:</div> <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-0-content" class="dyncontent" style="display:none;"> <div class="center"> <img src="class_nonblocking_rng.png" usemap="#NonblockingRng_map" alt=""/> <map id="NonblockingRng_map" name="NonblockingRng_map"> <area href="class_random_number_generator.html" title="Interface for random number generators. " alt="RandomNumberGenerator" shape="rect" coords="0,112,158,136"/> <area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="0,56,158,80"/> <area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="0,0,158,24"/> </map> </div></div> <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:a09b27b1803636bdd60a64f7f587433ed"><td class="memItemLeft" align="right" valign="top"><a id="a09b27b1803636bdd60a64f7f587433ed"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nonblocking_rng.html#a09b27b1803636bdd60a64f7f587433ed">NonblockingRng</a> ()</td></tr> <tr class="memdesc:a09b27b1803636bdd60a64f7f587433ed"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_nonblocking_rng.html" title="Wrapper class for /dev/random and /dev/srandom. ">NonblockingRng</a>. <br /></td></tr> <tr class="separator:a09b27b1803636bdd60a64f7f587433ed"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac74f9b2acf05938b98eedc806c4c29d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nonblocking_rng.html#ac74f9b2acf05938b98eedc806c4c29d3">GenerateBlock</a> (byte *output, size_t size)</td></tr> <tr class="memdesc:ac74f9b2acf05938b98eedc806c4c29d3"><td class="mdescLeft"> </td><td class="mdescRight">Generate random array of bytes. <a href="#ac74f9b2acf05938b98eedc806c4c29d3">More...</a><br /></td></tr> <tr class="separator:ac74f9b2acf05938b98eedc806c4c29d3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_random_number_generator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_random_number_generator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a></td></tr> <tr class="memitem:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a6feb4f0afedb62a495b7a9ae311fa1cb">IncorporateEntropy</a> (const byte *input, size_t length)</td></tr> <tr class="memdesc:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Update RNG state with additional unpredictable values. <a href="class_random_number_generator.html#a6feb4f0afedb62a495b7a9ae311fa1cb">More...</a><br /></td></tr> <tr class="separator:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a859bf69f7fae074201745eadf765ae44">CanIncorporateEntropy</a> () const</td></tr> <tr class="memdesc:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Determines if a generator can accept additional entropy. <a href="class_random_number_generator.html#a859bf69f7fae074201745eadf765ae44">More...</a><br /></td></tr> <tr class="separator:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">GenerateByte</a> ()</td></tr> <tr class="memdesc:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate new random byte and return it. <a href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">More...</a><br /></td></tr> <tr class="separator:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ace592244cfbd6c18398ea6c75857532e">GenerateBit</a> ()</td></tr> <tr class="memdesc:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate new random bit and return it. <a href="class_random_number_generator.html#ace592244cfbd6c18398ea6c75857532e">More...</a><br /></td></tr> <tr class="separator:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual word32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a96a3eec202b6251f5c94136ab7edbde1">GenerateWord32</a> (word32 min=0, word32 max=0xffffffffUL)</td></tr> <tr class="memdesc:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random 32 bit word in the range min to max, inclusive. <a href="class_random_number_generator.html#a96a3eec202b6251f5c94136ab7edbde1">More...</a><br /></td></tr> <tr class="separator:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5cc474006e2c7383ec20cc4d0c2abbaf inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a5cc474006e2c7383ec20cc4d0c2abbaf">GenerateIntoBufferedTransformation</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, lword length)</td></tr> <tr class="memdesc:a5cc474006e2c7383ec20cc4d0c2abbaf inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate random bytes into a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. <a href="class_random_number_generator.html#a5cc474006e2c7383ec20cc4d0c2abbaf">More...</a><br /></td></tr> <tr class="separator:a5cc474006e2c7383ec20cc4d0c2abbaf inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a44f70ad8fed869a4ee55f50ef8e6e699">DiscardBytes</a> (size_t n)</td></tr> <tr class="memdesc:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate and discard n bytes. <a href="class_random_number_generator.html#a44f70ad8fed869a4ee55f50ef8e6e699">More...</a><br /></td></tr> <tr class="separator:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memTemplParams" colspan="2">template<class IT > </td></tr> <tr class="memitem:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#aff937f93b0b1e17e7905494ef060fce2">Shuffle</a> (IT begin, IT end)</td></tr> <tr class="memdesc:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Randomly shuffle the specified array. <a href="class_random_number_generator.html#aff937f93b0b1e17e7905494ef060fce2">More...</a><br /></td></tr> <tr class="separator:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_algorithm')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_algorithm.html">Algorithm</a></td></tr> <tr class="memitem:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">Algorithm</a> (bool checkSelfTestStatus=true)</td></tr> <tr class="memdesc:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Interface for all crypto algorithms. <a href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">More...</a><br /></td></tr> <tr class="separator:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">AlgorithmName</a> () const</td></tr> <tr class="memdesc:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Provides the name of this algorithm. <a href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">More...</a><br /></td></tr> <tr class="separator:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_clonable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_clonable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_clonable.html">Clonable</a></td></tr> <tr class="memitem:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">Clone</a> () const</td></tr> <tr class="memdesc:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="mdescLeft"> </td><td class="mdescRight">Copies this object. <a href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">More...</a><br /></td></tr> <tr class="separator:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a789f8fd8c173efefb54f808992e1cc8f"><td class="memItemLeft" align="right" valign="top"><a id="a789f8fd8c173efefb54f808992e1cc8f"></a> static const char * </td><td class="memItemRight" valign="bottom"><b>StaticAlgorithmName</b> ()</td></tr> <tr class="separator:a789f8fd8c173efefb54f808992e1cc8f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Wrapper class for /dev/random and /dev/srandom. </p> <p>Encapsulates CryptoAPI's CryptGenRandom() or CryptoNG's BCryptGenRandom() on Windows, or /dev/urandom on Unix and compatibles. </p> <p class="definition">Definition at line <a class="el" href="osrng_8h_source.html#l00084">84</a> of file <a class="el" href="osrng_8h_source.html">osrng.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="ac74f9b2acf05938b98eedc806c4c29d3"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac74f9b2acf05938b98eedc806c4c29d3">◆ </a></span>GenerateBlock()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void NonblockingRng::GenerateBlock </td> <td>(</td> <td class="paramtype">byte * </td> <td class="paramname"><em>output</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Generate random array of bytes. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">output</td><td>the byte buffer </td></tr> <tr><td class="paramname">size</td><td>the length of the buffer, in bytes</td></tr> </table> </dd> </dl> <p><a class="el" href="class_random_number_generator.html#a5cc474006e2c7383ec20cc4d0c2abbaf" title="Generate random bytes into a BufferedTransformation. ">GenerateIntoBufferedTransformation()</a> calls are routed to <a class="el" href="class_nonblocking_rng.html#ac74f9b2acf05938b98eedc806c4c29d3" title="Generate random array of bytes. ">GenerateBlock()</a>. </p> <p>Reimplemented from <a class="el" href="class_random_number_generator.html#a497145546d24e6d4abaf10b7e0f1ba17">RandomNumberGenerator</a>.</p> <p class="definition">Definition at line <a class="el" href="osrng_8cpp_source.html#l00145">145</a> of file <a class="el" href="osrng_8cpp_source.html">osrng.cpp</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="osrng_8h_source.html">osrng.h</a></li> <li><a class="el" href="osrng_8cpp_source.html">osrng.cpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:45 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>