xrootd
XrdOfsPrepare.hh
Go to the documentation of this file.
1 #ifndef __XRDOFSPREPARE_H__
2 #define __XRDOFSPREPARE_H__
3 /******************************************************************************/
4 /* */
5 /* X r d O f s P r e p a r e . h h */
6 /* */
7 /* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
33 #include <string>
34 #include <vector>
35 
38 
39 class XrdOfs;
40 class XrdOss;
41 class XrdOucEnv;
42 class XrdOucErrInfo;
43 class XrdSecEntity;
44 class XrdSfsPrep;
45 
47 {
48 public:
49 
50 //------------------------------------------------------------------------------
64 //-----------------------------------------------------------------------------
65 
66 virtual int begin( XrdSfsPrep &pargs,
67  XrdOucErrInfo &eInfo,
68  const XrdSecEntity *client = 0) = 0;
69 
70 //------------------------------------------------------------------------------
81 //-----------------------------------------------------------------------------
82 
83 virtual int cancel( XrdSfsPrep &pargs,
84  XrdOucErrInfo &eInfo,
85  const XrdSecEntity *client = 0) = 0;
86 
87 //------------------------------------------------------------------------------
97 //-----------------------------------------------------------------------------
98 
99 virtual int query( XrdSfsPrep &pargs,
100  XrdOucErrInfo &eInfo,
101  const XrdSecEntity *client = 0) = 0;
102 
103 //------------------------------------------------------------------------------
105 //------------------------------------------------------------------------------
106 
108 
109 //------------------------------------------------------------------------------
111 //------------------------------------------------------------------------------
112 
113 virtual ~XrdOfsPrepare() {}
114 };
115 
116 /******************************************************************************/
117 /* X r d O f s g e t P r e p a r e */
118 /******************************************************************************/
119 
120 //------------------------------------------------------------------------------
138 //------------------------------------------------------------------------------
139 
140 class XrdSysError;
141 
142 typedef XrdOfsPrepare *(*XrdOfsgetPrepare_t)(XrdSysError *eDest,
143  const char *confg,
144  const char *parms,
145  XrdOfs *theOfs,
146  XrdOss *theOss,
147  XrdOucEnv *envP
148  );
149 
150 #define XrdOfsgetPrepareArguments XrdSysError *eDest,\
151  const char *confg,\
152  const char *parms,\
153  XrdOfs *theOfs,\
154  XrdOss *theOss,\
155  XrdOucEnv *envP
156 /*
157 extern "C" XrdOfsPrepare_t *XrdOfsgetPrepare;
158 */
159 
160 //------------------------------------------------------------------------------
166 //------------------------------------------------------------------------------
167 
173 #endif
XrdOss
Definition: XrdOss.hh:174
XrdOfsPrepare::cancel
virtual int cancel(XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
XrdOfsPrepare::query
virtual int query(XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
XrdOfsPrepare::XrdOfsPrepare
XrdOfsPrepare()
Constructor.
Definition: XrdOfsPrepare.hh:107
XrdOfsPrepare::~XrdOfsPrepare
virtual ~XrdOfsPrepare()
Destructor.
Definition: XrdOfsPrepare.hh:113
XrdOucEnv
Definition: XrdOucEnv.hh:42
XrdOfsPrepare::begin
virtual int begin(XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
XrdSfsPrep
< Prepare parameters
Definition: XrdSfsInterface.hh:161
XrdSecEntity
Definition: XrdSecEntity.hh:52
XrdOucErrInfo
Definition: XrdOucErrInfo.hh:100
XrdOfs
Definition: XrdOfs.hh:186
XrdSysError
Definition: XrdSysError.hh:90
XrdOfsPrepare
Definition: XrdOfsPrepare.hh:47