ucommon
Public Member Functions
ucommon::keyrandom< S > Class Template Reference

A template to create a random generated key of specified size. More...

#include <secure.h>

Public Member Functions

void clear (void)
 Clear current key memory.
 
 keyrandom ()
 Create a new character buffer with an empty string.
 
 operator unsigned char * ()
 Get text by casting reference. More...
 
unsigned char * operator* ()
 Get text by object pointer reference. More...
 
size_t size (void) const
 Get allocated size of the object. More...
 
void update (void)
 Update with new random key.
 
 ~keyrandom ()
 Clear memory when destroyed.
 

Detailed Description

template<size_t S>
class ucommon::keyrandom< S >

A template to create a random generated key of specified size.

The key memory is cleared when the object is destroyed.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 903 of file secure.h.

Member Function Documentation

template<size_t S>
ucommon::keyrandom< S >::operator unsigned char * ( )
inline

Get text by casting reference.

Returns
pointer to text in object.

Definition at line 942 of file secure.h.

template<size_t S>
unsigned char* ucommon::keyrandom< S >::operator* ( )
inline

Get text by object pointer reference.

Returns
pointer to text in object.

Definition at line 949 of file secure.h.

template<size_t S>
size_t ucommon::keyrandom< S >::size ( void  ) const
inline

Get allocated size of the object.

Returns
allocated size.

Definition at line 956 of file secure.h.


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