BESPlugin.h

Go to the documentation of this file.

// BESPlugin.h

// This file is part of bes, A C++ back-end server implementation framework
// for the OPeNDAP Data Access Protocol.

// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
// and James Gallagher <jgallagher@gso.uri.edu>
//
// This library 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 2.1 of the License, or (at your option) any later version.
//
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact University Corporation for Atmospheric Research at
// 3080 Center Green Drive, Boulder, CO 80301

// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
// Please read the full copyright statement in the file COPYRIGHT_UCAR.
//
// Authors:
//      pwest       Patrick West <pwest@ucar.edu>
//      jgarcia     Jose Garcia <jgarcia@ucar.edu>
//      jimg        James Gallagher <jgallagher@gso.uri.edu>

#ifndef T_BESPlugin_h
#define T_BESPlugin_h

#include <dlfcn.h>
#include <string>
#include <iostream>

#include "BESObj.h"
#include "BESInternalFatalError.h"
#include "BESInternalError.h"
#include "BESDebug.h"

#undef UNPLUG_HANDLERS

using std::string;
using std::cerr;
using std::endl;

class NoSuchLibrary: public BESInternalFatalError {
public:
    NoSuchLibrary(const string &msg, const string &file, int line) :
            BESInternalFatalError(msg, file, line)
    {
    }
};

class NoSuchObject: public BESInternalFatalError {
public:
    NoSuchObject(const string &msg, const string &file, int line) :
            BESInternalFatalError(msg, file, line)
    {
    }
};

template<typename M>
class BESPlugin: public BESObj {
private:
    string d_filename; // Library filename
    void *d_lib; // Open library handle

    BESPlugin();
#if 0
    throw (BESInternalError)
    {
        throw BESInternalError("Unimplemented method", __FILE__, __LINE__);
    }
#endif

    BESPlugin(const BESPlugin &p);
#if 0
    throw (BESInternalError)
    {
        throw BESInternalError("Unimplemented method.", __FILE__, __LINE__);
    }
#endif

    BESPlugin &operator=(const BESPlugin &p);
#if 0
    throw (BESInternalError)
    {
        throw BESInternalError("Unimplemented method.", __FILE__, __LINE__);
    }
#endif
    void *get_lib() throw (NoSuchLibrary)
    {
        if (!d_lib) {
            d_lib = dlopen(d_filename.c_str(), RTLD_NOW | RTLD_GLOBAL);
            BESDEBUG( "bes", "BESPlugin: plug in handler:" << d_filename << ", " << d_lib << endl);
            if (d_lib == NULL) {
                throw NoSuchLibrary(string(dlerror()), __FILE__, __LINE__);
            }
        }

        return d_lib;
    }

public:
    BESPlugin(const string &filename) :
            d_filename(filename), d_lib(0)
    {
    }

    virtual ~BESPlugin()
    {
        BESDEBUG( "bes", "BESPlugin: unplugging handler:" << d_filename << ", " << d_lib << endl);
#ifdef UNPLUG_HANDLERS
        if (d_lib) {
            dlclose(d_lib);
            d_lib = 0; // Added; paranoia. jhrg
        }
#endif
    }

    M* instantiate() throw (NoSuchLibrary, NoSuchObject)
    {
        void *maker = dlsym(get_lib(), "maker");
        if (!maker) {
            throw NoSuchObject(string(dlerror()), __FILE__, __LINE__);
        }

        typedef M *(*maker_func_ptr)();
        maker_func_ptr my_maker = *reinterpret_cast<maker_func_ptr*>(&maker);
        M *my_M = (my_maker)();

        return my_M;
    }

    virtual void dump(ostream &strm) const
    {
        strm << "BESPlugin::dump - (" << (void *) this << ")" << endl;
        strm << "    plugin name: " << d_filename << endl;
        strm << "    library handle: " << (void *) d_lib << endl;
    }
};

#endif // T_BESPlugin_h