XrdOucCacheCM.hh

Go to the documentation of this file.

#ifndef __XRDPUCCACHECM_HH__
#define __XRDPUCCACHECM_HH__
/******************************************************************************/
/*                                                                            */
/*                      X r d O u c C a c h e C M . h h                       */
/*                                                                            */
/* (c) 2018 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.       */
/******************************************************************************/
 
/* The class defined here is used to implement a cache context management
   plugin. It is loaded as run time can interact with the cache, as needed.
   The pss.ccmlib directive is used to load the plugin. However, it is only
   loaded if a cache has been enabled for use.
 
   Your plug-in must exist in a shared library and have the following extern C
   function defined:
*/
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class XrdOucEnv;
class XrdPosixCache;
class XrdSysLogger;
 
typedef bool (*XrdOucCacheCMInit_t)(XrdPosixCache &Cache,
                                    XrdSysLogger  *Logger,
                                    const char    *Config,
                                    const char    *Parms,
                                    XrdOucEnv     *envP);
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#endif