XrdSysPlugin.hh

Go to the documentation of this file.

#ifndef __XRDSYSPLUGIN__
#define __XRDSYSPLUGIN__
/******************************************************************************/
/*                                                                            */
/*                       X r d S y s P l u g i n . h h                        */
/*                                                                            */
/* (c) 2005 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   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 <string.h>

struct XrdVersionInfo;

class XrdSysError;

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

class XrdSysPlugin
{
public:

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

void *getPlugin(const char *pname, int optional=0);

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

void *getPlugin(const char *pname, int optional, bool global);

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

void *Persist() {void *lHan = libHandle; libHandle = 0; return lHan;}

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

static
bool  Preload(const char *path,  char *ebuff=0, int eblen=0);

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

static
bool  VerCmp(XrdVersionInfo &vInf1, XrdVersionInfo &vInf2, bool noMsg=false);

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

      XrdSysPlugin(XrdSysError *erp, const char *path)
                  : eDest(erp), libName(0), libPath(path ? strdup(path) : 0),
                    libHandle(0), myInfo(0), eBuff(0), eBLen(0), msgCnt(-1) {}

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

      XrdSysPlugin(XrdSysError *erp, const char *path, const char *lname,
                   XrdVersionInfo *vinf=0, int msgNum=-1)
                  : eDest(erp), libName(lname),
                    libPath(path ? strdup(path) : 0), libHandle(0),
                    myInfo(vinf), eBuff(0), eBLen(0), msgCnt(msgNum) {}

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

      XrdSysPlugin(char *ebuff, int eblen, const char *path, const char *lname,
                   XrdVersionInfo *vinf=0, int msgNum=-1)
                  : eDest(0), libName(lname),
                    libPath(path ? strdup(path) : 0), libHandle(0),
                    myInfo(vinf), eBuff(ebuff), eBLen(eblen), msgCnt(msgNum) {}

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

     ~XrdSysPlugin();

private:
enum            cvResult {cvBad = 0, cvNone, cvMissing, cvClean, cvDirty};

cvResult        badVersion(XrdVersionInfo &urInfo,char mmv,int majv,int minv);
cvResult        chkVersion(XrdVersionInfo &urInfo, const char *pname, void *lh);
static int      DLflags();
static void    *Find(const char *libname);
void            Inform(const char *txt1,   const char *txt2=0, const char *txt3=0,
                       const char *txt4=0, const char *txt5=0, int noHush=0);
cvResult        libMsg(const char *txt1, const char *txt2, const char *mSym=0);
const char     *msgSuffix(const char *Word, char *buff, int bsz);

XrdSysError    *eDest;
const char     *libName;
char           *libPath;
void           *libHandle;
XrdVersionInfo *myInfo;
char           *eBuff;
int             eBLen;
int             msgCnt;

struct PLlist {PLlist  *next;
               char    *libPath;
               void    *libHandle;
              };

static PLlist *plList;
};
#endif