option6_client_fqdn.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 OPTION6_CLIENT_FQDN_H
#define OPTION6_CLIENT_FQDN_H
 
#include <dhcp/option.h>
#include <dns/name.h>
 
#include <cstdint>
#include <string>
 
namespace isc {
namespace dhcp {

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

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

class Option6ClientFqdnImpl;

class Option6ClientFqdn : public Option {
public:


    static const uint8_t FLAG_S = 0x01; 
    static const uint8_t FLAG_O = 0x02; 
    static const uint8_t FLAG_N = 0x04; 

    static const uint8_t FLAG_MASK = 0x7;

    static const uint16_t FLAG_FIELD_LEN = 1;

    enum DomainNameType : uint16_t {
        PARTIAL,
        FULL
    };

    explicit Option6ClientFqdn(const uint8_t flags,
                               const std::string& domain_name,
                               const DomainNameType domain_name_type = FULL);

    Option6ClientFqdn(const uint8_t flags);

    explicit Option6ClientFqdn(OptionBufferConstIter first,
                               OptionBufferConstIter last);

    Option6ClientFqdn(const Option6ClientFqdn& source);

    virtual OptionPtr clone() const;

    virtual ~Option6ClientFqdn();

    Option6ClientFqdn& operator=(const Option6ClientFqdn& source);

    bool getFlag(const uint8_t flag) const;

    void setFlag(const uint8_t flag, const bool set);

    void resetFlags();

    std::string getDomainName() const;

    void packDomainName(isc::util::OutputBuffer& buf) const;

    void setDomainName(const std::string& domain_name,
                       const DomainNameType domain_name_type);

    void resetDomainName();

    DomainNameType getDomainNameType() const;

    virtual void pack(isc::util::OutputBuffer& buf, bool check = true) const;

    virtual void unpack(OptionBufferConstIter first,
                        OptionBufferConstIter last);

    virtual std::string toText(int indent = 0) const;

    virtual uint16_t len() const;
 
private:

    Option6ClientFqdnImpl* impl_;
};

typedef boost::shared_ptr<Option6ClientFqdn> Option6ClientFqdnPtr;
 
} // namespace isc::dhcp
} // namespace isc
 
#endif // OPTION6_CLIENT_FQDN_H