d2_client_cfg.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 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 D2_CLIENT_CFG_H
#define D2_CLIENT_CFG_H

 
#include <asiolink/io_address.h>
#include <cc/cfg_to_element.h>
#include <cc/user_context.h>
#include <dhcp_ddns/ncr_io.h>
#include <dhcpsrv/cfg_globals.h>
#include <exceptions/exceptions.h>
#include <util/optional.h>
 
#include <cstdint>
#include <string>
 
#include <boost/shared_ptr.hpp>
 
namespace isc {
namespace dhcp {

class D2ClientError : public isc::Exception {
public:

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

typedef std::function<ConstCfgGlobalsPtr()> FetchNetworkGlobalsFn;
 

class D2ClientConfig : public data::UserContext, public isc::data::CfgToElement {
public:
    static const char* DFT_SERVER_IP;
    static const size_t DFT_SERVER_PORT;
    static const char* DFT_V4_SENDER_IP;
    static const char* DFT_V6_SENDER_IP;
    static const size_t DFT_SENDER_PORT;
    static const size_t DFT_MAX_QUEUE_SIZE;
    static const char* DFT_NCR_PROTOCOL;
    static const char* DFT_NCR_FORMAT;
    static const bool DFT_OVERRIDE_NO_UPDATE;
    static const bool DFT_OVERRIDE_CLIENT_UPDATE;
    static const char* DFT_REPLACE_CLIENT_NAME_MODE;
    static const char* DFT_GENERATED_PREFIX;
    static const char* DFT_HOSTNAME_CHAR_SET;
    static const char* DFT_HOSTNAME_CHAR_REPLACEMENT;

    enum ReplaceClientNameMode : uint16_t {
        RCM_NEVER,
        RCM_ALWAYS,
        RCM_WHEN_PRESENT,
        RCM_WHEN_NOT_PRESENT
    };

    D2ClientConfig(const bool enable_updates,
                   const isc::asiolink::IOAddress& server_ip,
                   const size_t server_port,
                   const isc::asiolink::IOAddress& sender_ip,
                   const size_t sender_port,
                   const size_t max_queue_size,
                   const dhcp_ddns::NameChangeProtocol& ncr_protocol,
                   const dhcp_ddns::NameChangeFormat& ncr_format);

    D2ClientConfig();

    virtual ~D2ClientConfig();

    bool getEnableUpdates() const {
        return(enable_updates_);
    }

    const isc::asiolink::IOAddress& getServerIp() const {
        return(server_ip_);
    }

    size_t getServerPort() const {
        return(server_port_);
    }

    const isc::asiolink::IOAddress& getSenderIp() const {
        return(sender_ip_);
    }

    size_t getSenderPort() const {
        return(sender_port_);
    }

    size_t getMaxQueueSize() const {
        return(max_queue_size_);
    }

    const dhcp_ddns::NameChangeProtocol& getNcrProtocol() const {
         return(ncr_protocol_);
    }

    const dhcp_ddns::NameChangeFormat& getNcrFormat() const {
        return(ncr_format_);
    }

    bool operator == (const D2ClientConfig& other) const;

    bool operator != (const D2ClientConfig& other) const;

    std::string toText() const;

    void enableUpdates(bool enable);

    static ReplaceClientNameMode stringToReplaceClientNameMode(const std::string& mode_str);

    static std::string replaceClientNameModeToString(const ReplaceClientNameMode& mode);

    virtual isc::data::ElementPtr toElement() const;

    virtual void validateContents();
 
private:
    bool enable_updates_;

    isc::asiolink::IOAddress server_ip_;

    size_t server_port_;

    isc::asiolink::IOAddress sender_ip_;

    size_t sender_port_;

    size_t max_queue_size_;

    dhcp_ddns::NameChangeProtocol ncr_protocol_;

    dhcp_ddns::NameChangeFormat ncr_format_;
};
 
std::ostream&
operator<<(std::ostream& os, const D2ClientConfig& config);

typedef boost::shared_ptr<D2ClientConfig> D2ClientConfigPtr;
 
} // namespace isc
} // namespace dhcp
 
#endif