library_manager.h

Go to the documentation of this file.

// Copyright (C) 2013-2023 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef LIBRARY_MANAGER_H
#define LIBRARY_MANAGER_H
 
#include <exceptions/exceptions.h>
#include <hooks/server_hooks.h>
#include <boost/shared_ptr.hpp>
 
#include <string>
 
namespace isc {
namespace hooks {
 
class NoCalloutManager : public Exception {
public:
    NoCalloutManager(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};
 
class CalloutManager;
class LibraryHandle;
class LibraryManager;
 
 
class LibraryManager {
public:
    LibraryManager(const std::string& name, int index,
                   const boost::shared_ptr<CalloutManager>& manager);
 
    ~LibraryManager();
 
    static bool validateLibrary(const std::string& name,
                                bool multi_threading_enabled = false);
 
    bool loadLibrary(bool multi_threading_enabled = false);
 
    bool prepareUnloadLibrary();
 
    std::string getName() const {
        return (library_name_);
    }
 
protected:
    // The following methods are protected as they are accessed in testing.
 
    bool unloadLibrary();
 
    bool openLibrary();
 
    bool closeLibrary();
 
    bool checkVersion() const;
 
    bool checkMultiThreadingCompatible(bool multi_threading_enabled) const;
 
    void registerStandardCallouts();
 
    bool runLoad();
 
private:
    LibraryManager(const std::string& name);
 
    // Member variables
 
    void*       dl_handle_;     
    int         index_;         
    boost::shared_ptr<CalloutManager> manager_;
    std::string library_name_;  
 
    ServerHooksPtr server_hooks_; 
 
};
 
} // namespace hooks
} // namespace isc
 
#endif  // LIBRARY_MANAGER_H