Celartem::Checksum Class Reference

#include <cel_checksum.h>

Inheritance diagram for Celartem::Checksum:

[legend]

List of all members.

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 u8 *	getCurrentSum ()=0

---

Detailed Description

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

See also:

MD5Checksum, ChecksumStream

Definition at line 22 of file cel_checksum.h.

---

Member Function Documentation

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:

	inBuffer	Pointer to a buffer that contains data to be used.
	inSize	The size of the data.

virtual void Celartem::Checksum::update

(

const String &

inString

)

[pure virtual]

This method updates the status using the specified string.

Parameters:

inString

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

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 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.

---

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

• cel_checksum.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:14 2008.