Public Member Functions | List of all members
Celartem::Checksum Class Referenceabstract

#include <cel_checksum.h>

Inheritance diagram for Celartem::Checksum:
Inheritance graph
[legend]

Public Member Functions

virtual void reset ()=0
 
virtual void update (const void *inBuffer, size_t inSize)=0
 
virtual void update (const String &inString)=0
 
virtual size_t getSumSize ()=0
 
virtual const u8getCurrentSum ()=0
 
- Public Member Functions inherited from Celartem::Referable
 Referable ()
 
void addRef () const
 
void releaseRef () const
 
size_t getReferenceCount () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()
 

Detailed Description

This class defines the common interface for the checksum (hash) classes.
Currently, only MD5Checksum is supported.

See Also
MD5Checksum, ChecksumStream

Member Function Documentation

virtual const u8* Celartem::Checksum::getCurrentSum ( )
pure virtual

This method gets the current sum as the binary block.

Returns
Pointer that points the binary block. This pointer is valid until the next call to the method of the instance. The size of that block is obtained by getSumSize method.
virtual size_t Celartem::Checksum::getSumSize ( )
pure virtual

This method gets the size of sums in bytes that is generated by the instance. The size of sum is usually a constant; MD5 uses 16, SHA-1 uses 20.

Returns
The size of sums.
virtual void Celartem::Checksum::reset ( )
pure virtual

This method resets the current sum and revert to the initial state.

virtual void Celartem::Checksum::update ( const void *  inBuffer,
size_t  inSize 
)
pure virtual

This method updates the status using the specified data.

Parameters
inBufferPointer to a buffer that contains data to be used.
inSizeThe size of the data.
virtual void Celartem::Checksum::update ( const String inString)
pure virtual

This method updates the status using the specified string.

Parameters
inStringA String instance. The terminating '\0' is not used to update the status.

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

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:06.
Cuminas Logo