OpenVPN 3 Core Library
Loading...
Searching...
No Matches
IntegralMin< IntegralT > Class Template Reference
Inheritance diagram for IntegralMin< IntegralT >:
[legend]
Collaboration diagram for IntegralMin< IntegralT >:
[legend]

Public Types

typedef RCPtr< IntegralMinPtr
 
- Public Types inherited from openvpn::WeakRandomAPI
typedef RCPtr< WeakRandomAPIPtr
 Smart pointer type for managing the ownership of WeakRandomAPI objects.
 
- Public Types inherited from openvpn::RandomAPI
typedef RCPtr< RandomAPIPtr
 Smart pointer type for managing the ownership of RandomAPI objects.
 
typedef unsigned int result_type
 
- Public Types inherited from openvpn::RC< thread_unsafe_refcount >
typedef RCPtr< RCPtr
 

Public Member Functions

 OPENVPN_EXCEPTION (s_min_error)
 
std::string name () const override
 Get the name of the random number generation algorithm.
 
void rand_bytes (unsigned char *buf, size_t size) override
 Fill a buffer with random bytes.
 
bool rand_bytes_noexcept (unsigned char *buf, size_t size) override
 Fill a buffer with random bytes without throwing exceptions.
 
IntegralT get_result ()
 
- Public Member Functions inherited from openvpn::RandomAPI
template<typename T >
void rand_fill (T &obj)
 Fill a data object with random bytes.
 
template<typename T >
rand_get ()
 Create a data object filled with random bytes.
 
template<typename T >
rand_get_positive ()
 Create a data object filled with random bytes, always >= 0 for signed types.
 
template<typename T >
randrange (const T end)
 Return a uniformly distributed random number in the range [0, end)
 
template<typename T >
randrange (const T start, const T end)
 Return a uniformly distributed random number in the range [start, end].
 
std::uint32_t randrange32 (const std::uint32_t end)
 Return a uniformly distributed random number in the range [0, end)
 
std::uint32_t randrange32 (const std::uint32_t start, const std::uint32_t end)
 Return a uniformly distributed random number in the range [start, end].
 
std::uint8_t randbyte ()
 Return a random byte.
 
bool randbool ()
 Return a random boolean.
 
result_type operator() ()
 
- Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
 RC () noexcept=default
 
 RC (const RC &)=delete
 
virtual ~RC ()=default
 
RCoperator= (const RC &)=delete
 
olong use_count () const noexcept
 Delegates call to RCImpl and returns the result.
 

Additional Inherited Members

- Static Public Member Functions inherited from openvpn::RandomAPI
static constexpr result_type min ()
 
static constexpr result_type max ()
 
- Static Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
static constexpr bool is_thread_safe ()
 Delegates call to RCImpl and returns the result.
 

Detailed Description

template<typename IntegralT>
class IntegralMin< IntegralT >

Definition at line 9 of file test_randapi.cpp.

Member Typedef Documentation

◆ Ptr

template<typename IntegralT >
typedef RCPtr<IntegralMin> IntegralMin< IntegralT >::Ptr

Definition at line 14 of file test_randapi.cpp.

Member Function Documentation

◆ get_result()

template<typename IntegralT >
IntegralT IntegralMin< IntegralT >::get_result ( )
inline

Definition at line 40 of file test_randapi.cpp.

Here is the caller graph for this function:

◆ name()

template<typename IntegralT >
std::string IntegralMin< IntegralT >::name ( ) const
inlineoverridevirtual

Get the name of the random number generation algorithm.

Returns
The name of the algorithm

Implements openvpn::RandomAPI.

Definition at line 17 of file test_randapi.cpp.

◆ OPENVPN_EXCEPTION()

template<typename IntegralT >
IntegralMin< IntegralT >::OPENVPN_EXCEPTION ( s_min_error  )

◆ rand_bytes()

template<typename IntegralT >
void IntegralMin< IntegralT >::rand_bytes ( unsigned char *  buf,
size_t  size 
)
inlineoverridevirtual

Fill a buffer with random bytes.

Parameters
bufPointer to the buffer
sizeNumber of bytes to generate

Implements openvpn::RandomAPI.

Definition at line 23 of file test_randapi.cpp.

◆ rand_bytes_noexcept()

template<typename IntegralT >
bool IntegralMin< IntegralT >::rand_bytes_noexcept ( unsigned char *  buf,
size_t  size 
)
inlineoverridevirtual

Fill a buffer with random bytes without throwing exceptions.

Parameters
bufPointer to the buffer
sizeNumber of bytes to generate
Returns
true on success
false on failure

Implements openvpn::RandomAPI.

Definition at line 31 of file test_randapi.cpp.

Here is the caller graph for this function:

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