aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2018-09-04 19:29:59 -0400
committerJack Lloyd <[email protected]>2018-09-06 11:24:16 -0400
commit8cbe5195b2ea82bf7a58f1a3b8afcc8c53a7537b (patch)
treee24dba4d3e8df8024b8ffffc797d2d15c0908f76 /doc
parent992d2803181b34415c25e013a40ab935eb71a9e3 (diff)
Add RandomNumberGenerator::accepts_input
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/rng.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/manual/rng.rst b/doc/manual/rng.rst
index b8549e9bc..9899cd16f 100644
--- a/doc/manual/rng.rst
+++ b/doc/manual/rng.rst
@@ -36,6 +36,12 @@ Random Number Generators
the RNG doesn't support this operation, the data is dropped, no error is
indicated.
+ .. cpp:function:: bool accepts_input() const
+
+ This function returns ``false`` if it is known that this RNG object cannot
+ accept external inputs. In this case, any calls to
+ :cpp:func:`RandomNumberGenerator::add_entropy` will be ignored.
+
.. cpp:function:: void reseed_from_rng(RandomNumberGenerator& rng, \
size_t poll_bits = BOTAN_RNG_RESEED_POLL_BITS)