XrdSsiProvider.hh

Go to the documentation of this file.

#ifndef __XRDSSIPROVIDER_HH__
#define __XRDSSIPROVIDER_HH__
/******************************************************************************/
/*                                                                            */
/*                     X r d S s i P r o v i d e r . 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 <cerrno>
 
#include "XrdSsi/XrdSsiErrInfo.hh"
#include "XrdSsi/XrdSsiResource.hh"
 
class XrdSsiCluster;
class XrdSsiLogger;
class XrdSsiService;
 
class XrdSsiProvider
{
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum CTL_Cmd {CTL_None = 0};
 
virtual int    Control(CTL_Cmd cmd, const void *argP, void *&resP)
                      {(void)cmd; (void)argP; (void)resP;
                       return (cmd == CTL_None ? 0 : -ENOTSUP);
                      }
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual
XrdSsiService *GetService(XrdSsiErrInfo     &eInfo,
                          const std::string &contact,
                          int                oHold=256
                         ) {eInfo.Set("Service not implemented!", ENOTSUP);
                            return 0;
                           }
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static const int SsiVersion = 0x00010000;
 
       int     GetVersion() {return SsiVersion;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual bool   Init(XrdSsiLogger  *logP,
                    XrdSsiCluster *clsP,
                    std::string    cfgFn,
                    std::string    parms,
                    int            argc,
                    char         **argv
                   ) = 0;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum    rStat  {notPresent = 0, isPresent, isPending};
 
virtual rStat  QueryResource(const char *rName,
                             const char *contact=0
                            ) = 0;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void   ResourceAdded(const char *rName) {}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void   ResourceRemoved(const char *rName) {}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void   SetCBThreads(int cbNum, int ntNum=0) {(void)cbNum; (void)ntNum;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual bool SetConfig(XrdSsiErrInfo &eInfo,
                       std::string   &optname,
                       int            optvalue)
                      {(void)optname; (void)optvalue; return 0;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void   SetSpread(short ssz) {(void)ssz;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum    tmoType {connect_N=0, 
                 connect_T,   
                 idleClose,   
                 request_T,   
                 response_T,  
                 stream_T     
                };
 
virtual void   SetTimeout(tmoType what, int tmoval) {(void)what; (void)tmoval;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
               XrdSsiProvider() {}
protected:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual       ~XrdSsiProvider() {}
};
#endif