xrootd
|
#include <XrdCksWrapper.hh>
Public Member Functions | |
virtual int | Calc (const char *Xfn, XrdCksData &Cks, int doSet=1) |
virtual int | Calc (const char *Xfn, XrdCksData &Cks, XrdCksPCB *pcbP, int doSet=1) |
virtual int | Del (const char *Xfn, XrdCksData &Cks) |
virtual int | Get (const char *Xfn, XrdCksData &Cks) |
virtual int | Config (const char *Token, char *Line) |
virtual int | Init (const char *ConfigFN, const char *DfltCalc=0) |
virtual char * | List (const char *Xfn, char *Buff, int Blen, char Sep=' ') |
virtual const char * | Name (int seqNum=0) |
virtual XrdCksCalc * | Object (const char *name) |
virtual int | Size (const char *Name=0) |
virtual int | Set (const char *Xfn, XrdCksData &Cks, int myTime=0) |
virtual int | Ver (const char *Xfn, XrdCksData &Cks) |
virtual int | Ver (const char *Xfn, XrdCksData &Cks, XrdCksPCB *pcbP) |
XrdCksWrapper (XrdCks &prevPI, XrdSysError *errP) | |
virtual | ~XrdCksWrapper () |
Destructor. | |
Public Member Functions inherited from XrdCks | |
XrdCks (XrdSysError *erP) | |
Constructor. | |
virtual | ~XrdCks () |
Destructor. | |
Protected Attributes | |
XrdCks & | cksPI |
Protected Attributes inherited from XrdCks | |
XrdSysError * | eDest |
This class defines the wrapper for the checksum management interface. It should be used as the base class for a stacked plugin. When used that way, the shared library holding the plugin must define a "C" entry point named XrdCksAdd2() as described at the end of this include file. Note you pass a reference to the previous plugin-in in the plug-in chain as a constructor argument as supplied to the XrdCksAdd2() function. Override the methods you wish to wrap. Methods that are not overridden are forwarded to the previous plug-in.
|
inline |
Constructor
prevPI | Reference to the antecedent plugin. |
errP | Pointer to error message object |
|
inlinevirtual |
Destructor.
|
inlinevirtual |
Calculate a new checksum for a physical file using the checksum algorithm named in the Cks parameter.
Xfn | The logical or 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 Xfn's extended file attributes. |
pcbP | In the second form, the pointer to the callback object. A nil pointer does not invoke any callback. |
Implements XrdCks.
References XrdCks::Calc(), and cksPI.
Referenced by Calc().
|
inlinevirtual |
|
inlinevirtual |
Parse a configuration directives specific to the checksum manager.
Token | Points to the directive that triggered the call. |
Line | All the characters after the directive. |
Implements XrdCks.
References cksPI, and XrdCks::Config().
|
inlinevirtual |
Delete the checksum from the Xfn's xattrs.
Xfn | The logical or physical name of the file to be checksumed. |
Cks | Specifies the checksum type to delete. |
Implements XrdCks.
References cksPI, and XrdCks::Del().
|
inlinevirtual |
Retreive the checksum from the Xfn'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).
Xfn | The logical or 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. |
Implements XrdCks.
References cksPI, and XrdCks::Get().
|
inlinevirtual |
Fully initialize the manager which includes loading any plugins.
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. |
Implements XrdCks.
References cksPI, and XrdCks::Init().
|
inlinevirtual |
List names of the checksums associated with a Xfn or all supported ones.
Xfn | The logical or physical file name whose checksum names are to be returned. When Xfn 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. |
Implements XrdCks.
References cksPI, and XrdCks::List().
|
inlinevirtual |
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.
seqNum | The sequence number. Zero signifies the default name. Higher numbers are alternates. |
Implements XrdCks.
References cksPI, and XrdCks::Name().
Referenced by Size().
|
inlinevirtual |
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.
name | The name of the checksum algorithm. If null, use the default one. |
Reimplemented from XrdCks.
References cksPI, and XrdCks::Object().
|
inlinevirtual |
Set a file's checksum in the extended attributes along with the file's mtime and the time of setting.
Xfn | The logical or 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. |
Implements XrdCks.
References cksPI, and XrdCks::Set().
|
inlinevirtual |
Get the binary length of the checksum with the corresponding name.
Name | The checksum algorithm name. If null, use the default name. |
Implements XrdCks.
References cksPI, Name(), and XrdCks::Size().
|
inlinevirtual |
Retreive the checksum from the Xfn'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.
Xfn | The logical or physical name of the file to be verified. |
Cks | Specifies the checksum name and value. |
pcbP | In the second form, the pointer to the callback object. A nil pointer does not invoke any callback. |
Implements XrdCks.
References cksPI, and XrdCks::Ver().
Referenced by Ver().
|
inlinevirtual |
|
protected |