XrdCks.hh

Go to the documentation of this file.

#ifndef __XRDCKS_HH__
#define __XRDCKS_HH__
/******************************************************************************/
/*                                                                            */
/*                             X r d C k s . h h                              */
/*                                                                            */
/* (c) 2011 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/

#include "XrdCks/XrdCksData.hh"

class XrdCks;
class XrdCksCalc;
class XrdOucStream;
class XrdSysError;
class XrdSysPlugin;

class XrdCks
{
public:

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
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
XrdCksCalc *Object(const char *name)
{
  (void)name;
  return 0;
}

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
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) : eDest(erP) {}

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
virtual   ~XrdCks() {}

protected:

XrdSysError   *eDest;
};

/******************************************************************************/
/*                            X r d C k s I n i t                             */
/******************************************************************************/

#define XRDCKSINITPARMS XrdSysError *, const char *, const char *
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

#endif