XrdOfsPrepare.hh

Go to the documentation of this file.

#ifndef __XRDOFSPREPARE_H__
#define __XRDOFSPREPARE_H__
/******************************************************************************/
/*                                                                            */
/*                      X r d O f s P r e p a r e . h h                       */
/*                                                                            */
/* (c) 2019 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 <string>
#include <vector>
 
 
class XrdOss;
class XrdOucEnv;
class XrdOucErrInfo;
class XrdSecEntity;
class XrdSfsFileSystem;
class XrdSfsPrep;
  
class XrdOfsPrepare
{
public:
 
//------------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual int            begin(      XrdSfsPrep      &pargs,
                                   XrdOucErrInfo   &eInfo,
                             const XrdSecEntity    *client = 0) = 0;
 
//------------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual int            cancel(      XrdSfsPrep      &pargs,
                                    XrdOucErrInfo   &eInfo,
                              const XrdSecEntity    *client = 0) = 0;
 
//------------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual int            query(      XrdSfsPrep      &pargs,
                                   XrdOucErrInfo   &eInfo,
                             const XrdSecEntity    *client = 0) = 0;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
             XrdOfsPrepare() {}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual     ~XrdOfsPrepare() {}
};
 
/******************************************************************************/
/*                      X r d O f s g e t P r e p a r e                       */
/******************************************************************************/
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class XrdSysError;
 
typedef XrdOfsPrepare *(*XrdOfsgetPrepare_t)(XrdSysError *eDest,
                                             const char  *confg,
                                             const char  *parms,
                                             XrdSfsFileSystem
                                                         *theSfs,
                                             XrdOss      *theOss,
                                             XrdOucEnv   *envP
                                            );
 
#define XrdOfsgetPrepareArguments            XrdSysError *eDest,\
                                             const char  *confg,\
                                             const char  *parms,\
                                             XrdSfsFileSystem\
                                                         *theSfs,\
                                             XrdOss      *theOss,\
                                             XrdOucEnv   *envP
/*
extern "C" XrdOfsPrepare_t *XrdOfsgetPrepare;
*/
 
/******************************************************************************/
/*                      X r d O f s A d d P r e p a r e                       */
/******************************************************************************/
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
typedef XrdOfsPrepare *(*XrdOfsAddPrepare_t)(XrdSysError *eDest,
                                             const char  *confg,
                                             const char  *parms,
                                             XrdSfsFileSystem
                                                         *theSfs,
                                             XrdOss      *theOss,
                                             XrdOucEnv   *envP,
                                          XrdOfsPrepare  *prepP
                                            );
 
#define XrdOfsAddPrepareArguments            XrdSysError *eDest,\
                                             const char  *confg,\
                                             const char  *parms,\
                                             XrdSfsFileSystem\
                                                         *theSfs,\
                                             XrdOss      *theOss,\
                                             XrdOucEnv   *envP,\
                                          XrdOfsPrepare  *prepP
/*
extern "C" XrdOfsPrepare_t *XrdOfsAddPrepare;
*/
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#endif