XrdOucCache2.hh

Go to the documentation of this file.

#ifndef __XRDOUCCACHE2_HH__
#define __XRDOUCCACHE2_HH__
/******************************************************************************/
/*                                                                            */
/*                       X r d O u c C a c h e 2 . h h                        */
/*                                                                            */
/* (c) 2016 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 <errno.h>
 
#include "XrdOuc/XrdOucCache.hh"
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
  
/******************************************************************************/
/*                  C l a s s   X r d O u c C a c h e I O 2                   */
/******************************************************************************/
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class XrdOucCacheIO2 : public virtual XrdOucCacheIO
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual int  Fstat(struct stat &sbuff) {(void)sbuff; return 1;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
virtual
const char  *Location() {return "";}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
using        XrdOucCacheIO::Read;
 
virtual void Read (XrdOucCacheIOCB &iocb, char *buff, long long offs, int rlen)
                  {iocb.Done(Read(buff, offs, rlen));}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
using        XrdOucCacheIO::ReadV;
 
virtual void ReadV(XrdOucCacheIOCB &iocb, const XrdOucIOVec *readV, int rnum)
                  {iocb.Done(ReadV(readV, rnum));}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
using        XrdOucCacheIO::Sync;
 
virtual void Sync(XrdOucCacheIOCB &iocb) {iocb.Done(Sync());}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual void Update(XrdOucCacheIO2 &iocp) {}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
using        XrdOucCacheIO::Write;
 
virtual void Write(XrdOucCacheIOCB &iocb, char *buff, long long offs, int wlen)
                  {iocb.Done(Write(buff, offs, wlen));}
 
//------------------------------------------------------------------------------
 
virtual    ~XrdOucCacheIO2() {}  // Always use Detach() instead of direct delete!
};
 
/******************************************************************************/
/*                    C l a s s   X r d O u c C a c h e 2                     */
/******************************************************************************/
 
class  XrdOucEnv;
struct stat;
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class XrdOucCache2 : public virtual XrdOucCache
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
using XrdOucCache::Attach;
 
virtual
XrdOucCacheIO2 *Attach(XrdOucCacheIO2 *ioP, int opts=0) = 0;
 
virtual
XrdOucCacheIO  *Attach(XrdOucCacheIO  *ioP, int opts=0)
                      {errno = ENOSYS; return ioP;}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
virtual
XrdOucCache   *Create(Parms &Params, XrdOucCacheIO::aprParms *aprP=0)
                     {return this;}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
virtual
void           EnvInfo(XrdOucEnv &theEnv) {(void)theEnv;}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
enum LFP_Reason {ForAccess=0, ForInfo, ForPath};
 
virtual
int            LocalFilePath(const char *url, char *buff=0, int blen=0,
                             LFP_Reason why=ForAccess, bool forall=false)
                             {(void)url; (void)buff; (void)blen; (void)why;
                             if (buff && blen > 0) *buff = 0;
                              return -ENOTSUP;
                             }
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
virtual
int            Prepare(const char *url, int oflags, mode_t mode)
                      {(void)url; (void)oflags; (void)mode; return 0;}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual int  Stat(const char *url, struct stat &sbuff)
                 {(void)url; (void)sbuff; return 1;}
 
               XrdOucCache2() {}
virtual       ~XrdOucCache2() {}
};
 
/******************************************************************************/
/*               C r e a t i n g   C a c h e   P l u g - I n s                */
/******************************************************************************/
  
//------------------------------------------------------------------------------
#endif