option4_client_fqdn.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 OPTION4_CLIENT_FQDN_H
#define OPTION4_CLIENT_FQDN_H

#include <dhcp/option.h>
#include <dns/name.h>

#include <string>
#include <utility>

namespace isc {
namespace dhcp {

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

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

class Option4ClientFqdnImpl;

class Option4ClientFqdn : public Option {
public:


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


    static const uint8_t FLAG_MASK = 0xF;

    class Rcode {
    public:
        Rcode(const uint8_t rcode)
            : rcode_(rcode) { }

        uint8_t getCode() const {
            return (rcode_);
        }

    private:
        uint8_t rcode_;
    };


    enum DomainNameType {
        PARTIAL,
        FULL
    };

    static const uint16_t FIXED_FIELDS_LEN = 3;

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

    Option4ClientFqdn(const uint8_t flags, const Rcode& rcode);

    explicit Option4ClientFqdn(OptionBufferConstIter first,
                               OptionBufferConstIter last);

    Option4ClientFqdn(const Option4ClientFqdn& source);

    virtual OptionPtr clone() const;

    virtual ~Option4ClientFqdn();

    Option4ClientFqdn& operator=(const Option4ClientFqdn& source);

    bool getFlag(const uint8_t flag) const;

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

    void resetFlags();

    std::pair<Rcode, Rcode> getRcode() const;

    void setRcode(const Rcode& rcode);

    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) const;

    virtual void unpack(OptionBufferConstIter first,
                        OptionBufferConstIter last);

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

    virtual uint16_t len() const;


    inline static const Rcode& RCODE_SERVER() {
        static Rcode rcode(255);
        return (rcode);
    }

    inline static const Rcode& RCODE_CLIENT() {
        static Rcode rcode(0);
        return (rcode);
    }

private:

    Option4ClientFqdnImpl* impl_;
};

typedef boost::shared_ptr<Option4ClientFqdn> Option4ClientFqdnPtr;

} // namespace isc::dhcp
} // namespace isc

#endif // OPTION4_CLIENT_FQDN_H