rcode.h

Go to the documentation of this file.

/*
 * Copyright (C) 2010-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/.
 */
 
#include <cstdint>
#include <ostream>
 
#ifndef RCODE_H
#define RCODE_H
 
namespace isc {
namespace dns {

class Rcode {
public:
    enum CodeValue : uint16_t {
        NOERROR_CODE = 0,       
        FORMERR_CODE = 1,       
        SERVFAIL_CODE = 2,      
        NXDOMAIN_CODE = 3,      
        NOTIMP_CODE = 4,        
        REFUSED_CODE = 5,       
        YXDOMAIN_CODE = 6,      
        YXRRSET_CODE = 7,       
        NXRRSET_CODE = 8,       
        NOTAUTH_CODE = 9,       
        NOTZONE_CODE = 10,      
        RESERVED11_CODE = 11,   
        RESERVED12_CODE = 12,   
        RESERVED13_CODE = 13,   
        RESERVED14_CODE = 14,   
        RESERVED15_CODE = 15,   
        BADVERS_CODE = 16       
    };



    explicit Rcode(const uint16_t code);

    Rcode(const uint8_t code, const uint8_t extended_code);

    uint16_t getCode() const {
        return (code_);
    }

    uint8_t getExtendedCode() const;

    bool equals(const Rcode& other) const {
        return (code_ == other.code_);
    }

    bool operator==(const Rcode& other) const {
        return (equals(other));
    }

    bool nequals(const Rcode& other) const {
        return (code_ != other.code_);
    }

    bool operator!=(const Rcode& other) const {
        return (nequals(other));
    }

    std::string toText() const;

    static const Rcode& NOERROR();

    static const Rcode& FORMERR();

    static const Rcode& SERVFAIL();

    static const Rcode& NXDOMAIN();

    static const Rcode& NOTIMP();

    static const Rcode& REFUSED();

    static const Rcode& YXDOMAIN();

    static const Rcode& YXRRSET();

    static const Rcode& NXRRSET();

    static const Rcode& NOTAUTH();

    static const Rcode& NOTZONE();

    static const Rcode& RESERVED11();

    static const Rcode& RESERVED12();

    static const Rcode& RESERVED13();

    static const Rcode& RESERVED14();

    static const Rcode& RESERVED15();

    static const Rcode& BADVERS();
private:
    uint16_t code_;
};
 
inline const Rcode&
Rcode::NOERROR() {
    static Rcode c(0);
    return (c);
}
 
inline const Rcode&
Rcode::FORMERR() {
    static Rcode c(1);
    return (c);
}
 
inline const Rcode&
Rcode::SERVFAIL() {
    static Rcode c(2);
    return (c);
}
 
inline const Rcode&
Rcode::NXDOMAIN() {
    static Rcode c(3);
    return (c);
}
 
inline const Rcode&
Rcode::NOTIMP() {
    static Rcode c(4);
    return (c);
}
 
inline const Rcode&
Rcode::REFUSED() {
    static Rcode c(5);
    return (c);
}
 
inline const Rcode&
Rcode::YXDOMAIN() {
    static Rcode c(6);
    return (c);
}
 
inline const Rcode&
Rcode::YXRRSET() {
    static Rcode c(7);
    return (c);
}
 
inline const Rcode&
Rcode::NXRRSET() {
    static Rcode c(8);
    return (c);
}
 
inline const Rcode&
Rcode::NOTAUTH() {
    static Rcode c(9);
    return (c);
}
 
inline const Rcode&
Rcode::NOTZONE() {
    static Rcode c(10);
    return (c);
}
 
inline const Rcode&
Rcode::RESERVED11() {
    static Rcode c(11);
    return (c);
}
 
inline const Rcode&
Rcode::RESERVED12() {
    static Rcode c(12);
    return (c);
}
 
inline const Rcode&
Rcode::RESERVED13() {
    static Rcode c(13);
    return (c);
}
 
inline const Rcode&
Rcode::RESERVED14() {
    static Rcode c(14);
    return (c);
}
 
inline const Rcode&
Rcode::RESERVED15() {
    static Rcode c(15);
    return (c);
}
 
inline const Rcode&
Rcode::BADVERS() {
    static Rcode c(16);
    return (c);
}

std::ostream& operator<<(std::ostream& os, const Rcode& rcode);
}
}
#endif  // RCODE_H