server_hooks.h

Go to the documentation of this file.

// Copyright (C) 2013-2018 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 SERVER_HOOKS_H
#define SERVER_HOOKS_H
 
#include <exceptions/exceptions.h>
#include <hooks/parking_lots.h>
 
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
 
#include <map>
#include <string>
#include <vector>
 
namespace isc {
namespace hooks {
 
class DuplicateHook : public Exception {
public:
    DuplicateHook(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};
 
class NoSuchHook : public Exception {
public:
    NoSuchHook(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};
 
class ServerHooks;
typedef boost::shared_ptr<ServerHooks> ServerHooksPtr;
 
 
class ServerHooks : public boost::noncopyable {
public:
 
    static const int CONTEXT_CREATE = 0;
    static const int CONTEXT_DESTROY = 1;
 
    void reset();
 
    int registerHook(const std::string& name);
 
    std::string getName(int index) const;
 
    int getIndex(const std::string& name) const;
 
    int findIndex(const std::string& name) const;
 
    int getCount() const {
        return (hooks_.size());
    }
 
    std::vector<std::string> getHookNames() const;
 
    static ServerHooks& getServerHooks();
 
    static ServerHooksPtr getServerHooksPtr();
 
    ParkingLotsPtr getParkingLotsPtr() const;
 
    ParkingLotPtr getParkingLotPtr(const int hook_index);
 
    ParkingLotPtr getParkingLotPtr(const std::string& hook_name);
 
    static std::string commandToHookName(const std::string& command_name);
 
    static std::string hookToCommandName(const std::string& hook_name);
 
private:
    ServerHooks();
 
    void initialize();
 
    typedef std::map<std::string, int> HookCollection;
    typedef std::map<int, std::string> InverseHookCollection;
 
    HookCollection  hooks_;                 
    InverseHookCollection inverse_hooks_;   
 
    ParkingLotsPtr parking_lots_;
};
 
} // namespace util
} // namespace isc
 
#endif  // SERVER_HOOKS_H