XrdCks Class Reference

#include <XrdCks.hh>

Inheritance diagram for XrdCks:
Inheritance graph
[legend]
Collaboration diagram for XrdCks:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual int Calc (const char *Pfn, XrdCksData &Cks, int doSet=1)=0
virtual int Del (const char *Pfn, XrdCksData &Cks)=0
virtual int Get (const char *Pfn, XrdCksData &Cks)=0
virtual int Config (const char *Token, char *Line)=0
virtual int Init (const char *ConfigFN, const char *DfltCalc=0)=0
virtual char * List (const char *Pfn, char *Buff, int Blen, char Sep=' ')=0
virtual const char * Name (int seqNum=0)=0
virtual XrdCksCalcObject (const char *name)
virtual int Size (const char *Name=0)=0
virtual int Set (const char *Pfn, XrdCksData &Cks, int myTime=0)=0
virtual int Ver (const char *Pfn, XrdCksData &Cks)=0
 XrdCks (XrdSysError *erP)
 Constructor.
virtual ~XrdCks ()
 Destructor.

Protected Attributes

XrdSysErroreDest

Detailed Description

This class defines the checksum management interface. It should be used as the base class for a plugin. When used that way, the shared library holding the plugin must define a "C" entry point named XrdCksInit() as described at the end of this include file. Note that you can also base you plugin on the native implementation, XrdCks, and replace only selected methods.


Constructor & Destructor Documentation

XrdCks::XrdCks ( XrdSysError erP  )  [inline]

Constructor.

virtual XrdCks::~XrdCks (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual int XrdCks::Calc ( const char *  Pfn,
XrdCksData Cks,
int  doSet = 1 
) [pure virtual]

Calculate a new checksum for a physical file using the checksum algorithm named in the Cks parameter.

Parameters:
Pfn The physical name of the file to be checksumed.
Cks For input, it specifies the checksum algorithm to be used. For output, the checksum value is returned upon success.
doSet When true, the new value must replace any existing value in the Pfn's extended file attributes.
Returns:
Success: zero with Cks structure holding the checksum value. Failure: -errno (see significant error numbers below).

Implemented in XrdCksManager.

virtual int XrdCks::Config ( const char *  Token,
char *  Line 
) [pure virtual]

Parse a configuration directives specific to the checksum manager.

Parameters:
Token Points to the directive that triggered the call.
Line All the characters after the directive.
Returns:
Success: 1 Failure: 0

Implemented in XrdCksManager.

virtual int XrdCks::Del ( const char *  Pfn,
XrdCksData Cks 
) [pure virtual]

Delete the checksum from the Pfn's xattrs.

Returns:
Success: 0 Failure: -errno (see significant error numbers below).

Implemented in XrdCksManager.

virtual int XrdCks::Get ( const char *  Pfn,
XrdCksData Cks 
) [pure virtual]

Retreive the checksum from the Pfn's xattrs and return it and indicate whether or not it is stale (i.e. the file modification has changed or the name and length are not the expected values).

Parameters:
Pfn The physical name of the file to be checksumed.
Cks For input, it specifies the checksum type to return. For output, the checksum value is returned upon success.
Returns:
Success: The length of the binary checksum in the Cks structure. Failure: -errno (see significant error numbers below).

Implemented in XrdCksManager.

virtual int XrdCks::Init ( const char *  ConfigFN,
const char *  DfltCalc = 0 
) [pure virtual]

Fully initialize the manager which includes loading any plugins.

Parameters:
ConfigFN Points to the configuration file path.
DfltCalc Is the default checksum and should be defaulted if NULL. The default implementation defaults this to adler32. A default is only needed should the checksum name in the XrdCksData object be omitted.
Returns:
Success: 1 Failure: 0

Implemented in XrdCksManager.

virtual char* XrdCks::List ( const char *  Pfn,
char *  Buff,
int  Blen,
char  Sep = ' ' 
) [pure virtual]

List names of the checksums associated with a Pfn or all supported ones.

Parameters:
Pfn The name of the physical file whose checksum names are to be returned. When Pfn is null, return all supported checksum algorithm names.
Buff Points to a buffer, at least 64 bytes in length, to hold a "Sep" separated list of checksum names.
Blen The length of the buffer.
Sep The separation character to be used between adjacent names.
Returns:
Success: Pointer to Buff holding at least one checksum name. Failure: A nil pointer is returned.

Implemented in XrdCksManager.

virtual const char* XrdCks::Name ( int  seqNum = 0  )  [pure virtual]

Get the name of the checksums associated with a sequence number. Note that Name() may be called prior to final config to see if there are any chksums to configure and avoid unintended errors.

Parameters:
seqNum The sequence number. Zero signifies the default name. Higher numbers are alternates.
Returns:
Success: Pointer to the name. Failure: A nil pointer is returned (no more alternates exist).

Implemented in XrdCksManager.

virtual XrdCksCalc* XrdCks::Object ( const char *  name  )  [inline, virtual]

Get a new XrdCksCalc object that can calculate the checksum corresponding to the specified name or the default object if name is a null pointer. The object can be used to compute checksums on the fly. The object's Recycle() method must be used to delete it.

Parameters:
name The name of the checksum algorithm. If null, use the default one.
Returns:
Success: A pointer to the object is returned. Failure: Zero if no corresponding object exists.

Reimplemented in XrdCksManager.

virtual int XrdCks::Set ( const char *  Pfn,
XrdCksData Cks,
int  myTime = 0 
) [pure virtual]

Set a file's checksum in the extended attributes along with the file's mtime and the time of setting.

Parameters:
Pfn The physical name of the file to be set.
Cks Specifies the checksum name and value.
myTime When true then the fmTime and gmTime in the Cks structure are to be used; as opposed to the current time.
Returns:
Success: zero is returned. Failure: -errno (see significant error numbers below).

Implemented in XrdCksManager.

virtual int XrdCks::Size ( const char *  Name = 0  )  [pure virtual]

Get the binary length of the checksum with the corresponding name.

Parameters:
Name The checksum algorithm name. If null, use the default name.
Returns:
Success: checksum length. Failure: Zero if the checksum name does not exist.

Implemented in XrdCksManager.

virtual int XrdCks::Ver ( const char *  Pfn,
XrdCksData Cks 
) [pure virtual]

Retreive the checksum from the Pfn's xattrs and compare it to the supplied checksum. If the checksum is not available or is stale, a new checksum is calculated and written to the extended attributes.

Parameters:
Pfn The physical name of the file to be verified.
Cks Specifies the checksum name and value.
Returns:
Success: True Failure: False (the checksums do not match) or -errno indicating that verification could not be performed (see significant error numbers below).

Implemented in XrdCksManager.


Member Data Documentation

XrdSysError* XrdCks::eDest [protected]

Significant errno values:

-EDOM The supplied checksum length is invalid for the checksum name. -ENOTSUP The supplied or default checksum name is not supported. -ESRCH Checksum does not exist for file. -ESTALE The file's checksum is no longer valid.


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

Generated on 11 Nov 2016 for xrootd by  doxygen 1.6.1