XrdCksCalc Class Reference

#include <XrdCksCalc.hh>

Inheritance diagram for XrdCksCalc:

Collaboration diagram for XrdCksCalc:

Public Member Functions
	XrdCksCalc ()
	Constructor.
virtual	~XrdCksCalc ()
	Destructor.
virtual char *	Calc (const char *Buff, int BLen)
virtual bool	Combinable ()
virtual const char *	Combine (const char *Cksum, int DLen)
virtual const char *	Combine (const char *Cksum1, const char *Cksum2, int DLen)
virtual char *	Current ()
virtual char *	Final ()=0
virtual void	Init ()=0
virtual XrdCksCalc *	New ()=0
virtual void	Recycle ()
	Recycle the checksum object as it is no longer needed. A default is given.
virtual const char *	Type (int &csSize)=0
virtual void	Update (const char *Buff, int BLen)=0

Detailed Description

This class defines the interface to a checksum computation. When this class is used to define a plugin computation, the initial XrdCksCalc computation object is created by the XrdCksCalcInit() function defined at the end of this file.

Definition at line 39 of file XrdCksCalc.hh.

Constructor & Destructor Documentation

XrdCksCalc()

XrdCksCalc::XrdCksCalc ( )

inline

Constructor.

Definition at line 173 of file XrdCksCalc.hh.

{}

Referenced by New(), XrdCksCalcadler32::New(), XrdCksCalccrc32::New(), XrdCksCalccrc32C::New(), XrdCksCalcmd5::New(), and XrdCksCalczcrc32::New().

Here is the caller graph for this function:

~XrdCksCalc()

virtual XrdCksCalc::~XrdCksCalc ( )

inlinevirtual

Destructor.

Definition at line 179 of file XrdCksCalc.hh.

{}

Member Function Documentation

Calc()

virtual char * XrdCksCalc::Calc ( const char * Buff, int BLen )

inlinevirtual

Calculate a one-time checksum. The obvious default implementation is provided and assumes that Init() may be called more than once.

Parameters

Buff	-> Data to be checksummed.
BLen	-> Length of the data in Buff.

Returns

the checksum value in binary format. The pointer to the value becomes invalid once the associated object is deleted.

Definition at line 54 of file XrdCksCalc.hh.

                  {Init(); Update(Buff, BLen); return Final();}

References Final(), Init(), and Update().

Here is the call graph for this function:

Combinable()

virtual bool XrdCksCalc::Combinable ( )

inlinevirtual

Indicate whether or not checksums are combinable for this checksum.

Returns

True if checksums are combinable, false otherwise.

Note

The default is false as combinable checksums are possible for only a few checksum algorithms (e.g. adler and crc). Even then, combining checksums is an optimization not a neccisity.

Definition at line 67 of file XrdCksCalc.hh.

{return false;}

Combine() [1/2]

virtual const char * XrdCksCalc::Combine ( const char * Cksum, int DLen )

inlinevirtual

Combine current checksum with a checksum computed for an adjacent block.

Parameters

Cksum	-> Pointer to the binary checksum of the same algorithm.
DLen	-> Length of the data used to compute the checksum.

Returns

Pointer to the new checksum after combining. This checksum becomes the current checksum. If a nil pointer is returned, this algorithm does not support checksum combining.

Note

Warning! The supplied checkums must have been computed for an adjacent block of data for the current checksum otherwise the combined checksum will be invalid.

Definition at line 85 of file XrdCksCalc.hh.

{return 0;};

Combine() [2/2]

virtual const char * XrdCksCalc::Combine ( const char * Cksum1, const char * Cksum2, int DLen )

inlinevirtual

Combine a checksum with a checksum computed for an adjacent block.

Parameters

Cksum1	-> Pointer to a binary checksum.
Cksum2	-> Pointer to a binary checksum of the same type.
DLen	-> Length of the data used to compute the checksum.

Returns

