option_data_parser.h

Go to the documentation of this file.

// Copyright (C) 2017-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 OPTION_DATA_PARSER_H
#define OPTION_DATA_PARSER_H
 
#include <cc/data.h>
#include <cc/simple_parser.h>
#include <dhcp/option_definition.h>
#include <dhcpsrv/cfg_option.h>
#include <dhcpsrv/cfg_option_def.h>
#include <boost/shared_ptr.hpp>
#include <util/optional.h>
#include <cstdint>
#include <string>
#include <utility>
 
namespace isc {
namespace dhcp {
 
class OptionDataParser : public isc::data::SimpleParser {
public:
    OptionDataParser(const uint16_t address_family,
                     CfgOptionDefPtr cfg_option_def = CfgOptionDefPtr());
 
    virtual ~OptionDataParser() {
    }
 
    std::pair<OptionDescriptor, std::string>
    parse(isc::data::ConstElementPtr single_option);
 
protected:
 
    virtual OptionDefinitionPtr
    findOptionDefinition(const std::string& option_space,
                         const util::Optional<uint32_t>& option_code,
                         const util::Optional<std::string>& option_name) const;
 
    std::pair<OptionDescriptor, std::string>
    createOption(isc::data::ConstElementPtr option_data);
 
    util::Optional<uint32_t>
    extractCode(data::ConstElementPtr parent) const;
 
    util::Optional<std::string>
    extractName(data::ConstElementPtr parent) const;
 
    util::Optional<bool> extractCSVFormat(data::ConstElementPtr parent) const;
 
    util::Optional<std::string>
    extractData(data::ConstElementPtr parent) const;
 
    std::string extractSpace(data::ConstElementPtr parent) const;
 
    util::Optional<bool> extractPersistent(data::ConstElementPtr parent) const;
 
    util::Optional<bool> extractCancelled(data::ConstElementPtr parent) const;
 
    uint16_t address_family_;
 
    CfgOptionDefPtr cfg_option_def_;
};
 
class OptionDataListParser : public isc::data::SimpleParser {
public:
    OptionDataListParser(const uint16_t address_family,
                         CfgOptionDefPtr cfg_option_def = CfgOptionDefPtr());
 
    virtual ~OptionDataListParser() {
    }
 
    void parse(const CfgOptionPtr& cfg,
               isc::data::ConstElementPtr option_data_list,
               bool encapsulate = true);
protected:
 
    virtual boost::shared_ptr<OptionDataParser> createOptionDataParser() const;
 
    uint16_t address_family_;
 
    CfgOptionDefPtr cfg_option_def_;
};
 
 
} // end of namespace isc::dhcp
} // end of namespace isc
 
#endif // OPTION_DATA_PARSER_H