XRootD
XrdSsiService.hh
Go to the documentation of this file.
1 #ifndef __XRDSSISERVICE_HH__
2 #define __XRDSSISERVICE_HH__
3 /******************************************************************************/
4 /* */
5 /* X r d S s i S e r v i c e . h h */
6 /* */
7 /* (c) 2015 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* Produced by Andrew Hanushevsky for Stanford University under contract */
9 /* DE-AC02-76-SFO0515 with the Department of Energy */
10 /* */
11 /* This file is part of the XRootD software suite. */
12 /* */
13 /* XRootD is free software: you can redistribute it and/or modify it under */
14 /* the terms of the GNU Lesser General Public License as published by the */
15 /* Free Software Foundation, either version 3 of the License, or (at your */
16 /* option) any later version. */
17 /* */
18 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
19 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
20 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
21 /* License for more details. */
22 /* */
23 /* You should have received a copy of the GNU Lesser General Public License */
24 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
25 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
26 /* */
27 /* The copyright holder's institutional names and contributor's names may not */
28 /* be used to endorse or promote products derived from this software without */
29 /* specific prior written permission of the institution or contributor. */
30 /******************************************************************************/
31 
32 #include <cstdint>
33 #include <string>
34 
35 //-----------------------------------------------------------------------------
48 //-----------------------------------------------------------------------------
49 
50 class XrdSsiErrInfo;
51 class XrdSsiRequest;
52 class XrdSsiResource;
53 
55 {
56 public:
57 
58 //-----------------------------------------------------------------------------
62 //-----------------------------------------------------------------------------
63 
64 static const int SsiVersion = 0x00020000;
65 
66  int GetVersion() {return SsiVersion;}
67 
68 //-----------------------------------------------------------------------------
100 //-----------------------------------------------------------------------------
101 
102 virtual bool Attach( XrdSsiErrInfo &eInfo,
103  const std::string &handle,
104  XrdSsiRequest &reqRef,
105  XrdSsiResource *resP=0
106  ) {return true;}
107 
108 //-----------------------------------------------------------------------------
135 //-----------------------------------------------------------------------------
136 
137 virtual bool Prepare(XrdSsiErrInfo &eInfo, const XrdSsiResource &rDesc);
138 
139 //-----------------------------------------------------------------------------
156 //-----------------------------------------------------------------------------
157 
158 virtual void ProcessRequest(XrdSsiRequest &reqRef,
159  XrdSsiResource &resRef
160  ) = 0;
161 
162 //-----------------------------------------------------------------------------
173 //-----------------------------------------------------------------------------
174 
175 virtual bool Stop(bool immed=false) {return !immed;}
176 
177 //-----------------------------------------------------------------------------
179 //-----------------------------------------------------------------------------
180 
182 protected:
183 
184 //-----------------------------------------------------------------------------
186 //-----------------------------------------------------------------------------
187 
188 virtual ~XrdSsiService() {}
189 };
190 #endif
virtual ~XrdSsiService()
Destructor. The service object cannot be explicitly deleted. Use Stop().
virtual bool Attach(XrdSsiErrInfo &eInfo, const std::string &handle, XrdSsiRequest &reqRef, XrdSsiResource *resP=0)
Attach to a backgrounded request.
virtual void ProcessRequest(XrdSsiRequest &reqRef, XrdSsiResource &resRef)=0
Process a request; client-side or server-side.
virtual bool Stop(bool immed=false)
Stop the client-side service. This is never called server-side.
XrdSsiService()
Constructor.
static const int SsiVersion
virtual bool Prepare(XrdSsiErrInfo &eInfo, const XrdSsiResource &rDesc)
Prepare for processing subsequent resource request.