ts::SystemRandomGenerator Class Reference

System-provided PRNG (pseudo-random numbers generator). More...

#include <tsSystemRandomGenerator.h>

Inheritance diagram for ts::SystemRandomGenerator:

Collaboration diagram for ts::SystemRandomGenerator:

Public Member Functions
	SystemRandomGenerator ()
	Constructor.
virtual	~SystemRandomGenerator () override
	Virtual destructor.
virtual UString	name () const override
	Algorithm name (informational only).
virtual bool	read (void *, size_t) override
	Get random data.
virtual bool	readByteBlock (ByteBlock &data, size_t size)
	Get random data in a byte block.
template<typename INT_T > requires std::integral<INT_T>
bool	readInt (INT_T &value, INT_T min=std::numeric_limits< INT_T >::min(), INT_T max=std::numeric_limits< INT_T >::max())
	Get a random integer value inside a defined range.
virtual bool	ready () const override
	Check if the PRNG is ready.
virtual bool	seed (const void *, size_t) override
	Seed (add entropy) to the PRNG.

Detailed Description

System-provided PRNG (pseudo-random numbers generator).

Usually not the best PRNG on earth, but fine for most usages.

Member Function Documentation

name()

virtual UString ts::SystemRandomGenerator::name ( ) const

overridevirtual

Algorithm name (informational only).

Returns

The algorithm name.

Implements ts::RandomGenerator.

Reimplemented in ts::BetterSystemRandomGenerator.

seed()

virtual bool ts::SystemRandomGenerator::seed ( const void *  addr, size_t  size  )

overridevirtual

Seed (add entropy) to the PRNG.

Parameters

[in]	addr	Address of entropy data.
[in]	size	Size in bytes of entropy data.

Returns

True on success, false on error.

Implements ts::RandomGenerator.

ready()

virtual bool ts::SystemRandomGenerator::ready ( ) const

overridevirtual

Check if the PRNG is ready.

If not ready, it must be seeded again.

Returns

True if the PRNG is ready.

Implements ts::RandomGenerator.

Reimplemented in ts::BetterSystemRandomGenerator.

read()

virtual bool ts::SystemRandomGenerator::read ( void *  addr, size_t  size  )

overridevirtual

Get random data.

Parameters

[out]	addr	Address of returned random data.
[in]	size	Requested size in bytes of random data. The method always fill the buffer.

Returns

True on success, false on error.

Implements ts::RandomGenerator.

Reimplemented in ts::BetterSystemRandomGenerator.

readByteBlock()

virtual bool ts::RandomGenerator::readByteBlock ( ByteBlock &  data, size_t  size  )

virtualinherited

Get random data in a byte block.

The default implementation uses read().

Parameters

[out]	data	Returned random data.
[in]	size	Requested size in bytes of random data.

Returns

True on success, false on error.

readInt()

template<typename INT_T >
requires std::integral<INT_T>

bool ts::RandomGenerator::readInt ( INT_T &  value, INT_T  min = std::numeric_limits<INT_T>::min(), INT_T  max = std::numeric_limits<INT_T>::max()  )

inherited

Get a random integer value inside a defined range.

Template Parameters

INT_T

An integer type for the result.

Parameters

[out]	value	The return integer value.
[in]	min	Minimum value to return.
[in]	max	Maximum value to return.

Returns

True on success, false on error.

---

The documentation for this class was generated from the following file:

• tsSystemRandomGenerator.h