Cpl::Checksum::ApiMd5 Class Reference

This class provides an interface for performing a MD5 Hash on a collection of bytes. More...

Detailed Description

This class provides an interface for performing a MD5 Hash on a collection of bytes.

How to generate a Hash result:

1. Call reset() initialize the Hash
2. Call accumulate() method for every byte being hash'd
3. Call finalize() to get the Hashed value.

#include <ApiMd5.h>

Inheritance diagram for Cpl::Checksum::ApiMd5:

Public Types
enum	{ eDIGEST_LEN =16 }
	Number of bytes in the digest. More...
typedef uint8_t	Digest_T[eDIGEST_LEN]
	Digest/result of the hash.

Public Member Functions
virtual void	reset (void) noexcept=0
	Used to re-use/restart the hash object.
virtual void	accumulate (const void *bytes, unsigned numbytes=1) noexcept=0
	Call the method for every byte being hash'd.
virtual Digest_T &	finalize (Cpl::Text::String *convertToString=0, bool uppercase=true, bool append=false)=0
	Call this method to finalize the Hash.
	~ApiMd5 ()
	Virtual destructor.

Member Typedef Documentation

Digest_T

typedef uint8_t Cpl::Checksum::ApiMd5::Digest_T[eDIGEST_LEN]

Digest/result of the hash.

Member Enumeration Documentation

anonymous enum

anonymous enum

Number of bytes in the digest.

Constructor & Destructor Documentation

~ApiMd5()

Cpl::Checksum::ApiMd5::~ApiMd5 ( )

inline

Virtual destructor.

Member Function Documentation

accumulate()

virtual void Cpl::Checksum::ApiMd5::accumulate ( const void *  bytes, unsigned  numbytes = 1  )

pure virtualnoexcept

Call the method for every byte being hash'd.

Implemented in Cpl::Checksum::Md5Aladdin.

finalize()

virtual Digest_T & Cpl::Checksum::ApiMd5::finalize ( Cpl::Text::String *  convertToString = 0, bool  uppercase = true, bool  append = false  )

pure virtual

Call this method to finalize the Hash.

The calculated hash value is returned. If 'convertToString' is NOT null, then the hash value, aka the digest is converted to a 'ASCII Hex String'

Note: The return value is only valid/in-scope UNTIL reset() is called

Implemented in Cpl::Checksum::Md5Aladdin.

reset()

virtual void Cpl::Checksum::ApiMd5::reset ( void  )

pure virtualnoexcept

Used to re-use/restart the hash object.

Implemented in Cpl::Checksum::Md5Aladdin.

---

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

• Cpl/Checksum/ApiMd5.h