CrystalSpace

Public API Reference

CS::Utility::Checksum::CRC32 Class Reference

Compute CRC32 checksum for some data. More...

#include <csutil/checksum.h>

List of all members.

Public Member Functions

void Append (const uint8 *data, size_t size)
 Feed in more data to checksum.
uint32 Finish ()
 "Finish" checksum computation and return checksum over all data.
 operator uint32 () const
 Return current checksum. For function-style use.



 __pad0__: checksum (Compute (Initial()
 Continue computing CRC-32 checksum for given data buffer.
 __pad1__: checksum (Compute (prevCheckSum
 Continue computing CRC-32 checksum for given data buffer.
size __pad2__: checksum (Compute (prevCheckSum
 Continue computing CRC-32 checksum for given data buffer.
 data
 Continue computing CRC-32 checksum for given data buffer.
 CRC32 (const void *data, size_t size)
 Compute CRC-32 checksum for given data buffer.
size data GetData ()
 Continue computing CRC-32 checksum for given data buffer.
data GetData ()
 Continue computing CRC-32 checksum for given data buffer.
size data data GetSize ()))
 Continue computing CRC-32 checksum for given data buffer.
data data GetSize ()))
 Continue computing CRC-32 checksum for given data buffer.

Detailed Description

Compute CRC32 checksum for some data.

This class can be used in two ways, function-style (for checksumming a single block of data) and as an instance (to checksum data in multiple chunks).

Example for function-style use:

 uint32 check = CS::Utility::Checksum::CRC32 (data, dataSize);

Example for use as an instance:

 CS::Utility::Checksum::CRC32 computeSum;
 computeSum.Append (dataPart1, dataPart1Size);
 // ... 
 computeSum.Append (dataPart2, dataPart2Size);
 uint32 checksum = computeSum.Finish();

Definition at line 115 of file checksum.h.


Constructor & Destructor Documentation

CS::Utility::Checksum::CRC32::CRC32 ( const void *  data,
size_t  size 
) [inline]

Compute CRC-32 checksum for given data buffer.

Definition at line 128 of file checksum.h.


Member Function Documentation

void CS::Utility::Checksum::CRC32::Append ( const uint8 *  data,
size_t  size 
) [inline]

Feed in more data to checksum.

Definition at line 146 of file checksum.h.

uint32 CS::Utility::Checksum::CRC32::Finish (  )  [inline]

"Finish" checksum computation and return checksum over all data.

Definition at line 149 of file checksum.h.

size data CS::Utility::Checksum::CRC32::GetData (  ) 

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.
Type Constraints
data CS::Utility::Checksum::CRC32::GetData (  ) 

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.
Type Constraints
size data data CS::Utility::Checksum::CRC32::GetSize (  )  [inline]

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.

Definition at line 142 of file checksum.h.

data data CS::Utility::Checksum::CRC32::GetSize (  )  [inline]

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.

Definition at line 130 of file checksum.h.

CS::Utility::Checksum::CRC32::operator uint32 (  )  const [inline]

Return current checksum. For function-style use.

Definition at line 153 of file checksum.h.


Member Data Documentation

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.

Definition at line 130 of file checksum.h.

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.

Definition at line 140 of file checksum.h.

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.

Definition at line 140 of file checksum.h.

Continue computing CRC-32 checksum for given data buffer.

Remarks:
It's recommended to use the Append() method to compute the checksum over multiple chunks of data.

Definition at line 140 of file checksum.h.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1