XrdSsiService.hh

Go to the documentation of this file.

#ifndef __XRDSSISERVICE_HH__
#define __XRDSSISERVICE_HH__
/******************************************************************************/
/*                                                                            */
/*                      X r d S s i S e r v i c e . h h                       */
/*                                                                            */
/* (c) 2015 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*   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 <cstdint>
#include <string>
  
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
class XrdSsiErrInfo;
class XrdSsiRequest;
class XrdSsiResource;
 
class XrdSsiService
{
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static const int SsiVersion = 0x00020000;
 
       int     GetVersion() {return SsiVersion;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual bool   Attach(      XrdSsiErrInfo  &eInfo,
                      const std::string    &handle,
                            XrdSsiRequest  &reqRef,
                            XrdSsiResource *resP=0
                     ) {return true;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual bool   Prepare(XrdSsiErrInfo &eInfo, const XrdSsiResource &rDesc);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void   ProcessRequest(XrdSsiRequest  &reqRef,
                              XrdSsiResource &resRef
                             ) = 0;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual bool   Stop(bool immed=false) {return !immed;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
               XrdSsiService() {}
protected:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual       ~XrdSsiService() {}
};
#endif