diff options
author | René Korthaus <r.korthaus@sirrix.com> | 2016-10-16 17:10:34 +0200 |
---|---|---|
committer | René Korthaus <r.korthaus@sirrix.com> | 2016-10-19 09:13:32 +0200 |
commit | a08e0160301f20e4f5d620a146a1556e0ac7c95d (patch) | |
tree | 9085c240a7032dd32b9c9e3bf4bbd676cc56ca3b /src/lib/rng/stateful_rng/stateful_rng.h | |
parent | c8fc2de447cb3ef7831c0e96487d91e005a50e14 (diff) |
Improve rng doxygen [ci skip]
Diffstat (limited to 'src/lib/rng/stateful_rng/stateful_rng.h')
-rw-r--r-- | src/lib/rng/stateful_rng/stateful_rng.h | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/src/lib/rng/stateful_rng/stateful_rng.h b/src/lib/rng/stateful_rng/stateful_rng.h index 11f0c7e3d..4eed85d0d 100644 --- a/src/lib/rng/stateful_rng/stateful_rng.h +++ b/src/lib/rng/stateful_rng/stateful_rng.h @@ -25,6 +25,13 @@ namespace Botan { class BOTAN_DLL Stateful_RNG : public RandomNumberGenerator { public: + /** + * @param rng is a reference to some RNG which will be used + * to perform the periodic reseeding + * @param entropy_sources will be polled to perform reseeding periodically + * @param reseed_interval specifies a limit of how many times + * the RNG will be called before automatic reseeding is performed + */ Stateful_RNG(RandomNumberGenerator& rng, Entropy_Sources& entropy_sources, size_t reseed_interval) : @@ -33,11 +40,22 @@ class BOTAN_DLL Stateful_RNG : public RandomNumberGenerator m_reseed_interval(reseed_interval) {} + /** + * @param underlying_rng is a reference to some RNG which will be used + * to perform the periodic reseeding + * @param reseed_interval specifies a limit of how many times + * the RNG will be called before automatic reseeding is performed + */ Stateful_RNG(RandomNumberGenerator& rng, size_t reseed_interval) : m_underlying_rng(&rng), m_reseed_interval(reseed_interval) {} + /** + * @param entropy_sources will be polled to perform reseeding periodically + * @param reseed_interval specifies a limit of how many times + * the RNG will be called before automatic reseeding is performed + */ Stateful_RNG(Entropy_Sources& entropy_sources, size_t reseed_interval) : m_entropy_sources(&entropy_sources), m_reseed_interval(reseed_interval) @@ -81,7 +99,7 @@ class BOTAN_DLL Stateful_RNG : public RandomNumberGenerator std::chrono::milliseconds poll_timeout = BOTAN_RNG_RESEED_DEFAULT_TIMEOUT) override; /** - * Return intended security level of this DRBG + * @return intended security level of this DRBG */ virtual size_t security_level() const = 0; |