option_space.h

Go to the documentation of this file.

// Copyright (C) 2012-2020 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 OPTION_SPACE_H
#define OPTION_SPACE_H

#include <dhcp/std_option_defs.h>
#include <exceptions/exceptions.h>

#include <boost/shared_ptr.hpp>
#include <map>
#include <stdint.h>
#include <string>

namespace isc {
namespace dhcp {

class InvalidOptionSpace : public Exception {
public:
    InvalidOptionSpace(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};

class OptionSpace;
typedef boost::shared_ptr<OptionSpace> OptionSpacePtr;
typedef std::map<std::string, OptionSpacePtr> OptionSpaceCollection;

class OptionSpace {
public:

    OptionSpace(const std::string& name, const bool vendor_space = false);

    const std::string& getName() const { return (name_); }

    void clearVendorSpace() {
        vendor_space_ = false;
    }

    bool isVendorSpace() const { return (vendor_space_); }

    void setVendorSpace() {
        vendor_space_ = true;
    }

    static bool validateName(const std::string& name);

private:
    std::string name_;  

    bool vendor_space_; 

};

class OptionSpace6 : public OptionSpace {
public:

    OptionSpace6(const std::string& name);

    OptionSpace6(const std::string& name, const uint32_t enterprise_number);

    uint32_t getEnterpriseNumber() const { return (enterprise_number_); }

    void setVendorSpace(const uint32_t enterprise_number);

private:

    uint32_t enterprise_number_; 
};

}  // namespace dhcp
}  // namespace isc

#endif // OPTION_SPACE_H