rrttl.h

Go to the documentation of this file.

// Copyright (C) 2010-2024 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 RRTTL_H
#define RRTTL_H
 
#include <dns/exceptions.h>
#include <util/buffer.h>
 
#include <boost/optional.hpp>
 
#include <stdint.h>
 
namespace isc {
namespace dns {
 
// forward declarations
class AbstractMessageRenderer;

class InvalidRRTTL : public DNSTextError {
public:
    InvalidRRTTL(const char* file, size_t line, const char* what) :
        DNSTextError(file, line, what) {}
};

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

class RRTTL {
public:


    explicit RRTTL(uint32_t ttlval) : ttlval_(ttlval) {
    }

    explicit RRTTL(const std::string& ttlstr);

    explicit RRTTL(isc::util::InputBuffer& buff);

    static RRTTL* createFromText(const std::string& ttlstr);




    const std::string toText() const;
    void toWire(AbstractMessageRenderer& renderer) const;
    void toWire(isc::util::OutputBuffer& buff) const;



    uint32_t getValue() const {
        return (ttlval_);
    }




    bool equals(const RRTTL& other) const {
        return (ttlval_ == other.ttlval_);
    }

    bool operator==(const RRTTL& other) const {
        return (ttlval_ == other.ttlval_);
    }

    bool nequals(const RRTTL& other) const {
        return (ttlval_ != other.ttlval_);
    }

    bool operator!=(const RRTTL& other) const {
        return (ttlval_ != other.ttlval_);
    }

    bool leq(const RRTTL& other) const {
        return (ttlval_ <= other.ttlval_);
    }

    bool operator<=(const RRTTL& other) const {
        return (ttlval_ <= other.ttlval_);
    }

    bool geq(const RRTTL& other) const {
        return (ttlval_ >= other.ttlval_);
    }

    bool operator>=(const RRTTL& other) const {
        return (ttlval_ >= other.ttlval_);
    }

    bool lthan(const RRTTL& other) const {
        return (ttlval_ < other.ttlval_);
    }

    bool operator<(const RRTTL& other) const {
        return (ttlval_ < other.ttlval_);
    }

    bool gthan(const RRTTL& other) const {
        return (ttlval_ > other.ttlval_);
    }

    bool operator>(const RRTTL& other) const {
        return (ttlval_ > other.ttlval_);
    }




    static const RRTTL& MAX_TTL() {
        static const RRTTL max_ttl(0x7fffffff);
        return (max_ttl);
    }

 
private:
    uint32_t ttlval_;
};

std::ostream&
operator<<(std::ostream& os, const RRTTL& rrttl);
}
}
#endif  // RRTTL_H