00001 #ifndef __XRDOFSPREPARE_H__ 00002 #define __XRDOFSPREPARE_H__ 00003 /******************************************************************************/ 00004 /* */ 00005 /* X r d O f s P r e p a r e . h h */ 00006 /* */ 00007 /* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University */ 00008 /* All Rights Reserved */ 00009 /* Produced by Andrew Hanushevsky for Stanford University under contract */ 00010 /* DE-AC02-76-SFO0515 with the Department of Energy */ 00011 /* */ 00012 /* This file is part of the XRootD software suite. */ 00013 /* */ 00014 /* XRootD is free software: you can redistribute it and/or modify it under */ 00015 /* the terms of the GNU Lesser General Public License as published by the */ 00016 /* Free Software Foundation, either version 3 of the License, or (at your */ 00017 /* option) any later version. */ 00018 /* */ 00019 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */ 00020 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */ 00021 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */ 00022 /* License for more details. */ 00023 /* */ 00024 /* You should have received a copy of the GNU Lesser General Public License */ 00025 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */ 00026 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */ 00027 /* */ 00028 /* The copyright holder's institutional names and contributor's names may not */ 00029 /* be used to endorse or promote products derived from this software without */ 00030 /* specific prior written permission of the institution or contributor. */ 00031 /******************************************************************************/ 00032 00033 #include <string> 00034 #include <vector> 00035 00038 00039 class XrdOss; 00040 class XrdOucEnv; 00041 class XrdOucErrInfo; 00042 class XrdSecEntity; 00043 class XrdSfsFileSystem; 00044 class XrdSfsPrep; 00045 00046 class XrdOfsPrepare 00047 { 00048 public: 00049 00050 //------------------------------------------------------------------------------ 00064 //----------------------------------------------------------------------------- 00065 00066 virtual int begin( XrdSfsPrep &pargs, 00067 XrdOucErrInfo &eInfo, 00068 const XrdSecEntity *client = 0) = 0; 00069 00070 //------------------------------------------------------------------------------ 00081 //----------------------------------------------------------------------------- 00082 00083 virtual int cancel( XrdSfsPrep &pargs, 00084 XrdOucErrInfo &eInfo, 00085 const XrdSecEntity *client = 0) = 0; 00086 00087 //------------------------------------------------------------------------------ 00097 //----------------------------------------------------------------------------- 00098 00099 virtual int query( XrdSfsPrep &pargs, 00100 XrdOucErrInfo &eInfo, 00101 const XrdSecEntity *client = 0) = 0; 00102 00103 //------------------------------------------------------------------------------ 00105 //------------------------------------------------------------------------------ 00106 00107 XrdOfsPrepare() {} 00108 00109 //------------------------------------------------------------------------------ 00111 //------------------------------------------------------------------------------ 00112 00113 virtual ~XrdOfsPrepare() {} 00114 }; 00115 00116 /******************************************************************************/ 00117 /* X r d O f s g e t P r e p a r e */ 00118 /******************************************************************************/ 00119 00120 //------------------------------------------------------------------------------ 00139 //------------------------------------------------------------------------------ 00140 00141 class XrdSysError; 00142 00143 typedef XrdOfsPrepare *(*XrdOfsgetPrepare_t)(XrdSysError *eDest, 00144 const char *confg, 00145 const char *parms, 00146 XrdSfsFileSystem 00147 *theSfs, 00148 XrdOss *theOss, 00149 XrdOucEnv *envP 00150 ); 00151 00152 #define XrdOfsgetPrepareArguments XrdSysError *eDest,\ 00153 const char *confg,\ 00154 const char *parms,\ 00155 XrdSfsFileSystem\ 00156 *theSfs,\ 00157 XrdOss *theOss,\ 00158 XrdOucEnv *envP 00159 /* 00160 extern "C" XrdOfsPrepare_t *XrdOfsgetPrepare; 00161 */ 00162 00163 /******************************************************************************/ 00164 /* X r d O f s A d d P r e p a r e */ 00165 /******************************************************************************/ 00166 00167 //------------------------------------------------------------------------------ 00188 //------------------------------------------------------------------------------ 00189 00190 typedef XrdOfsPrepare *(*XrdOfsAddPrepare_t)(XrdSysError *eDest, 00191 const char *confg, 00192 const char *parms, 00193 XrdSfsFileSystem 00194 *theSfs, 00195 XrdOss *theOss, 00196 XrdOucEnv *envP, 00197 XrdOfsPrepare *prepP 00198 ); 00199 00200 #define XrdOfsAddPrepareArguments XrdSysError *eDest,\ 00201 const char *confg,\ 00202 const char *parms,\ 00203 XrdSfsFileSystem\ 00204 *theSfs,\ 00205 XrdOss *theOss,\ 00206 XrdOucEnv *envP,\ 00207 XrdOfsPrepare *prepP 00208 /* 00209 extern "C" XrdOfsPrepare_t *XrdOfsAddPrepare; 00210 */ 00211 00212 //------------------------------------------------------------------------------ 00218 //------------------------------------------------------------------------------ 00219 00225 #endif