Pointer to the new checksum after combining. The current checksum is not modified. If a nil pointer is returned, this algorithm does not support checksum combining.

Note

Warning! The Cksum2 must have been computed for the adjacent block of data relative to the computation of Cksum1 otherwise the combined checksum will be invalid.

Definition at line 104 of file XrdCksCalc.hh.

                   {return 0;};

Current()

virtual char * XrdCksCalc::Current ( )

inlinevirtual

Get the current binary checksum value (defaults to final). However, the final checksum result is not affected.

Returns

the checksum value in binary format. The pointer to the value becomes invalid once the associated object is deleted.

Reimplemented in XrdCksCalcmd5.

Definition at line 115 of file XrdCksCalc.hh.

{return Final();}

References Final().

Here is the call graph for this function:

Final()

virtual char * XrdCksCalc::Final ( )

pure virtual

Get the actual checksum in binary format.

Returns

the checksum value in binary format. The pointer to the value becomes invalid once the associated object is deleted.

Implemented in XrdCksCalcadler32, XrdCksCalccrc32, XrdCksCalccrc32C, XrdCksCalcmd5, and XrdCksCalczcrc32.

Referenced by Calc(), XrdCksManager::Calc(), XrdCl::CheckSumManager::Calculate(), and Current().

Here is the caller graph for this function:

Init()

virtual void XrdCksCalc::Init ( )

pure virtual

Initializes data structures (must be called by constructor). This is always called to reuse the object for a new checksum.

Implemented in XrdCksCalcadler32, XrdCksCalccrc32, XrdCksCalccrc32C, XrdCksCalcmd5, and XrdCksCalczcrc32.

Referenced by Calc().

Here is the caller graph for this function:

New()

virtual XrdCksCalc * XrdCksCalc::New ( )

pure virtual

Get a new instance of the underlying checksum calculation object.

Returns

the checksum calculation object.

Implemented in XrdCksCalcadler32, XrdCksCalccrc32, XrdCksCalccrc32C, XrdCksCalcmd5, and XrdCksCalczcrc32.

References XrdCksCalc().

Referenced by XrdCksManager::Calc(), XrdCl::CheckSumManager::GetCalculator(), XrdCksLoader::Load(), and XrdCksManager::Object().

Here is the call graph for this function:

Here is the caller graph for this function:

Recycle()

virtual void XrdCksCalc::Recycle ( )

inlinevirtual

Recycle the checksum object as it is no longer needed. A default is given.

Definition at line 145 of file XrdCksCalc.hh.

{delete this;}

Referenced by XrdCksManager::Calc().

Here is the caller graph for this function:

Type()

virtual const char * XrdCksCalc::Type ( int & csSize )

pure virtual

Get the checksum object algorithm name and the number bytes (i.e. size) required for the checksum value.

Parameters

csSize

-> Parameter to hold the size of the checksum value.

Returns

the checksum algorithm's name. The name persists event after the checksum object is deleted.

Implemented in XrdCksCalcadler32, XrdCksCalccrc32, XrdCksCalccrc32C, XrdCksCalcmd5, and XrdCksCalczcrc32.

Referenced by XrdCl::CheckSumManager::Calculate().

Here is the caller graph for this function:

Update()

virtual void XrdCksCalc::Update ( const char * Buff, int BLen )

pure virtual

Compute a running checksum. This method may be called repeatedly for data segments; with Final() returning the full checksum.

Parameters

Buff	-> Data to be checksummed.
BLen	-> Length of the data in Buff.

Implemented in XrdCksCalcadler32, XrdCksCalccrc32, XrdCksCalccrc32C, XrdCksCalcmd5, and XrdCksCalczcrc32.

Referenced by Calc(), XrdCksManager::Calc(), XrdCksManOss::Calc(), and XrdCl::CheckSumManager::Calculate().

Here is the caller graph for this function:

---

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

• XrdCksCalc.hh